Skip to content

mods to SDK summary, endpoints summary #936

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 20, 2025
Merged

mods to SDK summary, endpoints summary #936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/endpoints/summary-endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ import Link from '@docusaurus/Link';

All UID2 endpoints require a client secret for encrypting API requests (except [POST /token/refresh](post-token-refresh.md) requests) and decrypting responses. For details, and code examples in different programming languages, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md).

## UID2 Endpoints by Audience

The following table shows the UID2 endpoints, with the audience for each. For details, click through to the applicable sections.

| Endpoint | Audience | Details |
| :--- | :--- | :--- |
| [POST /token/generate](post-token-generate.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
| [POST /token/validate](post-token-validate.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
| [POST /token/refresh](post-token-refresh.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
| [POST /identity/map](post-identity-map.md) | Advertisers, data providers | [Identity Map](#identity-map) |
| [POST /optout/status](post-optout-status.md) | Advertisers, data providers, DSPs, sharers | [Opt-Out Status](#opt-out-status)|

## UID2 Tokens

The following endpoints are for retrieving and managing UID2 tokens (identity tokens, advertising tokens), and are used mainly by publishers.
Expand Down
107 changes: 100 additions & 7 deletions docs/sdks/summary-sdks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,108 @@ Review the SDK functionality to determine which SDK or SDKs you want to use, the

The following table summarizes the functionality available with each SDK.

| UID2 SDK for... | Client-Side or Server-Side | Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s* | Monitor Rotated Salt Buckets** |
<!-- | UID2 SDK for... | Client-Side or Server-Side | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s&ast; | Monitor Rotated Salt Buckets&ast;&ast; | Encrypt Raw UID2 to UID2 Token for Sharing | Decrypt UID2 Token to Raw UID2 |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
|JavaScript | Client | &#8212; | &#8212; | &#9989; | &#9989; | &#8212; | &#8212; |
|Java | Server | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#8212; |
|JavaScript | Client | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
|Java | Server | &#9989; | &#9989; | &#9989; | &#8212; | &#9989; | &#9989; |
|Python | Server | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; |
|C# / .NET | Server | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
|C++ | Server | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
|Android | Client&nbsp;(Mobile) | &#8212; | &#8212; | &#9989; | &#9989; | &#8212; | &#8212; |
|iOS | Client (Mobile) | &#8212; | &#8212; | &#9989;| &#9989; |&#8212; | &#8212; |
|C# / .NET | Server | &#8212; | &#8212; | &#8212; | &#8212; | &#9989; | &#9989; |
|C++ | Server | &#8212; | &#8212; | &#8212; | &#8212; | &#9989; | &#9989; |
|Android | Client&nbsp;(Mobile) | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
|iOS | Client (Mobile) | &#9989;| &#9989; |&#8212; | &#8212; | &#8212; | &#8212; | -->

<table>
<thead>
<tr>
<th colspan="2">Audience&nbsp;&nbsp;&gt;&nbsp;&gt;&nbsp;&gt;</th>
<th colspan="2">Publisher</th>
<th colspan="2">Advertiser&nbsp;/ Data Provider</th>
<th colspan="2">DSP</th>
</tr>
<tr>
<th> SDK for...</th>
<th>Client-Side or Server-Side</th>
<th>Generate UID2 Token from DII</th>
<th>Refresh UID2 Token</th>
<th>Map DII to Raw UID2s&ast;</th>
<th>Monitor Rotated Salt Buckets&ast;&ast;</th>
<th>Encrypt Raw UID2 to UID2 Token for Sharing</th>
<th>Decrypt UID2 Token to Raw UID2</th>
</tr>
</thead>
<tbody>
<tr>
<td>JavaScript</td>
<td>Client</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
</tr>
<tr>
<td>Java</td>
<td>Server</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#8212;</td>
<td>&#9989;</td>
<td>&#9989;</td>
</tr>
<tr>
<td>Python</td>
<td>Server</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#9989;</td>
</tr>
<tr>
<td>C# / .NET</td>
<td>Server</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#9989;</td>
<td>&#9989;</td>
</tr>
<tr>
<td>C++</td>
<td>Server</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#9989;</td>
<td>&#9989;</td>
</tr>
<tr>
<td>Android</td>
<td>Client&nbsp;(Mobile)</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
</tr>
<tr>
<td>iOS</td>
<td>Client&nbsp;(Mobile)</td>
<td>&#9989;</td>
<td>&#9989;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
<td>&#8212;</td>
</tr>
</tbody>
</table>

&ast; Advertisers and Data Providers who need to generate raw UID2s from DII can also do this via Snowflake (see [Snowflake Integration Guide](../guides/integration-snowflake.md)) or by using the [POST&nbsp;/identity/map](../endpoints/post-identity-map.md) endpoint.

Expand Down