Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/endpoints/post-token-generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ The `optout_check` parameter, required with a value of `1`, checks whether the u

Rather than calling this endpoint directly, you could use one of the SDKs to manage it for you. For a summary of options, see [SDKs: Summary](../sdks/summary-sdks.md).

:::important
Whatever option you use, the data that you send for generating UID2s must be normalized, hashed, and encoded before sending. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md).
:::

## Request Format

`POST '{environment}/v2/token/generate'`
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/gs-normalization-encoding.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ You can use this tool to verify that your internal processes are set up to corre

In all scenarios, follow the steps on your side to prepare your DII for processing, and then check your resulting values by using the [UID2 Hashing Tool](#uid2-hashing-tool). If the results don't match, check each step to find the error.

If you're having trouble or getting errors, or even if you just want to be sure you're following the steps correctly, here are some things you can check:
If you're having trouble or getting errors, or if you just want to be sure you're following the steps correctly, here are some things you can check:

- **Phone numbers**: Make sure you're normalizing—and normalizing correctly—as the first step.

Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-advertiser-dataprovider-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ displayed_sidebar: sidebarAdvertisers
---

import Link from '@docusaurus/Link';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# Advertiser/Data Provider Integration to HTTP Endpoints

Expand All @@ -32,6 +33,10 @@ You'll need to set up these values, in the UID2 Portal on the [API Keys](../port
It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret).
:::

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## High-Level Steps

At a high level, the steps for advertisers and data providers integrating with UID2 are as follows:
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-advertiser-dataprovider-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ displayed_sidebar: sidebarAdvertisers
---

import Link from '@docusaurus/Link';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# Advertiser/Data Provider Integration Overview

Expand All @@ -27,6 +28,10 @@ There are other ways that you can use UID2, outside these use cases. These are j
| Send&nbsp;in&nbsp;conversions | Send raw UID2s as conversion information | Use conversion information for measurement (attribution) or for retargeting via API or pixels. |
| Receive&nbsp;graph&nbsp;data | Receive raw UID2s from graph/data providers via API or pixels | Build graph data. |

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## High-Level Steps

At a high level, the steps for advertisers and data providers integrating with UID2 are as follows:
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-aws-entity-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ displayed_sidebar: docs
---

import Link from '@docusaurus/Link';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# AWS Entity Resolution Integration Guide

Expand Down Expand Up @@ -73,6 +74,10 @@ The following table shows the sequence of steps shown in the diagram.
| 16 | Amazon Data Exchange | Returns raw UID2s to AWS Entity Resolution. |
| 17 | AWS Entity Resolution | Writes the output records to the S3 bucket including the raw UID2s. |

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Initial Setup Steps

The following are the initial steps for setting up your UID2 integration in AWS Entity Resolution:
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-ctv-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ displayed_sidebar: docs

import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptPrivateOperatorOption from '../snippets/_snpt-private-operator-option.mdx';

# CTV Integration Guide
Expand All @@ -31,6 +32,10 @@ To determine how you'll implement these steps, choose from the [CTV Integration

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Private Operator Option

<SnptPrivateOperatorOption />
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-databricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ displayed_sidebar: docs
---

import Link from '@docusaurus/Link';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# Databricks Clean Rooms Integration Guide

Expand Down Expand Up @@ -44,6 +45,10 @@ Here are some key benefits of integrating with Databricks for your UID2 processi
- Streamlined integration between UID2 identifiers and The Trade Desk activation ecosystem.
- Self-service support for marketers and advertisers through Databricks.

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Integration Steps

At a high level, the following are the steps to set up your Databricks integration and process your data:
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-google-ss.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ displayed_sidebar: docs

import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# Google Ad Manager Secure Signals Integration Guide

Expand Down Expand Up @@ -88,6 +89,10 @@ A sample implementation for Prebid.js with Secure Signals is also available. For

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Publisher Integration

