Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
c72faef
updates to advertiser/data provider guide, work in progress
genwhittTTD Oct 8, 2024
1a30527
update from main, fix merge conflict
genwhittTTD Oct 14, 2024
72b6e81
Refresh from main.
genwhittTTD Oct 15, 2024
cd7a363
refresh from main
genwhittTTD Dec 5, 2024
02f0909
Merge branch 'main' into gwh-APIDOCS-1662-adv-dataprov-doc-split-out
genwhittTTD Dec 6, 2024
3ad6834
file name changes
genwhittTTD Dec 6, 2024
8fdb6f1
updates
genwhittTTD Dec 6, 2024
7e608e4
zero out previous mods
genwhittTTD Dec 6, 2024
7ad370b
fix merge conflict
genwhittTTD Dec 17, 2024
b4d0c3b
Merge branch 'main' into gwh-APIDOCS-1662-adv-dataprov-doc-split-out
genwhittTTD Dec 18, 2024
5fa64e4
updates to rebuild intro page
genwhittTTD Dec 18, 2024
c004b45
Merge branch 'main' into gwh-APIDOCS-1662-adv-dataprov-doc-split-out
genwhittTTD Dec 19, 2024
93292cf
updates
genwhittTTD Dec 19, 2024
ad317ab
mods
genwhittTTD Dec 19, 2024
2b5af82
updates to Adv/DP integrate to endpoints doc
genwhittTTD Dec 20, 2024
c379603
diagram updates and other updates
genwhittTTD Dec 23, 2024
504066f
additional mod
genwhittTTD Dec 23, 2024
bfb514d
add JS SDK doc back into sidebar
genwhittTTD Dec 30, 2024
bfacc54
mods to go to 6-step procedure per AD
genwhittTTD Jan 2, 2025
4c93836
diagram mods
genwhittTTD Jan 2, 2025
c2705ce
fix broken links
genwhittTTD Jan 2, 2025
ee47d96
resolve one query based on input from AD
genwhittTTD Jan 2, 2025
c7e4333
Merge branch 'main' into gwh-APIDOCS-1662-adv-dataprov-doc-split-out
genwhittTTD Jan 6, 2025
872e74f
edits from SW, partial
genwhittTTD Jan 6, 2025
559977a
edits from SW
genwhittTTD Jan 6, 2025
766f835
additional edits from SW
genwhittTTD Jan 7, 2025
3713155
Merge branch 'main' into gwh-APIDOCS-1662-adv-dataprov-doc-split-out
genwhittTTD Jan 7, 2025
e31a9e0
additional edits from SW
genwhittTTD Jan 8, 2025
cfad48f
Merge branch 'main' into gwh-APIDOCS-1662-adv-dataprov-doc-split-out
genwhittTTD Jan 8, 2025
7f9ecc4
ADP endpoints guide updates except diagram
genwhittTTD Jan 8, 2025
6df5e7f
diagram updates
genwhittTTD Jan 8, 2025
1ba4613
diagram updates
genwhittTTD Jan 8, 2025
a014735
additional edits from SW, updated diagram and procedure
genwhittTTD Jan 9, 2025
f340b93
edit from JN
genwhittTTD Jan 9, 2025
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
2 changes: 1 addition & 1 deletion docs/endpoints/post-identity-buckets.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import Link from '@docusaurus/Link';

Monitors rotated <Link href="../ref-info/glossary-uid#gl-salt-bucket">salt buckets</Link>.

Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md).
Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Guide](../guides/integration-advertiser-dataprovider-overview.md).

## Request Format

Expand Down
8 changes: 4 additions & 4 deletions docs/endpoints/post-identity-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import Link from '@docusaurus/Link';

Maps multiple email addresses, phone numbers, or their respective hashes to their raw UID2s and <Link href="../ref-info/glossary-uid#gl-salt-bucket-id">salt bucket IDs</Link>. You can also use this endpoint to check for updates to opt-out information.

Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md).
Used by: This endpoint is used mainly by advertisers and data providers. For details, see [Advertiser/Data Provider Integration Guide](../guides/integration-advertiser-dataprovider-overview.md).

For details about the UID2 opt-out workflow and how users can opt out, see [User Opt-Out](../getting-started/gs-opt-out.md).

Expand All @@ -22,7 +22,7 @@ Here's what you need to know:
- The maximum request size is 1MB.
- To map a large number of email addresses, phone numbers, or their respective hashes, send them in *sequential* batches with a maximum batch size of 5,000 items per batch.
- Unless you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>, do not send batches in parallel. In other words, use a single HTTP connection and send batches of hashed or unhashed <Link href="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> values consecutively, without creating multiple parallel connections.
- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.<br/>Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.<br/>Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Guide](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).

