Skip to content

Commit

Permalink
Merge pull request #354 from IABTechLab/gwh-APIDOCS-1376-move-workflo…
Browse files Browse the repository at this point in the history
…ws-to-overviews

Gwh apidocs 1376 move workflows to overviews
  • Loading branch information
genwhittTTD authored Nov 8, 2023
2 parents 362dc1d + ae82dfc commit 4f9fca2
Show file tree
Hide file tree
Showing 39 changed files with 526 additions and 229 deletions.
File renamed without changes
10 changes: 5 additions & 5 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,14 @@ The following table lists four key workflows in the UID2 framework with links to

| Workflow | Intended Primary Participants | Integration Guide |
| :--- | :--- | :--- |
| **DSP (Buy-Side)**<br/>[Overview](workflows/workflow-overview-buy-side.md) | DSPs who transact on UID2 tokens in the bid stream. | [DSP Integration Guide](guides/dsp-guide.md) |
| **Advertiser and Data Provider**<br/>[Overview](workflows/workflow-overview-3p-data-provider.md) | Organizations that collect user data and push it to DSPs. | [Advertiser/Data Provider Integration Guide](guides/advertiser-dataprovider-guide.md) |
| **Publisher (Supply-Side)**<br/>[Overview](workflows/workflow-overview-supply-side.md) | Organizations that propagate UID2 tokens to the bid stream via SSPs.<br/> NOTE: Publishers can choose to leverage the UID2 SDK for JavaScript (see [UID2 SDK for JavaScript Reference Guide](sdks/client-side-identity.md)) or complete their own server-only integration without using an SDK. | [UID2 SDK for JavaScript Integration Guide](guides/publisher-client-side.md)<br/>[Publisher Integration Guide, Server-Only](guides/custom-publisher-integration.md) |
| **Opt-Out**<br/>[Overview](getting-started/gs-opt-out.md#opt-out-workflow) | Consumers who engage with publishers or their SSO providers and other identity providers. | N/A |
| [Workflow for DSPs](overviews/overview-dsps.md#workflow-for-dsps) (Buy-Side) | DSPs who transact on UID2 tokens in the bid stream. | [DSP Integration Guide](guides/dsp-guide.md) |
| [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. | [Advertiser/Data Provider Integration Guide](guides/advertiser-dataprovider-guide.md) |
| [Workflow for Publishers](overviews/overview-publishers.md#workflow-for-publishers) | Organizations that propagate UID2 tokens to the bid stream via SSPs.<br/> NOTE: Publishers can choose to leverage the UID2 SDK for JavaScript (see [UID2 SDK for JavaScript Reference Guide](sdks/client-side-identity.md)) or complete their own server-only integration without using an SDK. | [UID2 SDK for JavaScript Integration Guide](guides/publisher-client-side.md)<br/>[Publisher Integration Guide, Server-Only](guides/custom-publisher-integration.md) |
| [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 |

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.

![The UID2 Ecosystem](workflows/images/UID2Workflows.jpg)
![The UID2 Ecosystem](images/UID2Workflows.jpg)

## FAQs

Expand Down
40 changes: 30 additions & 10 deletions docs/overviews/overview-advertisers.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ banner_description: Upgrade campaign activation with Unified ID 2.0.

Advertisers can upgrade their first-party data tactics with Unified ID 2.0 to deliver omnichannel campaigns across devices with one identifier.

The following sections break down the workflows, integration types and documentation for advertisers adopting UID2.
The following sections provide information about benefits, workflow, documentation, and other resources for advertisers adopting UID2.

## Audience

Expand All @@ -26,20 +26,22 @@ Here are just some of the intended benefits of using UID2 as part of your advert
- Target and measure campaigns more holistically.
- Offer opt-out, with the goal of improving consumer privacy controls.

## Resources
## Workflow for Advertisers

The following documentation resources are available for advertisers to implement UID2.
The following steps provide a high-level outline of the workflow intended for organizations that collect user data and push it to DSPs—for example, advertisers, identity graph providers, and third-party data providers.

| Integration Type| Documentation | Content Description | Audience |
| :--- | :--- | :--- | :--- |
| Integration steps for organizations that collect user data and push it to other UID2 participants | [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md) | This integration guide for advertisers and data providers covers integration workflows for mapping identity for audience-building and targeting. | Advertisers,<br/>Data Providers |
| Snowflake | [Snowflake Integration Guide](../guides/snowflake_integration.md) | Instructions for generating UID2s from emails within Snowflake. | Advertisers,<br/>Data Providers |
The following process occurs in the background:
* Data provider monitors the UID2 Operator for rotated salt buckets and updates UID2s as needed.

## Workflow for Advertisers
The following steps are an example of how an advertiser or data provider can integrate with UID2:

1. Data provider sends a user’s consented [directly identifying information (DII)](../ref-info/glossary-uid.md#gl-dii) to the UID2 Operator.
2. UID2 Operator generates and returns a raw UID2 and salt bucket ID.
3. Data provider stores the UID2 and salt bucket ID and sends the UID2-based first-party and third-party audience segments to the DSP.

The following diagram shows the UID2 workflow for advertisers.
Server-side: The data provider stores the UID2 in a mapping table, DMP, data lake, or other server-side application.

![Advertiser Workflow](../workflows/images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg)
![Data Provider Workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg)

## Getting Started

Expand All @@ -56,6 +58,24 @@ To get started, follow these steps:
1. Test.
1. Go live.

## Resources

The following documentation resources are available for advertisers to implement UID2.

| Integration Type| Documentation | Content Description | Audience |
| :--- | :--- | :--- | :--- |
| Integration steps for organizations that collect user data and push it to other UID2 participants | [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md) | This integration guide for advertisers and data providers covers integration workflows for mapping identity for audience-building and targeting. | Advertisers,<br/>Data Providers |
| Snowflake | [Snowflake Integration Guide](../guides/snowflake_integration.md) | Instructions for generating UID2s from emails within Snowflake. | Advertisers,<br/>Data Providers |

<!-- ## Integration Requirements
To generate UID2s from users' DII, third-party data providers must meet the following requirements:
- Integrate with a UID2 Operator to generate UID2s and handle salt bucket rotations.
- Have access to the UID2 Operator APIs.<br/>Some advertisers may choose to work through CDPs, data on-boarders, or other service providers instead.
For details, see [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md). -->

## FAQs for Advertisers

For a list of frequently asked questions for advertisers using the UID2 framework, see [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
42 changes: 31 additions & 11 deletions docs/overviews/overview-data-providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ banner_description: An identity solution for the future.

Data and measurement providers can reduce identity fragmentation by adopting Unified ID 2.0 to connect data with a more durable, omnichannel and cross-device identifier to fulfill their customer use cases.

The following sections break down the workflows, integration types and documentation for data providers adopting UID2.
The following sections provide information on the benefits, workflow, documentation, and other resources for data providers adopting UID2.

## Audience

Expand All @@ -29,21 +29,22 @@ Here are just some of the intended benefits for data providers using UID2:
- Connect online and offline data with a common ID to aim for more precision.
- More accurately measure campaigns with or without third-party cookies.

## Resources
## Workflow for Data Providers

The following documentation resources are available for data providers to implement UID2.
The following steps provide a high-level outline of the workflow intended for organizations that collect user data and push it to DSPs—for example, advertisers, identity graph providers, and third-party data providers.

| Integration Type | Documentation | Content Description | Audience |
| :--- | :--- | :--- | :--- |
| Integration Guide | [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md) | This integration guide for advertisers and data providers covers integration workflows for mapping identity for audience-building and targeting. | Advertisers,<br/>Data Providers |
| Snowflake | [Snowflake Integration Guide](../guides/snowflake_integration.md) | Instructions for generating UIDs from emails within Snowflake. | Advertisers,<br/>Data Providers |
| AWS Entity Resolution | [AWS Entity Resolution Integration Guide](../guides/integration-aws-entity-resolution.md) | Instructions for integrating with the UID2 framework using AWS Entity Resolution. | Advertisers,<br/>Data Providers |
The following process occurs in the background:
* Data provider monitors the UID2 Operator for rotated salt buckets and updates UID2s as needed.

## Workflow for Data Providers
The following steps are an example of how an advertiser or data provider can integrate with UID2:

The following diagram shows the UID2 workflow for data providers.
1. Data provider sends a user’s consented [directly identifying information (DII)](../ref-info/glossary-uid.md#gl-dii) to the UID2 Operator.
2. UID2 Operator generates and returns a raw UID2 and salt bucket ID.
3. Data provider stores the UID2 and salt bucket ID and sends the UID2-based first-party and third-party audience segments to the DSP.

![Data Provider Workflow](../workflows/images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg)
Server-side: The data provider stores the UID2 in a mapping table, DMP, data lake, or other server-side application.

![Data Provider Workflow](images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg)

## Getting Started

Expand All @@ -60,6 +61,25 @@ To get started, follow these steps:
1. Test.
1. Go live.

## Resources

The following documentation resources are available for data providers to implement UID2.

| Integration Type | Documentation | Content Description | Audience |
| :--- | :--- | :--- | :--- |
| Integration Guide | [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md) | This integration guide for advertisers and data providers covers integration workflows for mapping identity for audience-building and targeting. | Advertisers,<br/>Data Providers |
| Snowflake | [Snowflake Integration Guide](../guides/snowflake_integration.md) | Instructions for generating UIDs from emails within Snowflake. | Advertisers,<br/>Data Providers |
| AWS Entity Resolution | [AWS Entity Resolution Integration Guide](../guides/integration-aws-entity-resolution.md) | Instructions for integrating with the UID2 framework using AWS Entity Resolution. | Advertisers,<br/>Data Providers |

<!-- ## Integration Requirements
To generate UID2s from users' DII, third-party data providers must meet the following requirements:
- Integrate with a UID2 Operator to generate UID2s and handle salt bucket rotations.
- Have access to the UID2 Operator APIs.<br/>Some advertisers may choose to work through CDPs, data on-boarders, or other service providers instead.
For details, see [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md). -->

## FAQs for Data Providers

For a list of frequently asked questions for data providers using the UID2 framework, see [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
60 changes: 44 additions & 16 deletions docs/overviews/overview-dsps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ banner_title: UID2 Overview for DSPs
banner_description: Enable data strategies with a more durable identifier.
---

This page provides information about what the Unified ID 2.0 (UID2) framework offers to demand-side platforms (DSPs), available implementation options, and how to get started. The following sections break down the workflows, integration types, and documentation for DSPs adopting UID2.
This page provides information about what the Unified ID 2.0 (UID2) framework offers to demand-side platforms (DSPs), workflow, documentation and other resources, and how to get started.

The following sections provide information about benefits, workflow, documentation, and other resources for DSPs adopting UID2.

## Audience

This page is for DSPs (Demand-Side Platforms). Media-buying platforms can facilitate identity strategies for first-party data activation for advertisers and inventory monetization for publishers with Unified ID 2.0.
This page is for DSPs (demand-side platforms). Media-buying platforms can facilitate identity strategies for first-party data activation for advertisers and inventory monetization for publishers with Unified ID 2.0.

## Benefits of UID2 for DSPs

Expand All @@ -26,25 +28,26 @@ Here are just some of the intended benefits for DSPs using UID2:
- Offer opt-out, with the goal of improving consumer privacy controls.
- More accurately measure campaigns with or without third-party cookies.

## Resources
## Workflow for DSPs

The following documentation resources are available for DSPs to implement UID2.
The following steps provide a high-level outline of the workflow intended for demand-side platforms (DSPs) that transact on UID2s in the bid stream.

| Type| Documentation | Content Description | Audience |
| :--- | :--- | :--- | :--- |
|UID2 SDK for Java | [UID2 SDK for Java (Server-Side) Reference Guide](../sdks/uid2-sdk-ref-java.md) | An SDK for anyone using Java server-side who wants to decrypt UID2 advertising tokens to access the raw UID2.| DSPs |
|UID2 SDK for Python | [UID2 SDK for Python (Server-Side) Reference Guide](../sdks/uid2-sdk-ref-python.md) | An SDK for anyone using Python server-side who wants to decrypt UID2 advertising tokens to access the raw UID2.| DSPs |
|UID2 SDK for C# / .NET | [UID2 SDK for C# / .NET (Server-Side) Reference Guide](../sdks/uid2-sdk-ref-csharp-dotnet.md) | An SDK for anyone using .NET server-side who wants to decrypt UID2 advertising tokens to access the raw UID2.| DSPs |
|UID2 SDK for C++ | [UID2 SDK for C++ (Server-Side) Reference Guide](../sdks/uid2-sdk-ref-cplusplus.md) | An SDK for anyone using C++ server-side who wants to decrypt UID2 advertising tokens to access the raw UID2.| DSPs |
| Integration Guides | [DSP Integration Guide](../guides/dsp-guide.md) | This integration guide for DSPs covers handling UID2s for bidding and honoring user opt-outs. | DSPs |
The following processes occur in the background:
- The advertiser and/or data provider passes first-party and third-party audience segments to the DSP.
- The DSP syncs with the UID2 Operator to receive decryption keys.
- The DSP listens to opt-out requests from the UID2 Operator.

## Workflow for DSPs
The following steps occur for each bid/ad impression:

The following diagram shows the UID2 workflow for DSPs.
1. A bid request is passed into the bid stream with the UID2 token.
2. The DSP receives the bid request with the UID2 token from the bid stream.
3. The DSP:
- Decrypts the UID2 token into a raw UID2.
- Checks to see if the user opted out and, if so, does not bid.
- Matches the raw UID2 to an audience segment.
4. The DSP sends a bid response to the bid stream based on the raw UID2.

![DSP Workflow](../workflows/images/UID2BuySIdeDSPWorkflow.jpg)

For details, see [DSP Workflow Overview](../workflows/workflow-overview-buy-side.md).
![Buy-Side Workflow](images/UID2BuySIdeDSPWorkflow.jpg)

## Getting Started

Expand All @@ -63,6 +66,31 @@ To get started, follow these steps:
8. Test.
9. Go live.

## Resources

The following documentation resources are available for DSPs to implement UID2.

| Type| Documentation | Content Description | Audience |
| :--- | :--- | :--- | :--- |
|UID2 SDK for Java | [UID2 SDK for Java (Server-Side) Reference Guide](../sdks/uid2-sdk-ref-java.md) | An SDK for anyone using Java server-side who wants to decrypt UID2 advertising tokens to access the raw UID2.| DSPs |
|UID2 SDK for Python | [UID2 SDK for Python (Server-Side) Reference Guide](../sdks/uid2-sdk-ref-python.md) | An SDK for anyone using Python server-side who wants to decrypt UID2 advertising tokens to access the raw UID2.| DSPs |
|UID2 SDK for C# / .NET | [UID2 SDK for C# / .NET (Server-Side) Reference Guide](../sdks/uid2-sdk-ref-csharp-dotnet.md) | An SDK for anyone using .NET server-side who wants to decrypt UID2 advertising tokens to access the raw UID2.| DSPs |
|UID2 SDK for C++ | [UID2 SDK for C++ (Server-Side) Reference Guide](../sdks/uid2-sdk-ref-cplusplus.md) | An SDK for anyone using C++ server-side who wants to decrypt UID2 advertising tokens to access the raw UID2.| DSPs |
| Integration Guides | [DSP Integration Guide](../guides/dsp-guide.md) | This integration guide for DSPs covers handling UID2s for bidding and honoring user opt-outs. | DSPs |

<!-- ## Integration Requirements
To integrate with UID2 to receive UID2s from brands (as first-party data) and data providers (as third-party data) and leverage them to inform bidding on UID2s in the bid stream, the buy-side participants must meet the following requirements:
- Accept data in the form of UID2s
- Bid on data in the form of UID2s
- Build a webhook for honoring opt-out requests
- Sync encryption keys daily with the UID2 Administrator
For details, see [DSP Integration Guide](../guides/dsp-guide.md).
Optionally, if DSPs want to generate UID2s themselves from DII, they can also follow the [Third-Party Data Provider Workflow](overview-data-providers.md#workflow-for-data-providers). -->

## FAQs for DSPs

For a list of frequently asked questions for DSPs using the UID2 framework, see [FAQs for DSPs](../getting-started/gs-faqs.md#faqs-for-dsps).
Loading

0 comments on commit 4f9fca2

Please sign in to comment.