Skip to content

Commit 04aecc0

Browse files
authored
Merge pull request #936 from IABTechLab/gwh-apidocs-3347-mods-for-sw
mods to SDK summary, endpoints summary
2 parents 200f9dd + 03a7f42 commit 04aecc0

File tree

2 files changed

+112
-7
lines changed

2 files changed

+112
-7
lines changed

docs/endpoints/summary-endpoints.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ import Link from '@docusaurus/Link';
1212

1313
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).
1414

15+
## UID2 Endpoints by Audience
16+
17+
The following table shows the UID2 endpoints, with the audience for each. For details, click through to the applicable sections.
18+
19+
| Endpoint | Audience | Details |
20+
| :--- | :--- | :--- |
21+
| [POST /token/generate](post-token-generate.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
22+
| [POST /token/validate](post-token-validate.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
23+
| [POST /token/refresh](post-token-refresh.md) | Publishers | [UID2 Tokens](#uid2-tokens) |
24+
| [POST /identity/map](post-identity-map.md) | Advertisers, data providers | [Identity Map](#identity-map) |
25+
| [POST /optout/status](post-optout-status.md) | Advertisers, data providers, DSPs, sharers | [Opt-Out Status](#opt-out-status)|
26+
1527
## UID2 Tokens
1628

1729
The following endpoints are for retrieving and managing UID2 tokens (identity tokens, advertising tokens), and are used mainly by publishers.

docs/sdks/summary-sdks.md

Lines changed: 100 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,108 @@ Review the SDK functionality to determine which SDK or SDKs you want to use, the
1818

1919
The following table summarizes the functionality available with each SDK.
2020

21-
| 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** |
21+
<!-- | 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 |
2222
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
23-
|JavaScript | Client | &#8212; | &#8212; | &#9989; | &#9989; | &#8212; | &#8212; |
24-
|Java | Server | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#8212; |
23+
|JavaScript | Client | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
24+
|Java | Server | &#9989; | &#9989; | &#9989; | &#8212; | &#9989; | &#9989; |
2525
|Python | Server | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; |
26-
|C# / .NET | Server | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
27-
|C++ | Server | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
28-
|Android | Client&nbsp;(Mobile) | &#8212; | &#8212; | &#9989; | &#9989; | &#8212; | &#8212; |
29-
|iOS | Client (Mobile) | &#8212; | &#8212; | &#9989;| &#9989; |&#8212; | &#8212; |
26+
|C# / .NET | Server | &#8212; | &#8212; | &#8212; | &#8212; | &#9989; | &#9989; |
27+
|C++ | Server | &#8212; | &#8212; | &#8212; | &#8212; | &#9989; | &#9989; |
28+
|Android | Client&nbsp;(Mobile) | &#9989; | &#9989; | &#8212; | &#8212; | &#8212; | &#8212; |
29+
|iOS | Client (Mobile) | &#9989;| &#9989; |&#8212; | &#8212; | &#8212; | &#8212; | -->
30+
31+
<table>
32+
<thead>
33+
<tr>
34+
<th colspan="2">Audience&nbsp;&nbsp;&gt;&nbsp;&gt;&nbsp;&gt;</th>
35+
<th colspan="2">Publisher</th>
36+
<th colspan="2">Advertiser&nbsp;/ Data Provider</th>
37+
<th colspan="2">DSP</th>
38+
</tr>
39+
<tr>
40+
<th> SDK for...</th>
41+
<th>Client-Side or Server-Side</th>
42+
<th>Generate UID2 Token from DII</th>
43+
<th>Refresh UID2 Token</th>
44+
<th>Map DII to Raw UID2s&ast;</th>
45+
<th>Monitor Rotated Salt Buckets&ast;&ast;</th>
46+
<th>Encrypt Raw UID2 to UID2 Token for Sharing</th>
47+
<th>Decrypt UID2 Token to Raw UID2</th>
48+
</tr>
49+
</thead>
50+
<tbody>
51+
<tr>
52+
<td>JavaScript</td>
53+
<td>Client</td>
54+
<td>&#9989;</td>
55+
<td>&#9989;</td>
56+
<td>&#8212;</td>
57+
<td>&#8212;</td>
58+
<td>&#8212;</td>
59+
<td>&#8212;</td>
60+
</tr>
61+
<tr>
62+
<td>Java</td>
63+
<td>Server</td>
64+
<td>&#9989;</td>
65+
<td>&#9989;</td>
66+
<td>&#9989;</td>
67+
<td>&#8212;</td>
68+
<td>&#9989;</td>
69+
<td>&#9989;</td>
70+
</tr>
71+
<tr>
72+
<td>Python</td>
73+
<td>Server</td>
74+
<td>&#9989;</td>
75+
<td>&#9989;</td>
76+
<td>&#9989;</td>
77+
<td>&#9989;</td>
78+
<td>&#9989;</td>
79+
<td>&#9989;</td>
80+
</tr>
81+
<tr>
82+
<td>C# / .NET</td>
83+
<td>Server</td>
84+
<td>&#8212;</td>
85+
<td>&#8212;</td>
86+
<td>&#8212;</td>
87+
<td>&#8212;</td>
88+
<td>&#9989;</td>
89+
<td>&#9989;</td>
90+
</tr>
91+
<tr>
92+
<td>C++</td>
93+
<td>Server</td>
94+
<td>&#8212;</td>
95+
<td>&#8212;</td>
96+
<td>&#8212;</td>
97+
<td>&#8212;</td>
98+
<td>&#9989;</td>
99+
<td>&#9989;</td>
100+
</tr>
101+
<tr>
102+
<td>Android</td>
103+
<td>Client&nbsp;(Mobile)</td>
104+
<td>&#9989;</td>
105+
<td>&#9989;</td>
106+
<td>&#8212;</td>
107+
<td>&#8212;</td>
108+
<td>&#8212;</td>
109+
<td>&#8212;</td>
110+
</tr>
111+
<tr>
112+
<td>iOS</td>
113+
<td>Client&nbsp;(Mobile)</td>
114+
<td>&#9989;</td>
115+
<td>&#9989;</td>
116+
<td>&#8212;</td>
117+
<td>&#8212;</td>
118+
<td>&#8212;</td>
119+
<td>&#8212;</td>
120+
</tr>
121+
</tbody>
122+
</table>
30123

31124
&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.
32125

0 commit comments

Comments
 (0)