Skip to content

Commit 119273c

Browse files
authored
Merge pull request #842 from IABTechLab/gwh-APIDOCS-2972-home-page-breakout
Restructure of home page Approved by KK via Slack.
2 parents 8da386f + 91dfa56 commit 119273c

30 files changed

+313
-127
lines changed

docs/getting-started/gs-credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Link from '@docusaurus/Link';
99

1010
# UID2 Credentials
1111

12-
Each UID2 <a href="../intro#participants">participant</a> needs at least one set of unique credentials. The set of credentials you need is determined by how you are participating in UID2, as shown in the following table.
12+
Each UID2 <a href="../overviews/participants-overview#uid2-external-participants">participant</a> needs at least one set of unique credentials. The set of credentials you need is determined by how you are participating in UID2, as shown in the following table.
1313

1414
| Audience | Credentials | Integration |
1515
| :--- | :--- | :--- |

docs/getting-started/gs-opt-out.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Link from '@docusaurus/Link';
99

1010
# User Opt-Out
1111

12-
Many different publishers and advertisers use UID2. Different publishers might have different opt-out processes for their individual sites; however, UID2 as a whole has very specific opt-out processes that all UID2 [participants](../ref-info/glossary-uid.md#gl-participant) are expected to honor.
12+
Many different publishers and advertisers use UID2. Different publishers might have different opt-out processes for their individual sites; however, UID2 as a whole has very specific opt-out processes that all UID2 [participants](overviews/participants-overview.md#uid2-external-participants) are expected to honor.
1313

1414
## How Users Can Opt Out of UID2
1515

docs/guides/mobile-plugin-gma-ios.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ To integrate with UID2, you'll need to have a UID2 account. If you haven't yet c
3434
When initial account setup is complete, you'll receive instructions and a link to access the [UID2 Portal](../portal/portal-overview.md), where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
3535

3636
The steps you'll take in the UID2 Portal are different depending on whether your implementation will be client-side, client-server, or server-side. Specific instructions are in each implementation guide. For a summary, see [Client-Side, Client-Server, or Server-Side Integration?](integration-mobile-overview#client-side-client-server-or-server-side-integration)
37+
3738
## Requirements
3839

3940
To run this plugin, install the following:

docs/intro.md

Lines changed: 11 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,29 @@ import Link from '@docusaurus/Link';
1010

1111
# Unified ID 2.0 Overview
1212

13-
UID2 is a framework that enables deterministic identity for advertising opportunities on the open internet for many [participants](#participants) across the advertising ecosystem. The UID2 framework enables publisher websites, mobile apps, and Connected TV (CTV) apps to monetize through programmatic workflows. Built as an open-source, standalone solution with its own unique namespace, the framework offers privacy controls designed to help participants meet local market requirements.
13+
UID2 is a framework that enables deterministic identity for advertising opportunities on the open internet for many [participants](overviews/participants-overview.md#uid2-external-participants) across the advertising ecosystem. The UID2 framework enables publisher websites, mobile apps, and Connected TV (CTV) apps to monetize through programmatic workflows. Built as an open-source, standalone solution with its own unique namespace, the framework offers privacy controls designed to help participants meet local market requirements.
1414

1515
:::note
1616
The term "UID2" can refer to either the framework or an actual identifier. Unless otherwise indicated, this page provides an overview of the UID2 framework.
1717
:::
1818

19-
### Guiding Principles
19+
## Guiding Principles
2020

2121
The UID2 framework has the following principles as its foundation:
2222

2323
- **First-party relationships**: UID2 enables advertisers to activate their first-party data on publisher websites across the open internet.
2424

25-
- **Non-proprietary (universal) standard**: All [participants](#participants) in the advertising ecosystem who execute an appropriate participation agreement can access UID2.
25+
- **Non-proprietary (universal) standard**: All [participants](overviews/participants-overview.md#uid2-external-participants) in the advertising ecosystem who execute an appropriate participation agreement can access UID2.
2626

27-
- **Open source**: The source code for the UID2 [components](#components) is publicly available.
27+
- **Open source**: The source code for the [UID2 Component Services](overviews/participants-overview.md#uid2-component-services) is publicly available.
2828

2929
- **Interoperable**: The framework allows other identity solutions (commercial and proprietary) to integrate and provide UID2 tokens with their offerings.
3030

3131
- **Secure and encrypted data**: UID2 leverages multiple layers of security to help protect user and other participant data.
3232

3333
- **Consumer control**: Consumers can opt out of UID2 at any time through the [Transparency and Control Portal](https://www.transparentadvertising.com/).
3434

35-
### Technical Design Principles
35+
## Technical Design Principles
3636

3737
The UID2 framework is built on the following technical principles:
3838

@@ -42,73 +42,18 @@ The UID2 framework is built on the following technical principles:
4242

4343
- **Lean infrastructure**: The UID2 system is light and inexpensive to operate.
4444

45-
- **Internet scale**: The UID2 infrastructure can scale to address the continuously increasing needs of [participants](#participants) and to meet the performance demands of specific geographic regions.
45+
- **Internet scale**: The UID2 infrastructure can scale to address the continuously increasing needs of [participants](overviews/participants-overview.md#uid2-external-participants) and to meet the performance demands of specific geographic regions.
4646

4747
- **Self-reliant**: UID2 does not rely on external services for the processing of real-time bidding (RTB) data.
4848

4949
## Elements of the UID2 Infrastructure
5050

51-
The following sections explain and illustrate the key elements of the UID2 framework infrastructure:
51+
For information about key elements of the UID2 infrastructure, and other aspects of UID2, refer to the following pages:
5252

53-
- [UID2 Identifier Types](#uid2-identifier-types)
54-
- [Components](#components)
55-
- [Participants](#participants)
56-
- [Workflows](#workflows)
57-
58-
### UID2 Identifier Types
59-
60-
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.
61-
62-
| ID Type | Shared in Bidstream? | Description |
63-
| :--- | :--- | :--- |
64-
| **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=`. |
65-
| **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`. |
66-
67-
:::note
68-
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`.
69-
:::
70-
71-
### Components
72-
73-
The UID2 framework consists of the following components, all of which are currently managed by The Trade Desk.
74-
75-
| Component | Description |
76-
| :--- | :--- |
77-
| **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. |
78-
| **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](#participants), 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. |
79-
| **Opt-Out Service** | A global service that manages and stores user opt-out requests and disseminates them to publishers, operator service instances, and DSPs. |
80-
| **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. |
81-
82-
### Participants
83-
84-
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.
85-
86-
The following table lists the key participants and their roles in the UID2 [workflows](#workflows).
87-
88-
| Participant | Role Description |
89-
| :--- | :--- |
90-
| **Core Administrator** | An organization (currently, The Trade Desk) that manages the UID2 Core Service and other [components](#components). For example, it distributes encryption keys and salts to UID2 operators and sends user opt-out requests to operators and DSPs. |
91-
| **Operators** | Organizations that run the <Link href="ref-info/glossary-uid#gl-operator-service">Operator Service</Link> (via the UID2 APIs). Operators periodically receive and store up-to-date encryption keys and salts from the UID2 Core Service, salt and hash <Link href="ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> to return raw UID2s, encrypt raw UID2s to generate UID2 tokens, and distribute UID2 token decryption keys.<br/>Public Operators (Open Operators) run public instances of the Operator Service. For example, The Trade Desk currently serves as a Public Operator for the UID2 framework, available to all participants. If other Public Operators are available, a participant can choose which operator to work with.<br/>Any participant can also choose to become a Private Operator to generate and manage UID2s. |
92-
| **DSPs** | DSPs integrate with the UID2 system to receive UID2s from advertisers (as first-party data) and third-party data providers (as third-party data) and leverage them to inform bidding on UID2s in the bidstream. |
93-
| **Data Providers** | Organizations that collect user data and push it to other UID2 participants&#8212;for example, advertisers, identity graph providers, and third-party data providers. |
94-
| **Advertisers** | Organizations that buy impressions across a range of publisher sites and use DSPs to decide which ad impressions to purchase and how much to bid on them. |
95-
| **Publishers** | Organizations that propagate UID2 tokens to the bidstream via SSPs—for example, identity providers, publishers, and SSO providers. Publishers can choose to work with an SSO provider or an independent ID provider that is interoperable with UID2. Independent ID providers can handle the UID2 integration on behalf of publishers. |
96-
| **Consumers** | Users who have had a UID2 token or raw UID2 created from their email address or phone number. Consumers can opt out of UID2 in the [Transparency and Control Portal](https://www.transparentadvertising.com/). |
97-
98-
### Workflows
99-
100-
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.
101-
102-
| Workflow | Intended Primary Participants | Integration Guides |
103-
| :--- |:--- |:--- |
104-
| [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) |
105-
| [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) |
106-
| [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) |
107-
| [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 |
108-
109-
The following diagram summarizes all four workflows. For each workflow, the [participants](#participants), [components](#components), [UID2 identifier types](#uid2-identifier-types), and numbered steps are color-coded.
110-
111-
![The UID2 Ecosystem](images/UID2Workflows.svg)
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)
11257

11358
## FAQs
11459

docs/overviews/overview-advertisers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ To get started, follow these steps:
5858
1. Request access to UID2 by filling out the form on the [Request Access](/request-access) page.
5959

6060
Someone will contact you to discuss your needs and advise on appropriate next steps.
61-
1. Decide on your [participant](../intro.md#participants) role or roles.
61+
1. Decide on your [participant](../overviews/participants-overview.md#uid2-external-participants) role or roles.
6262
1. Decide which implementation option you want to use.
6363
1. Receive your credentials (see [UID2 Credentials](../getting-started/gs-credentials.md)) and follow the instructions in the implementation guide for the option you chose.
6464

docs/overviews/overview-data-providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ To get started, follow these steps:
6363
1. Request access to UID2 by filling out the form on the [Request Access](/request-access) page.
6464

6565
Someone will contact you to discuss your needs and advise on appropriate next steps.
66-
1. Decide on your [participant](../intro.md#participants) role or roles.
66+
1. Decide on your [participant](../overviews/participants-overview.md#uid2-external-participants) role or roles.
6767
1. Decide which implementation option you want to use.
6868
1. Receive your credentials (see [UID2 Credentials](../getting-started/gs-credentials.md)) and follow the instructions in the implementation guide for the option you chose.
6969

0 commit comments

Comments
 (0)