You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/gs-credentials.md
+62-3Lines changed: 62 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,15 +9,66 @@ import Link from '@docusaurus/Link';
9
9
10
10
# UID2 Credentials
11
11
12
-
Each UID2 <ahref="../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 <ahref="../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.
13
13
14
14
| Audience | Credentials | Integration |
15
15
| :--- | :--- | :--- |
16
16
| Participants using a client-side implementation | Both of the following: <ul><li><Linkhref="../ref-info/glossary-uid#gl-subscription-id">Subscription ID</Link></li><li><Linkhref="../ref-info/glossary-uid#gl-public-key">Public key</Link></li></ul>These two, together, are sometimes called <Linkhref="../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> |
17
17
| Participants using a client-server implementation | Both of the following:<ul><li><Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key</li><li><Linkhref="../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> |
18
18
| Participants using a server-side implementation | Both of the following:<ul><li><Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key</li><li><Linkhref="../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> |
19
19
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).
<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
+
-->
21
72
22
73
## Subscription ID and Public Key
23
74
@@ -64,4 +115,12 @@ It's best to refresh your API key and client secret on a regular cadence—f
64
115
65
116
## Refreshing Credentials
66
117
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.
Copy file name to clipboardExpand all lines: docs/getting-started/gs-environments.md
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,12 @@ Notes:
33
33
- The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
34
34
- The expiration time of the <Linkhref="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link> returned by the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /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.
35
35
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
+
36
42
## Specifying the Base URL to Reduce Latency
37
43
38
44
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.
Copy file name to clipboardExpand all lines: docs/guides/dsp-guide.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,21 @@ For a summary of available server-side SDKs, see [SDKs: Summary](../sdks/summary
20
20
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).
21
21
:::
22
22
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
+
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
32
+
- <Linkhref="../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
+
23
38
## Integration Steps
24
39
25
40
The following describes the integration workflow for DSP to support UID2 as part of RTB, which consists of two major steps:
Copy file name to clipboardExpand all lines: docs/guides/integration-advertiser-dataprovider-endpoints.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,21 @@ This guide covers integration steps for advertisers and data providers to integr
16
16
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).
17
17
:::
18
18
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
+
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
28
+
- <Linkhref="../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
+
19
34
## High-Level Steps
20
35
21
36
At a high level, the steps for advertisers and data providers integrating with UID2 are as follows:
Copy file name to clipboardExpand all lines: docs/guides/integration-advertiser-dataprovider-overview.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,21 @@ There are other ways that you can use UID2, outside these use cases. These are j
26
26
| Send in conversions | Send UID2s as conversion information | Use conversion information for measurement (attribution) or for retargeting via API or pixels. |
27
27
| Receive graph data | Receive UID2s from graph/data providers via API or pixels | Build graph data. |
28
28
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
+
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
38
+
- <Linkhref="../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
+
29
44
## High-Level Steps
30
45
31
46
At a high level, the steps for advertisers and data providers integrating with UID2 are as follows:
Copy file name to clipboardExpand all lines: docs/guides/integration-aws-entity-resolution.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,21 @@ The following table summarizes the functionality available with the AWS Entity R
33
33
| :--- | :--- | :--- | :--- | :--- |
34
34
| No | No | No | No | Yes |
35
35
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
+
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
45
+
- <Linkhref="../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
+
36
51
## Integration Summary
37
52
38
53
The following table summarizes the steps to integrate with UID2 using AWS Entity Resolution.
Copy file name to clipboardExpand all lines: docs/guides/integration-ctv-guide.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,6 +27,21 @@ To determine how you'll implement these steps, choose from the [CTV Integration
27
27
28
28
<IntegratingWithSSO />
29
29
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
+
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
39
+
- <Linkhref="../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
+
30
45
## CTV Integration Options
31
46
32
47
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:
Copy file name to clipboardExpand all lines: docs/guides/integration-google-ss.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,21 @@ With this framework, the following steps occur:
28
28
2. The secure signals feature caches them on the client side and then transparently passes them to Google Ad Manager.
29
29
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.
30
30
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
+
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
40
+
- <Linkhref="../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
+
31
46
## Allow Secure Signals Sharing
32
47
33
48
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.
Copy file name to clipboardExpand all lines: docs/guides/integration-javascript-client-server.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,6 +51,21 @@ If you are using Google Ad Manager and want to use the secure signals feature, f
51
51
52
52
<IntegratingWithSSO />
53
53
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
+
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
63
+
- <Linkhref="../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
+
54
69
## Integration Steps
55
70
56
71
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