## Request Format

Expand Down Expand Up @@ -59,7 +59,7 @@ You must include only **one** of the following four conditional parameters as a

### Request Examples

The following are unencrypted JSON request body examples for each parameter, one of which you should include in your identity mapping requests:
The following are unencrypted JSON request body examples for each parameter, one of which you should include in your requests to the `POST /identity/map` endpoint:

```json
{
Expand Down Expand Up @@ -94,7 +94,7 @@ The following are unencrypted JSON request body examples for each parameter, one
}
```

Here's an encrypted identity mapping request example for a phone number:
Here's an encrypted request example to the `POST /identity/map` endpoint for a phone number:

```sh
echo '{"phone": ["+12345678901", "+441234567890"]}' | python3 uid2_request.py https://prod.uidapi.com/v2/identity/map [Your-Client-API-Key] [Your-Client-Secret]
Expand Down
2 changes: 1 addition & 1 deletion docs/endpoints/post-optout-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Used by: This endpoint is used by advertisers, data providers, DSPs, and sharers

For details, refer to the following documentation, depending on your role:

- [Advertiser/Data Provider Integration Guide](../guides/advertiser-dataprovider-guide.md)
- [Advertiser/Data Provider Integration Guide](../guides/integration-advertiser-dataprovider-overview.md)
- [DSP Integration Guide](../guides/dsp-guide.md)
- [UID2 Sharing: Overview](../sharing/sharing-overview)

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/gs-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Each UID2 <a href="../intro#participants">participant</a> gets a set of unique c
| :--- | :--- | :--- |
| 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> |
| 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> |
| 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 Guide](../guides/advertiser-dataprovider-guide.md)</li></ul> |
| 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 Guide](../guides/integration-advertiser-dataprovider-overview.md)</li></ul> |

If you're using the integration environment as well as the production environment, you'll get a separate set of credentials for each environment.

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/gs-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ We do not make any promises about when the rotation takes place. To stay as up-t

#### Do refreshed emails get assigned to the same bucket with which they were previously associated?

Not necessarily. After you remap emails associated with a particular bucket ID, the emails might be assigned to a different bucket ID. To check the bucket ID, [call the mapping function](../guides/advertiser-dataprovider-guide.md#1-retrieve-a-raw-uid2-for-dii-using-the-identity-map-endpoint) and save the returned UID2 and bucket ID again.
Not necessarily. After you remap emails associated with a particular bucket ID, the emails might be assigned to a different bucket ID. To check the bucket ID, see [Generate Raw UID2s from DII](../guides/integration-advertiser-dataprovider-overview.md#1-generate-raw-uid2s-from-dii) and save the returned UID2 and bucket ID again.

:::info
When mapping and remapping emails, do not make any assumptions about the number of buckets, their rotation dates, or the specific bucket that an email gets assigned to.
Expand Down Expand Up @@ -215,7 +215,7 @@ In general yes, the process of generating a raw UID2 from DII is the same, and r

However, there is a variable factor, which is the <Link href="../ref-info/glossary-uid#gl-salt">salt</Link> value that's used in generating the raw UID2. The salt values are rotated roughly once per year (for details, see [How often should UID2s be refreshed for incremental updates?](#how-often-should-uid2s-be-refreshed-for-incremental-updates)). If the salt value changes between one request and another, those two requests result in two different raw UID2, even when the DII is the same.

For more information, see [Monitor for salt bucket rotations related to your stored raw UID2s](../guides/advertiser-dataprovider-guide.md#3-monitor-for-salt-bucket-rotations-related-to-your-stored-raw-uid2s) in the *Advertiser/Data Provider Integration Guide*.
For more information, see [Monitor for Salt Bucket Rotations for Your Stored Raw UID2s](../guides/integration-advertiser-dataprovider-overview.md#5-monitor-for-salt-bucket-rotations-for-your-stored-raw-uid2s) in the *Advertiser/Data Provider Integration Guide*.

#### If two operators process the same DII, are the results the same?

Expand Down
113 changes: 0 additions & 113 deletions docs/guides/advertiser-dataprovider-guide.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/guides/advertiser-dataprovider-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { Redirect } from '@docusaurus/router';

<Redirect to="/docs/guides/integration-advertiser-dataprovider-overview" />;
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/guides/images/advertiser-flow-mermaid.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading