Skip to content

Commit 1e1a4d3

Browse files
committed
all guides: update instructions re UID2 Portal
1 parent ee09ff9 commit 1e1a4d3

37 files changed

+406
-71
lines changed

docs/getting-started/gs-account-setup.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,13 @@ Contacting The Trade Desk for access is temporary. When the system is moved to i
3131
When you've expressed interest in UID2, someone will contact you to help work out the details.
3232

3333
As part of account setup, provide the following information:
34-
* Name
35-
* Email address
36-
* Company name
37-
* Name and contact information for an authorized individual who can sign the contract.
34+
35+
* Company name: The legal company name to be used in the UID2 contract.
36+
37+
* A primary contact person. This individual becomes the primary administrator for the account. Include these values:
38+
* Name
39+
* Email address
40+
* Job title
3841

3942
### Client-Side Web Integrations
4043

docs/getting-started/gs-credentials.md

Lines changed: 62 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,66 @@ import Link from '@docusaurus/Link';
99

1010
# UID2 Credentials
1111

12-
Each UID2 <a href="../intro#participants">participant</a> gets a set of unique credentials. The set of credentials you get is determined by how you are participating in UID2, as shown in the following table.
12+
Each UID2 <a href="../intro#participants">participant</a> needs a 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
| :--- | :--- | :--- |
1616
| Participants using a client-side implementation | Both of the following: <ul><li><Link href="../ref-info/glossary-uid#gl-subscription-id">Subscription ID</Link></li><li><Link href="../ref-info/glossary-uid#gl-public-key">Public key</Link></li></ul>These two, together, are sometimes called <Link href="../ref-info/glossary-uid#gl-client-keypair">client keypair</Link>. | Integrations using one of these: <ul><li>[UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md)</li><li>[Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)</li><li>[UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md)</li></ul> |
1717
| Participants using a client-server implementation | Both of the following:<ul><li><Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key</li><li><Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service</li></ul> | Integrations using one of these: <ul><li>[Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)</li><li>[UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md)</li><li>[UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)</li></ul> |
1818
| Participants using a server-side implementation | Both of the following:<ul><li><Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key</li><li><Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service</li></ul> | Integrations using one of these: <ul><li>[Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md)</li><li>[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md)</li></ul> |
1919

20-
If you're using the integration environment as well as the production environment, you'll get a separate set of credentials for each environment.
20+
If you're using the integration environment as well as the production environment, you'll get a separate set of credentials for each environment. See [Getting Your Credentials](#getting-your-credentials).
21+
22+
## Getting Your Credentials
23+
24+
The following table shows how you get your credentials, for each [integration approach](../ref-info/ref-integration-approaches.md) and for each [environment](../getting-started/gs-environments.md).
25+
26+
<table>
27+
<thead>
28+
<tr>
29+
<th>Environment</th>
30+
<th>Integration Type</th>
31+
<th>Getting Credentials</th>
32+
</tr>
33+
</thead>
34+
<tbody>
35+
<tr>
36+
<td rowspan="3"><br/><br/>Prod</td>
37+
<td>Client-Side</td>
38+
<td>UID2 Portal > [Client-Side Integration](../portal/client-side-integration.md)</td>
39+
</tr>
40+
<tr>
41+
42+
<td>Client-Server</td>
43+
<td>UID2 Portal > [API Keys](../portal/api-keys.md)</td>
44+
</tr>
45+
<tr>
46+
47+
<td>Server-Side</td>
48+
<td>UID2 Portal > [API Keys](../portal/api-keys.md)</td>
49+
</tr>
50+
<tr>
51+
<td rowspan="3"><br/><br/>Integ</td>
52+
<td>Client-Side</td>
53+
<td rowspan="3"><br/><br/>Ask your UID2 contact.</td>
54+
</tr>
55+
<tr>
56+
57+
<td>Client-Server</td>
58+
59+
</tr>
60+
<tr>
61+
62+
<td>Server-Side</td>
63+
64+
</tr>
65+
</tbody>
66+
</table>
67+
68+
<!--
69+
For no-portal:
70+
To get your credentials, ask your UID2 contact.
71+
-->
2172

2273
## Subscription ID and Public Key
2374

@@ -64,4 +115,12 @@ It's best to refresh your API key and client secret on a regular cadence&#8212;f
64115

65116
## Refreshing Credentials
66117

67-
To request new credentials at any time, ask your UID2 contact.
118+
To request new credentials at any time, do one of the following:
119+
120+
- If you have UID2 Portal access, and you need new Production credentials: go to the page listed in [Getting Your Credentials](#getting-your-credentials).
121+
- If you don't have UID2 Portal access, or you need new credentials for the Integration environment, ask your UID2 contact.
122+
123+
<!--
124+
For no-portal:
125+
To request new credentials at any time, ask your UID2 contact.
126+
-->

docs/getting-started/gs-environments.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ Notes:
3333
- The integration environment and the production environment require different <Link href="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
3434
- The expiration time of the <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link> returned by the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md) or [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoints is subject to change, but is always significantly shorter in the integration environment than it is in the production environment.
3535

36+
## Getting Credentials for Each Environment
37+
38+
If you're using the integration environment as well as the production environment, you'll need to get a separate set of credentials for each environment.
39+
40+
For details about getting the values you need to access each environment, see [UID2 Credentials](gs-credentials.md).
41+
3642
## Specifying the Base URL to Reduce Latency
3743

3844
The latency of API calls depends on the proximity of the client to the UID2 servers. To reduce the latency, especially when making API calls from consumer devices, you might consider choosing a server closer to your users.

docs/guides/dsp-guide.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,21 @@ For a summary of available server-side SDKs, see [SDKs: Summary](../sdks/summary
2020
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).
2121
:::
2222

23+
## Complete UID2 Account Setup and Configure Account
24+
25+
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.
26+
27+
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
28+
29+
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
30+
31+
- <Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
32+
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
33+
34+
:::important
35+
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).
36+
:::
37+
2338
## Integration Steps
2439

2540
The following describes the integration workflow for DSP to support UID2 as part of RTB, which consists of two major steps:

docs/guides/integration-advertiser-dataprovider-endpoints.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,21 @@ This guide covers integration steps for advertisers and data providers to integr
1616
For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md).
1717
:::
1818

