Skip to content

Commit

Permalink
updates for summary page defaults in sidebar
Browse files Browse the repository at this point in the history
  • Loading branch information
genwhittTTD committed Jan 12, 2024
1 parent 53f2065 commit 51910d1
Show file tree
Hide file tree
Showing 26 changed files with 55 additions and 61 deletions.
2 changes: 1 addition & 1 deletion docs/endpoints/summary-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ hide_table_of_contents: false
sidebar_position: 01
---

# UID2 Endpoints
# UID2 Endpoints: Summary

All UID2 endpoints require a client secret for encrypting API requests (except [POST /token/refresh](post-token-refresh.md) requests) and decrypting responses. For details and Python script examples, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/gs-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,11 +206,11 @@ Here are some frequently asked questions for demand-side platforms (DSPs).

#### How do I know which decryption key to apply to a UID2?

Each of the server-side SDKs (see [SDKs](../sdks/summary-sdks.md)) updates decryption keys automatically. Metadata supplied with the UID2 token discloses the IDs of the decryption keys to use.
Each of the server-side SDKs (see [SDKs: Summary](../sdks/summary-sdks.md)) updates decryption keys automatically. Metadata supplied with the UID2 token discloses the IDs of the decryption keys to use.

#### Where do I get the decryption keys?

You can use one of the server-side SDKs (see [SDKs](../sdks/summary-sdks.md)) to communicate with the UID2 service and fetch the latest keys. To make sure that the keys remain up-to-date, it is recommended to fetch them periodically; for example, once every hour.
You can use one of the server-side SDKs (see [SDKs: Summary](../sdks/summary-sdks.md)) to communicate with the UID2 service and fetch the latest keys. To make sure that the keys remain up-to-date, it is recommended to fetch them periodically; for example, once every hour.

#### How many decryption keys may be present in memory at any point?

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/gs-sharing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ This page is in support of a feature that is currently in limited release.
For additional information, refer to the following pages:

- For general information about UID2 sharing: [UID2 Sharing: Overview ](../sharing/sharing-overview.md)
- For information about setting up a UID2 Portal account and configuring sharing relationships: [UID2 Portal Overview](../portal/portal-overview.md)
- For information about setting up a UID2 Portal account and configuring sharing relationships: [UID2 Portal: Overview](../portal/portal-overview.md)

For any other information about UID2 sharing, please reach out to [UID2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com).
6 changes: 3 additions & 3 deletions docs/guides/dsp-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide is for DSPs who transact on UID2s in the bid stream.

DSPs receive UID2 tokens in bid requests, and decrypt the UID2 tokens to arrive at raw UID2s that they can use for bidding, using one of the server-side SDKs that support this function.

For a summary of available server-side SDKs, see [SDKs - Summary](../sdks/summary-sdks.md).
For a summary of available server-side SDKs, see [SDKs: Summary](../sdks/summary-sdks.md).

>NOTE: If your back end is written in a language not covered by one of the available server-side SDKs, ask your UID2 contact in case there is additional information available to help you. If you're not sure who to ask, see [Contact Info](../getting-started/gs-account-setup.md#contact-info).
Expand Down Expand Up @@ -51,7 +51,7 @@ https://dsp.example.com/optout?user=%%identity%%&optouttime=%%timestamp%%

Use the logic below during bidding (2-b) to honor a user's opt-out.

Leverage one of the server-side SDKs (see [SDKs](../sdks/summary-sdks.md)) to decrypt incoming UID2 tokens into raw UID2s. The response to the decrypt function contains the raw UID2.
Leverage one of the server-side SDKs (see [SDKs: Summary](../sdks/summary-sdks.md)) to decrypt incoming UID2 tokens into raw UID2s. The response to the decrypt function contains the raw UID2.

The following diagram illustrates opt-out logic.

Expand All @@ -65,7 +65,7 @@ The following table provides details for Step 2 of the workflow diagram shown in

