Skip to content

Commit a5badde

Browse files
committed
broke out the infrastructure page
1 parent 470efa7 commit a5badde

File tree

15 files changed

+154
-120
lines changed

15 files changed

+154
-120
lines changed

docs/intro.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,12 @@ The UID2 framework is built on the following technical principles:
4848

4949
## Elements of the UID2 Infrastructure
5050

51-
For details, see [UID2 Infrastructure](ref-info/uid-infrastructure.md).
51+
For information about key elements of the UID2 infrastructure, refer to the following pages:
52+
53+
- [UID2 Identifier Types](ref-info/uid-identifier-types.md)
54+
- [UID2 Components](ref-info/uid-components.md)
55+
- [UID2 Participants](overviews/participants-overview.md)
56+
- [Workflows](ref-info/uid-workflows.md)
5257

5358
## Components
5459

docs/overviews/participants-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import Link from '@docusaurus/Link';
1212

1313
With its transparent and interoperable approach, UID2 provides a collaborative framework for many participants across the advertising ecosystem—advertisers, publishers, DSPs, SSPs, single sign-on (SSO) providers, customer data platforms (CDPs), consent management providers (CMPs), identity providers, third-party data providers, and measurement providers.
1414

15-
The following tables list the key participants and their roles in the UID2 [workflows](../ref-info/uid-infrastructure.md#workflows). They are grouped into three categories:
15+
The following tables list the key participants and their roles in the [UID2 workflows](../ref-info/uid-workflows.md). They are grouped into three categories:
1616

1717
- [UID2 Component Services](#uid2-component-services)
1818
- [UID2 External Participants](#uid2-external-participants)
@@ -22,7 +22,7 @@ The following tables list the key participants and their roles in the UID2 [work
2222

2323
The following table summarizes information about key participant components of the UID2 service.
2424

25-
For a diagram of how the different services work together, see [UID2 Workflows](../ref-info/uid-infrastructure.md#workflows).
25+
For a diagram of how the different services work together, see [UID2 Workflows](../ref-info/uid-workflows.md).
2626

2727
| Participant | Role Description |
2828
| :--- | :--- |

docs/ref-info/ref-how-uid-is-created.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ When a publisher sends a user's <Link href="../ref-info/glossary-uid#gl-dii">DII
1818
Some preliminary steps are taken by the publisher, but most of the processing steps are done by the UID2 Operator.
1919

2020
It's very important that the publisher steps are performed in the correct sequence:
21-
- When steps are performed in sequence, the resulting value can be recognized as related to other [UID2 identifiers](uid-infrastructure.md#uid2-identifier-types) generated from online activity by the same individual: the underlying [raw UID2](../ref-info/glossary-uid.md#gl-raw-uid2) matches the raw UID2s generated by other UID2 participants from the same DII, and therefore the token is suitable for targeted advertising.
21+
- When steps are performed in sequence, the resulting value can be recognized as related to other [UID2 identifier types](uid-identifier-types.md) generated from online activity by the same individual: the underlying [raw UID2](../ref-info/glossary-uid.md#gl-raw-uid2) matches the raw UID2s generated by other UID2 participants from the same DII, and therefore the token is suitable for targeted advertising.
2222
- If steps are taken out of sequence, the resulting value cannot be related to other UID2 identifiers generated from online activity by the same individual, and therefore the token is not suitable for targeted advertising.
2323

2424
For a summary, see [Steps to Create a UID2 Token](#steps-to-create-a-uid2-token). For an example in diagram form, see [Creating a UID2 Token&#8212;Example](#creating-a-uid2-tokenexample).

docs/ref-info/uid-components.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: UID2 Components
3+
description: Summary of key components of the UID2 technical infrastructure.
4+
hide_table_of_contents: false
5+
sidebar_position: 01
6+
displayed_sidebar: docs
7+
---
8+
9+
import Link from '@docusaurus/Link';
10+
11+
# UID2 Components
12+
13+
The UID2 framework consists of the following components, all of which are currently managed by The Trade Desk.
14+
15+
| Component | Description |
16+
| :--- | :--- |
17+
| **Core Service** | A centralized service that manages access to <a href="../ref-info/glossary-uid#gl-salt">salts</a>, <a href="../ref-info/glossary-uid#gl-encryption-key">encryption keys</a>, and other relevant data in the UID2 ecosystem. |
18+
| **Operator Service** | A service that enables the management and storage of encryption keys and salts from the UID2 Core Service, hashing of users' personal data, encryption of raw UID2s, and decryption of UID2 tokens. There can be multiple instances of the service (public or private) operated by multiple [participants](../overviews/participants-overview.md#uid2-component-services), known as operators.<br/><Link href="../ref-info/glossary-uid#gl-public-operator">Public Operators</Link> run publicly available instances of the <Link href="../ref-info/glossary-uid#gl-operator-service">Operator Service</Link> and make them available to all relevant UID2 participants. There might also be <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operators</Link> that run private instances of the Operator Service exclusively for their own use. All instances are designed with protections to keep critical UID2 data secure and interoperable, regardless of who operates the service. |
19+
| **Opt-Out Service** | A global service that manages and stores user opt-out requests and disseminates them to publishers, operator service instances, and DSPs. |
20+
| **Transparency and Control Portal** | A user-facing website, [https://www.transparentadvertising.com/](https://www.transparentadvertising.com/), that allows consumers to opt out of UID2 at any time. |
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: UID2 Identifier Types
3+
description: Summary of xxx.
4+
hide_table_of_contents: false
5+
sidebar_position: 01
6+
displayed_sidebar: docs
7+
---
8+
9+
import Link from '@docusaurus/Link';
10+
11+
# UID2 Identifier Types
12+
13+
UID2 is a deterministic ID that is based on <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link>, such as email address or phone number. There are two types of UID2s: raw UID2s and UID2 tokens (also known as advertising tokens). The following table explains each type.
14+
15+
| ID Type | Shared in Bidstream? | Description |
16+
| :--- | :--- | :--- |
17+
| **Raw UID2** | No | An unencrypted alphanumeric identifier created through the UID2 APIs or SDKs with the user's verifiable personal data, such as a hashed or unhashed email address or a phone number, as input.<br/>To avoid revealing the source data, the input value is hashed if it was not already hashed, and then hashed again using a secret <Link href="../ref-info/glossary-uid#gl-salt">salt</Link> value to create the raw UID2. The process that creates the raw UID2 is designed to create a secure, opaque value that can be stored by advertisers, third-party data providers, and demand-side platforms (DSPs).<br/>Raw UID2s are case sensitive.<br/>Example: A request for the raw UID2 for the fictitious email address `[email protected]` resulted in this value: `E2dxEv3oMBzNHPw5iUVmwH2Hv+60D4AXYe+2ge9U0No=`. |
18+
| **UID2 Token (Advertising Token)** | Yes | An encrypted form of a raw UID2. UID2 tokens are generated from hashed or unhashed email addresses or phone numbers that are converted to raw UID2s and then encrypted to help ensure protection in the <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link>.<br/>UID2 tokens are designed to be used by publishers or publisher service providers. Supply-side platforms (SSPs) pass UID2 tokens in the bidstream and DSPs decrypt them at bid request time.<br/>UID2 tokens are case sensitive.<br/>Example: A request for a UID2 token for the fictitious email address `[email protected]` resulted in this value: `A4AAAAs6ZBcEbwAPoFhVV7CNW5W-4R-9TKDNL4RS0ctkw1U-IkNOXSnWczvwOMgCQaXHPf3Gd1o1W6IBmlZBFIloM67XOsOgwP5jUrQrclGkq1zBJJUJmOFTe6sJJA7pM1GP9gLd-hz5did6baZvcKd8DXkUYM-WALRZFnzHivu_1YEsC_CeXNdMexKDN7EwSQ6L5eZvOd1F1RkF_nLy_J0twg`. |
19+
20+
:::note
21+
For the fictitious email address `[email protected]` used in these examples, the corresponding refresh token was: `AAAABrexFHvQVhNJqu+y/ua7rsgShF8e9NUXUJOZFmeFRD8TAsJadaLfOlLkwC5iSxcOKWFD9YwMBzbbcPa92CInba+bcPTaAFNmM2ZpIHgGy6lDcNPzvEnPQh/5fyZ3MD44SX/tHyIXa0R2OBAOLBA1A81r3jefhSsxZdyyBF58KtnaX6UbaeOEaguOfMnJdmhaPeWKj33v7vGfROWtxDWmi6wvGL5lHTX9H6iIZ9i1WSsemYPUgmoDOQeT7nzllJK968OECFj5LkCazDN3pCrYSeuJby9o0fMuSZNxzp6EVzi6XVED4ETtzpcaY0AArzzdh0IXV9MgH8jyg7bJSUWXQG+8kMPZzwbs9EB+7ddAUOLZL/GBna8Hm3Im03EjN3sJ`.
22+
:::

docs/ref-info/uid-infrastructure.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

docs/ref-info/uid-workflows.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: UID2 Workflows
3+
description: A detailed summary of UID2 workflows.
4+
hide_table_of_contents: false
5+
sidebar_position: 01
6+
displayed_sidebar: docs
7+
---
8+
9+
import Link from '@docusaurus/Link';
10+
11+
# UID2 Workflows
12+
13+
The following table lists four key workflows in the UID2 framework with links to their high-level overviews. It also provides links to the respective integration guides, which include diagrams, integration steps, FAQs, and other relevant information for each workflow.
14+
15+
| Workflow | Intended Primary Participants | Integration Guides |
16+
| :--- |:--- |:--- |
17+
| [Workflow for DSPs](../overviews/overview-dsps.md#workflow-for-dsps) (Buy-Side) | DSPs who transact on UID2 tokens in the bidstream. | See [DSP Integrations](../guides/summary-guides#dsp-integrations) |
18+
| [Workflow for Advertisers](../overviews/overview-advertisers.md#workflow-for-advertisers) and [Workflow for Data Providers](../overviews/overview-data-providers.md#workflow-for-data-providers) | Organizations that collect user data and push it to DSPs. | See [Advertiser/Data Provider Integrations](../guides/summary-guides#advertiserdata-provider-integrations) |
19+
| [Workflow for Publishers](../overviews/overview-publishers.md#workflow-for-publishers) | Organizations that propagate UID2 tokens to the bidstream via SSPs.<br/> NOTE: Publishers can choose to integrate using Prebid, leverage the SDK for JavaScript, or complete their own server-side integration without using an SDK. | See [Publisher Integrations](../guides/summary-guides#publisher-integrations) |
20+
| [Opt-Out Workflow](../getting-started/gs-opt-out.md#opt-out-workflow) | Consumers who engage with publishers or their SSO providers and other identity providers. | N/A |
21+
22+
The following diagram summarizes all four workflows. For each workflow, the [external participants](../overviews/participants-overview.md#uid2-external-participants), [components](../ref-info/uid-components.md), [UID2 identifier types](../ref-info/uid-identifier-types.md), and numbered steps are color-coded.
23+
24+
![The UID2 Ecosystem](images/UID2Workflows.svg)

i18n/ja/docusaurus-plugin-content-docs/current/intro.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,13 @@ UID2 フレームワークは、以下の技術原則に基づいて構築され
4646

4747
- **Self-reliant**: UID2 は、リアルタイムビディング (RTB) データの処理において外部サービスに依存しません。
4848

49+
## Elements of the UID2 Infrastructure
50+
51+
- [UID2 Identifier Types](ref-info/uid-identifier-types.md)
52+
- [UID2 Components](ref-info/uid-components.md)
53+
- [UID2 Participants](overviews/participants-overview.md)
54+
- [Workflows](ref-info/uid-workflows.md)
55+
4956
<!-- ## Elements of the UID2 Infrastructure
5057
5158
以下のセクションでは、UID2 フレームワークのインフラストラクチャの主要な要素について説明し、図解します:

i18n/ja/docusaurus-plugin-content-docs/current/overviews/participants-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import Link from '@docusaurus/Link';
1212

1313
With its transparent and interoperable approach, UID2 provides a collaborative framework for many participants across the advertising ecosystem—advertisers, publishers, DSPs, SSPs, single sign-on (SSO) providers, customer data platforms (CDPs), consent management providers (CMPs), identity providers, third-party data providers, and measurement providers.
1414

15-
The following tables list the key participants and their roles in the UID2 [workflows](../ref-info/uid-infrastructure.md#workflows). They are grouped into three categories:
15+
The following tables list the key participants and their roles in the [UID2 workflows](../ref-info/uid-workflows.md). They are grouped into three categories:
1616

1717
- [UID2 Component Services](#uid2-component-services)
1818
- [UID2 External Participants](#uid2-external-participants)
@@ -22,7 +22,7 @@ The following tables list the key participants and their roles in the UID2 [work
2222

2323
The following table summarizes information about key participant components of the UID2 service.
2424

25-
For a diagram of how the different services work together, see [UID2 Workflows](../ref-info/uid-infrastructure.md#workflows).
25+
For a diagram of how the different services work together, see [UID2 Workflows](../ref-info/uid-workflows.md).
2626

2727
| Participant | Role Description |
2828
| :--- | :--- |

0 commit comments

Comments
 (0)