When an encrypted signal is cached, the secure signals feature does not execute the handler to generate a new signal. Because of this, it is necessary to clear the cache before and after data capture.
Expand Down
7 changes: 6 additions & 1 deletion docs/guides/integration-javascript-client-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ displayed_sidebar: docs
---

import Link from '@docusaurus/Link';
import SnptExampleClientServerSendUid2ToSdk from '../snippets/_snpt-example-client-server-send-uid2-to-sdk.mdx';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptExampleClientServerSendUid2ToSdk from '../snippets/_snpt-example-client-server-send-uid2-to-sdk.mdx';

# Client-Server Integration Guide for JavaScript

Expand Down Expand Up @@ -46,6 +47,10 @@ If you are using Google Ad Manager and want to use the secure signals feature, f

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Complete UID2 Account Setup and Configure Account

To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-javascript-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import Link from '@docusaurus/Link';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# Client-Side Integration Guide for JavaScript

Expand Down Expand Up @@ -61,6 +62,10 @@ If you want to use a debug build of the SDK, use the following URL instead:

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Complete UID2 Account Setup and Configure Account

To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ displayed_sidebar: docs

import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# UID2 Integration Overview for JavaScript

Expand All @@ -31,6 +32,10 @@ For additional flexibility, UID2 also provides alternative methods for some of t

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Client-Side or Client-Server Integration

The options for integrating with UID2 using the SDK for JavaScript are summarized in the following table. Choose the option that's best for you.
Expand Down
7 changes: 6 additions & 1 deletion docs/guides/integration-mobile-client-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ displayed_sidebar: docs
import Link from '@docusaurus/Link';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptExampleAdvertisingToken from '../snippets/_snpt-example-advertising-token.mdx';
import SnptEnableLogging from '../snippets/_snpt-mobile-docs-enable-logging.mdx';
import SnptGMAIMA_Plugins from '../snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx';
import SnptPrebidMobileSDK from '../snippets/_snpt-mobile_docs_prebid-mobile.mdx';
import SnptErrorResponseStates from '../snippets/_snpt-mobile-docs-error-response-states.mdx';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';

# UID2 Client-Server Integration Guide for Mobile

Expand Down Expand Up @@ -61,6 +62,10 @@ For instructions for installing the correct SDK/version into your mobile app, se

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Complete UID2 Account Setup and Configure Account

To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
Expand Down
7 changes: 6 additions & 1 deletion docs/guides/integration-mobile-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ displayed_sidebar: docs
import Link from '@docusaurus/Link';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptExampleAdvertisingToken from '../snippets/_snpt-example-advertising-token.mdx';
import SnptEnableLogging from '../snippets/_snpt-mobile-docs-enable-logging.mdx';
import SnptGMAIMA_Plugins from '../snippets/_snpt-mobile_docs_gmaima-plugin-gss.mdx';
import SnptPrebidMobileSDK from '../snippets/_snpt-mobile_docs_prebid-mobile.mdx';
import SnptErrorResponseStates from '../snippets/_snpt-mobile-docs-error-response-states.mdx';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';

# UID2 Client-Side Integration Guide for Mobile

Expand Down Expand Up @@ -196,6 +197,10 @@ If necessary, you can also change the default Subscription ID and public key to

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Complete UID2 Account Setup and Configure Account

To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-mobile-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ displayed_sidebar: sidebarPublishers

import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# UID2 Mobile Integration Overview for Android and iOS

Expand All @@ -33,6 +34,10 @@ For additional flexibility, UID2 also provides alternative methods for some of t

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Integration Overview: High-Level Steps

At a high level, to integrate your mobile app with UID2 using the UID2 mobile SDKs, you'll need to complete the following steps:
Expand Down
9 changes: 9 additions & 0 deletions docs/guides/integration-options-private-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ displayed_sidebar: docs
import Link from '@docusaurus/Link';
import SnptUpgradePolicy from '../snippets/_snpt-private-operator-upgrade-policy.mdx';
import SnptRotatingTheKeys from '../snippets/_snpt-private-operator-rotating-the-keys.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# UID2 Private Operator Integration Overview