19+
## Complete UID2 Account Setup and Configure Account
20+
21+
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.
22+
23+
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
24+
25+
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
26+
27+
- <Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
28+
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
29+
30+
:::important
31+
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).
32+
:::
33+
1934
## High-Level Steps
2035

2136
At a high level, the steps for advertisers and data providers integrating with UID2 are as follows:

docs/guides/integration-advertiser-dataprovider-overview.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,21 @@ There are other ways that you can use UID2, outside these use cases. These are j
2626
| Send&nbsp;in&nbsp;conversions | Send UID2s as conversion information | Use conversion information for measurement (attribution) or for retargeting via API or pixels. |
2727
| Receive&nbsp;graph&nbsp;data | Receive UID2s from graph/data providers via API or pixels | Build graph data. |
2828

29+
## Complete UID2 Account Setup and Configure Account
30+
31+
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.
32+
33+
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
34+
35+
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
36+
37+
- <Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
38+
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
39+
40+
:::important
41+
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).
42+
:::
43+
2944
## High-Level Steps
3045

3146
At a high level, the steps for advertisers and data providers integrating with UID2 are as follows:

docs/guides/integration-aws-entity-resolution.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,21 @@ The following table summarizes the functionality available with the AWS Entity R
3333
| :--- | :--- | :--- | :--- | :--- |
3434
| No | No | No | No | Yes |
3535

36+
## Complete UID2 Account Setup and Configure Account
37+
38+
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.
39+
40+
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
41+
42+
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
43+
44+
- <Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
45+
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
46+
47+
:::important
48+
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).
49+
:::
50+
3651
## Integration Summary
3752

3853
The following table summarizes the steps to integrate with UID2 using AWS Entity Resolution.

docs/guides/integration-ctv-guide.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,21 @@ To determine how you'll implement these steps, choose from the [CTV Integration
2727

2828
<IntegratingWithSSO />
2929

30+
## Complete UID2 Account Setup and Configure Account
31+
32+
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.
33+
34+
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
35+
36+
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
37+
38+
- <Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
39+
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
40+
41+
:::important
42+
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).
43+
:::
44+
3045
## CTV Integration Options
3146

3247
You can decide on the integration option that's best for you based on where you want to generate and refresh the UID2 token. There are three options, as follows:

docs/guides/integration-google-ss.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,21 @@ With this framework, the following steps occur:
2828
2. The secure signals feature caches them on the client side and then transparently passes them to Google Ad Manager.
2929
3. Google Ad Manager uses the UID2 tokens to make bid requests, forwarding the tokens to approved bidders within Google AdX based on the publisher's preferences.
3030

31+
## Complete UID2 Account Setup and Configure Account
32+
33+
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.
34+
35+
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
36+
37+
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
38+
39+
- <Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
40+
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
41+
42+
:::important
43+
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).
44+
:::
45+
3146
## Allow Secure Signals Sharing
3247

3348
For your Google Ad Manager account to be eligible to receive encrypted UID2 tokens, you must make sure that encrypted signals are properly shared with third-party bidders on your Google Ad Manager account.

docs/guides/integration-javascript-client-server.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,21 @@ If you are using Google Ad Manager and want to use the secure signals feature, f
5151

5252
<IntegratingWithSSO />
5353

54+
## Complete UID2 Account Setup and Configure Account
55+
56+
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.
57+
58+
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
59+
60+
For a client-server integration you'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
61+
62+
- <Link href="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
63+
- <Link href="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
64+
65+
:::important
66+
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).
67+
:::
68+
5469
## Integration Steps
5570

5671
The following diagram outlines the steps required for establishing a user's UID2 token with a publisher and how the UID2 token integrates with the RTB bidstream.

0 commit comments

Comments
 (0)