| Step | SDK | Description |
| :--- | :--- | :--- |
| 2-a | Server-side SDK (see [SDKs](../sdks/summary-sdks.md)) | Leverage the provided SDK to decrypt incoming UID2 tokens. The response contains the `UID2` and the UID2 creation time. |
| 2-a | Server-side SDK (see [SDKs: Summary](../sdks/summary-sdks.md)) | Leverage the provided SDK to decrypt incoming UID2 tokens. The response contains the `UID2` and the UID2 creation time. |
| 2-b | | DSPs are required to honor opt-out protocol for UID2s. For details on configuring user opt-outs and honoring them during bidding, see [Honor user opt-outs](#honor-user-opt-outs). |

## FAQs
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/google-ss-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This guide covers integration steps for publishers using UID2 with the Google Ad
* [UID2 SDK for JavaScript Client-Side Integration](#uid2-sdk-for-javascript-client-side-integration)
* [Sample Applications](#sample-applications) -->

>NOTE: To use the UID2 Google Ad Manager secure signals integration, if you are using an SDK you must have your UID2 integration already set up. This does not apply if you are using server-only integration. For a summary of all the integration options available, see [UID2 Integration Guides](summary-guides.md).
>NOTE: To use the UID2 Google Ad Manager secure signals integration, if you are using an SDK you must have your UID2 integration already set up. This does not apply if you are using server-only integration. For a summary of all the integration options available, see [UID2 Integration Guides: Summary](summary-guides.md).
## Overview

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/summary-guides.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: UID2 Integration Guides—Summary
title: UID2 Integration Guides - Summary
sidebar_label: Summary
pagination_label: UID2 Integration Guides - Summary
description: Summary of all the integration guides available.
hide_table_of_contents: false
sidebar_position: 01
---

# UID2 Integration Guides—Summary
# UID2 Integration Guides: Summary

The following guides provide integration instructions based on the needs and requirements of your organization and its primary role as a publisher, DSP, or data provider/advertiser. As a UID2 participant, you may also integrate via Enterprise Partners that enable engaging with an Open Operator service and hosting of a Private Operator service.

Expand Down
4 changes: 2 additions & 2 deletions docs/portal/portal-overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: UID2 Portal Overview
title: UID2 Portal - Overview
description: General information about the UID2 Portal.
hide_table_of_contents: false
sidebar_position: 01
---

# UID2 Portal Overview
# UID2 Portal: Overview

<!-- It includes the following:
Expand Down
2 changes: 1 addition & 1 deletion docs/ref-info/glossary-uid.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ sidebar_position: 10

<dt class="jump-anchor" id="gl-uid2-portal">UID2 Portal</dt>
<dd>The UID2 Portal is a separate user interface that allows UID2 participants to manage their accounts.</dd>
<dd>For details, see <a href="../portal/portal-overview">UID2 Portal Overview</a>.</dd>
<dd>For details, see <a href="../portal/portal-overview">UID2 Portal: Overview</a>.</dd>

<dt class="jump-anchor" id="gl-uid2-service">UID2 service</dt>
<dd>The Unified ID 2.0 (UID2) service is a set of components, API endpoints, and other types of solutions that collectively implement the <a href="#gl-uid2-framework">UID2 framework</a> and provide clients with access to the relevant UID2 functionality.</dd>
Expand Down
4 changes: 2 additions & 2 deletions docs/ref-info/updates-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,15 @@ For details, use the language drop-down at the top of any site page, or go strai

We published several new documentation pages to help users navigating the new UID2 Portal user interface, where you can manage your UID2 account.

For details, see [UID2 Portal](/docs/category/uid2-portal).
For details, see [UID2 Portal: Overview](../portal/portal-overview.md).

### New: Documentation for UID2 Sharing

3 August 2023

We published the following new and updated documents to support use of the new UID2 sharing feature:

- A set of new pages providing information relating to UID2 sharing, including an overview, use cases, implementation instructions, best practices, and more. See [UID2 Sharing](/docs/category/uid2-sharing).
- A set of new pages providing information relating to UID2 sharing, including an overview, use cases, implementation instructions, best practices, and more. See [UID2 Sharing: Overview](../sharing/sharing-overview.md).
- Updates to the four server-side SDKs to support UID2 sharing:

- [UID2 SDK for C# / .NET: Usage for UID2 Sharers](../sdks/uid2-sdk-ref-csharp-dotnet.md#usage-for-uid2-sharers)
Expand Down
4 changes: 2 additions & 2 deletions docs/sdks/summary-sdks.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: SDKs&#8212;Summary
title: SDKs - Summary
sidebar_label: SDKs - Summary
pagination_label: SDKs - Summary
description: Summary of SDK documentation available.
hide_table_of_contents: false
sidebar_position: 01
---

# SDKs&#8212;Summary
# SDKs: Summary

Review the SDK functionality to determine which SDK or SDKs you want to use, then click through in the SDKs table to review the reference documentation.

Expand Down
6 changes: 3 additions & 3 deletions docs/sharing/sharing-bid-stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Publishers share UID2s by encrypting [directly identifying information (DII)](..

Additional resources:
- [UID2 Overview for Publishers](../overviews/overview-publishers.md)
- [UID2 Portal Overview](../portal/portal-overview.md)
- [UID2 Portal: Overview](../portal/portal-overview.md)

## Account Setup in the UID2 Portal

Expand All @@ -27,7 +27,7 @@ The sender only needs to set up sharing permission once for each receiver or par

As a publisher, we recommend that you set up your sharing permissions to share with all DSPs.

For details, see [UID2 Portal Overview](../portal/portal-overview.md) and follow the links for each task.
For details, see [UID2 Portal: Overview](../portal/portal-overview.md) and follow the links for each task.

## UID2 Sharing Workflow: Sharing in the Bid Stream

Expand All @@ -44,7 +44,7 @@ The workflow for generating UID2 tokens from DII, via the API or the specified s

- Java SDK: see [UID2 SDK for Java Reference Guide](../sdks/uid2-sdk-ref-java.md)).
- Python SDK: see [UID2 SDK for Python Reference Guide](../sdks/uid2-sdk-ref-python.md)).
- Direct integration with API endpoints: see [Endpoints](/docs/category/endpoints-v2).
- Direct integration with API endpoints: see [UID2 Endpoints: Summary](../endpoints/summary-endpoints.md).
- Direct integration with API endpoints to generate UID2 tokens using the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) endpoint, but using the UID2 SDK for JavaScript (see [UID2 SDK for JavaScript Reference Guide](../sdks/client-side-identity.md)) to refresh UID2 tokens.

>NOTE: The DSP must integrate with UID2 using one of the server-side SDKs. See [Sharing Steps: Summary](sharing-implementing.md#sharing-steps-summary) (step 2).
Expand Down
2 changes: 1 addition & 1 deletion docs/sharing/sharing-implementing.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ In the UID2 Portal, the sender and the receiver must set up an account, and the

The sender only needs to set up sharing permission once for each receiver or participant type. However, if you want to add new sharing permissions or change existing ones, you'll need to go back to adjust your settings.

For details, see [UID2 Portal Overview](../portal/portal-overview.md) and follow the links for each task.
For details, see [UID2 Portal: Overview](../portal/portal-overview.md) and follow the links for each task.

## Steps to Implement Sharing with an SDK

Expand Down
4 changes: 2 additions & 2 deletions docs/sharing/sharing-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ sidebar_position: 01

In UID2, sharing is a process for distributing [raw UID2s](../ref-info/glossary-uid.md#gl-raw-uid2) securely between UID2 participants. To protect raw UID2s from unauthorized access, the originating participant (sender) must encrypt the raw UID2s into [UID2 tokens](../ref-info/glossary-uid.md#gl-uid2-token) before transmission. The destination participant (receiver) must decrypt the UID2 tokens into raw UID2s for internal use.

The UID2 sender specifies which receivers can decrypt their UID2 tokens, by configuring permissions in the [UID2 Portal](/docs/category/uid2-portal). When a sender grants permission to a receiver for UID2 sharing, the sender's decryption keys are shared with the receiver via a UID2 SDK. As part of sharing, the UID2 SDKs and APIs take care of the encryption and decryption.
The UID2 sender specifies which receivers can decrypt their UID2 tokens, by configuring permissions in the UID2 Portal (see [UID2 Portal: Overview](../portal/portal-overview.md)). When a sender grants permission to a receiver for UID2 sharing, the sender's decryption keys are shared with the receiver via a UID2 SDK. As part of sharing, the UID2 SDKs and APIs take care of the encryption and decryption.

For example, let's say that an advertiser (sender) wants to share raw UID2s with a trusted sharing participant who is a UID2 DSP, for segment creation via an API. Using sharing, the advertiser first enables the DSP with sharing permission via the UID2 Portal. The advertiser then encrypts the raw UID2s into UID2 tokens and sends them securely to the DSP (receiver). The DSP, who is also taking part in sharing, has access to the advertiser's decryption keys (through the UID2 Portal sharing permissions setup), and can therefore decrypt the UID2 tokens into raw UID2s for segment creation.

Expand All @@ -29,7 +29,7 @@ Additional resources:

- [Implementing Sharing](sharing-implementing.md)
- [UID2 Sharing: Best Practices](sharing-best-practices.md)
- [UID2 Portal Overview](../portal/portal-overview.md)
- [UID2 Portal: Overview](../portal/portal-overview.md)

## UID2 Sharing Workflow

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ demand-side platform (DSP) に関するよくある質問を紹介します。

#### UID2 に適用する復号鍵はどのように決定すればよいですか?

各 Server-Side SDK ([SDKs](../sdks/summary-sdks.md)を参照)は、復号鍵を自動的に更新します。UID2 Token と共に提供されるメタデータは、使用する復号鍵の ID を示します。
各 Server-Side SDK ([SDKs: Summary](../sdks/summary-sdks.md)を参照)は、復号鍵を自動的に更新します。UID2 Token と共に提供されるメタデータは、使用する復号鍵の ID を示します。

#### 復号鍵はどこで手に入りますか?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ sidebar_position: 24
以下のページを参照してください:

- UID2 Sharing に関する一般的な情報は、以下のページを参照してください: [UID2 Sharing: Overview ](../sharing/sharing-overview.md)
- UID2 Portal アカウントの設定と共有関係の設定については、以下を参照してください: [UID2 Portal Overview](../portal/portal-overview.md)
- UID2 Portal アカウントの設定と共有関係の設定については、以下を参照してください: [UID2 Portal: Overview](../portal/portal-overview.md)


UID2 Sharing に関するその他の情報については、[UID2partners@thetradedesk.com](mailto:UID2partners@thetradedesk.com) まで連絡してください。

<!-- eng_jp -->
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 05

DSP はビッドリクエストで UID2 Token を受け取り、この機能をサポートする Server-Side SDK のいずれかを使用して UID2 Token を復号化し、入札に使用できる raw UID2 を取得します。

利用可能な Server-Side SDK の概要については、[SDKs - Summary](../sdks/summary-sdks.md) を参照してください。
利用可能な Server-Side SDK の概要については、[SDKs: Summary](../sdks/summary-sdks.md) を参照してください。

>NOTE: バックエンドが、利用可能な Server-Side SDK のいずれでもカバーされていない言語で書かれている場合は、UID2 の担当者に問い合わせてください。誰に聞けばいいかわからない場合は、[連絡先情報](../getting-started/gs-account-setup.md#contact-info) を参照してください。
Expand Down Expand Up @@ -52,7 +52,7 @@ https://dsp.example.com/optout?user=%%identity%%&optouttime=%%timestamp%%

入札時 (2-b)に以下のロジックを使用し、ユーザーのオプトアウトを受け入れます。

Server-Side SDK のいずれか ([SDKs](../sdks/summary-sdks.md)を参照) を利用して、受信した UID2 Token を raw UID2 に復号します。decrypt関数へのレスポンスには、raw UID2 が含まれます。
Server-Side SDK のいずれか ([SDKs: Summary](../sdks/summary-sdks.md)を参照) を利用して、受信した UID2 Token を raw UID2 に復号します。decrypt関数へのレスポンスには、raw UID2 が含まれます。

オプトアウトのロジックを次の図に示します。

Expand All @@ -66,7 +66,7 @@ Server-Side SDK のいずれか ([SDKs](../sdks/summary-sdks.md)を参照) を

| Step | SDK | Description |
| :--- | :--- | :--- |
| 2-a | Server-side SDK ([SDKs](../sdks/summary-sdks.md)を参照) | 提供されている SDK を活用して、入力された UID2 Token を復号化します。レスポンスには `UID2` と UID2 の作成時刻が含まれます。 |
| 2-a | Server-side SDK ([SDKs: Summary](../sdks/summary-sdks.md)を参照) | 提供されている SDK を活用して、入力された UID2 Token を復号化します。レスポンスには `UID2` と UID2 の作成時刻が含まれます。 |
| 2-b | | DSP は UID2 のオプトアウトプロトコルを受け入れることが要求されます。ユーザーオプトアウトの設定と入札時の受け入れは、[ユーザーオプトアウトの受け入れ](#honor-user-opt-outs) を参照してください。 |

## FAQs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ sidebar_position: 10
* [UID2 SDK for JavaScript Client-Side Integration](#uid2-sdk-for-javascript-client-side-integration)
* [Sample Applications](#sample-applications) -->

> NOTE: UID2 Google Ad Manager セキュアシグナルインテグレーションを使用するには、SDK を使用している場合、UID2 インテグレーションがすでに設定されている必要があります。サーバーのみのインテグレーションを使用している場合は、この限りではありません。使用可能なすべてのインテグレーションオプションの概要は、[UID2 Integration Guides](summary-guides.md)を参照してください。
> NOTE: UID2 Google Ad Manager セキュアシグナルインテグレーションを使用するには、SDK を使用している場合、UID2 インテグレーションがすでに設定されている必要があります。サーバーのみのインテグレーションを使用している場合は、この限りではありません。使用可能なすべてのインテグレーションオプションの概要は、[UID2 Integration Guides: Summary](summary-guides.md)を参照してください。
## Overview

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: UID2 Integration Guides&#8212;Summary
title: UID2 Integration Guides - Summary
sidebar_label: Summary
pagination_label: UID2 Integration Guides - Summary
description: 利用可能なすべてのインテグレーションガイドの概要。
hide_table_of_contents: false
sidebar_position: 01
---

# UID2 Integration Guides&#8212;Summary
# UID2 Integration Guides: Summary

以下のガイドでは、各組織のニーズと要件、およびパブリッシャー、DSP、データプロバイダー/広告主としての主な役割に基づいたインテグレーション手順を説明しています。UID2 参加者として、Open Operator Service との連携や Private Operator Service のホスティングを可能にするエンタープライズパートナーを介してインテグレーションすることもできます。

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: UID2 Portal Overview
title: UID2 Portal - Overview
description: UID2 Portal に関する一般情報。
hide_table_of_contents: false
sidebar_position: 01
---

# UID2 Portal Overview
# UID2 Portal: Overview

<!-- It includes the following:
Expand Down
Loading

0 comments on commit 51910d1

Please sign in to comment.