Expand Down Expand Up @@ -98,6 +99,10 @@ For information about supported versions and deprecation dates, see [Private Ope

<SnptRotatingTheKeys />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Getting Started

To get started as a Private Operator, follow these steps:
Expand All @@ -115,6 +120,10 @@ To get started as a Private Operator, follow these steps:
5. Test.
6. Go live.

:::important
Whatever option you use, the data that you send for generating UID2s must be normalized, hashed, and encoded before sending. For details, see [Normalization and Encoding](../getting-started/gs-normalization-encoding.md).
:::

## Implementation Resources

The following documentation resources are available for Private Operators to implement UID2.
Expand Down
5 changes: 5 additions & 0 deletions docs/guides/integration-options-publisher-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ displayed_sidebar: sidebarPublishers
---

import Link from '@docusaurus/Link';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';

# Publisher Web Integration Overview

Expand Down Expand Up @@ -43,6 +44,10 @@ To accomplish all steps, you can combine solutions. For example, you could use t

<!-- &#9989; = Supported | &#8212; = Not Supported -->

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Publisher Web Options Workflow

To choose your implementation and get started, follow these steps:
Expand Down
7 changes: 6 additions & 1 deletion docs/guides/integration-prebid-client-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ displayed_sidebar: docs
---

import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptAddPrebidjsToYourSite from '../snippets/_snpt-prebid-add-prebidjs-to-your-site.mdx';
import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';

# UID2 Client-Server Integration Guide for Prebid.js

Expand Down Expand Up @@ -40,6 +41,10 @@ Information about how to integrate Prebid with UID2 is also in the following loc

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Integration Overview: High-Level Steps

You'll need to complete the following steps:
Expand Down
7 changes: 6 additions & 1 deletion docs/guides/integration-prebid-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ displayed_sidebar: docs
---

import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptAddPrebidjsToYourSite from '../snippets/_snpt-prebid-add-prebidjs-to-your-site.mdx';
import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';

# UID2 Client-Side Integration Guide for Prebid.js

Expand All @@ -31,6 +32,10 @@ If you need to use an earlier version of Prebid.js, use the implementation solut

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Integration Overview: High-Level Steps

You'll need to complete the following steps:
Expand Down
13 changes: 9 additions & 4 deletions docs/guides/integration-prebid.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,21 @@ displayed_sidebar: sidebarPublishers

import Link from '@docusaurus/Link';
import SnptIntegratingWithSSO from '../snippets/_snpt-integrating-with-sso.mdx';
import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx';
import SnptStoreUID2TokenInBrowser from '../snippets/_snpt-prebid-storing-uid2-token-in-browser.mdx';

# UID2 Integration Overview for Prebid

This guide is an overview of integration options for publishers who want to integrate with UID2 and generate <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 tokens</Link> (advertising tokens) to be passed by Prebid.js or the Prebid Mobile SDK in the RTB <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link>.

## Integrating with Single Sign-On (SSO)

<SnptIntegratingWithSSO />

## Preparing DII for Processing

<SnptPreparingEmailsAndPhoneNumbers />

## Prebid.js Support for Web

UID2 provides a Prebid.js module that supports the following:
Expand All @@ -33,10 +42,6 @@ UID2 is not designed to be used where <Link href="../ref-info/glossary-uid#gl-gd

<!-- GDPR statement difference for UID2/EUID | UID2 is not designed to be used where GDPR applies | EUID is designed to be used only where GDPR applies. -->

## Integrating with Single Sign-On (SSO)

<SnptIntegratingWithSSO />

### Generating the UID2 Token

Depending on access to DII, there are two methods to generate UID2 tokens for use with Prebid.js, as shown in the following table.
Expand Down
Loading
Loading