Skip to content

Commit 0e8069e

Browse files
committed
Merge branch 'main' into gwh-APIDOCS-2795-portal-sharing-permissions-doc
2 parents 0dc4e9e + 293205f commit 0e8069e

File tree

12 files changed

+1427
-165
lines changed

12 files changed

+1427
-165
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,17 @@ To implement, you'll need to complete the following steps:
4444

4545
## SDK for JavaScript Version
4646

47-
Support for client-side token generation is available in version 3.4.5 and above of the SDK.
47+
Support for client-side token generation is available in version 4.0.1 and above of the SDK.
4848

4949
The URL for the SDK is:
5050

51-
- [https://cdn.prod.uidapi.com/uid2-sdk-3.4.5.js](https://cdn.prod.uidapi.com/uid2-sdk-3.4.5.js)
51+
- [https://cdn.prod.uidapi.com/uid2-sdk-4.0.1.js](https://cdn.prod.uidapi.com/uid2-sdk-4.0.1.js)
5252

5353
In the following code examples, the placeholder `{{ UID2_JS_SDK_URL }}` refers to this URL.
5454

5555
If you want to use a debug build of the SDK, use the following URL instead:
5656

57-
- [https://cdn.integ.uidapi.com/uid2-sdk-3.4.5.js](https://cdn.integ.uidapi.com/uid2-sdk-3.4.5.js)
57+
- [https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js](https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js)
5858

5959
## Sample Implementation
6060

docs/ref-info/glossary-uid.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ import Link from '@docusaurus/Link';
510510
<dd>The token value is opaque: No assumptions should be made about the format or about the length of the string.</dd>
511511
<dd>The token has a limited life, but can be refreshed in the background using the <a href="#gl-refresh-token">refresh token</a>.</dd>
512512
<dd>Publishers send UID2 tokens in the bidstream.</dd>
513-
<dd>For details, see <a href="../intro#uid2-identifier-types">UID2 Identifier Types</a> and <a href="ref-tokens#uid2-tokens-key-information">UID2 Tokens: Key Information</a>.</dd>
513+
<dd>For details, see <a href="../intro#uid2-identifier-types">UID2 Identifier Types</a>, <a href="ref-tokens#uid2-tokens-key-information">UID2 Tokens: Key Information</a>, and <a href="ref-how-uid-is-created">How the UID2 Token Is Created</a>.</dd>
514514

515515
<dt><MdxJumpAnchor id="gl-unified-id-20"><a href="#gl-unified-id-20">Unified ID 2.0</a></MdxJumpAnchor></dt>
516516
<dd>The term UID2 can be used to mean the <a href="#gl-uid2-framework">UID2 framework</a>, the <a href="#gl-uid2-service">UID2 service</a>, a <a href="#gl-raw-uid2">raw UID2</a>, or a <a href="#gl-uid2-token">UID2 token</a> (advertising token).</dd>

docs/ref-info/ref-how-uid-is-created.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import Link from '@docusaurus/Link';
1313
This article describes how the UID2 token that the publisher sends in the bidstream is created. The process is the same for advertisers creating UID2 tokens for conversion pixels. It does not apply to <Link href="../ref-info/glossary-uid#gl-tokenized-sharing">tokenized sharing</Link>, where raw UID2s are encrypted into UID2 tokens before sending to another sharing participant.
1414
:::
1515

16-
When a publisher sends a user's <Link href="../ref-info/glossary-uid#gl-dii">DII</Link>&#8212;<Link href="../ref-info/glossary-uid#gl-hash">hashed</Link> or unhashed email addresses or phone numbers&#8212;to the UID2 Operator, and in return receives a <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link> to use for targeted advertising, there is a very specific sequence of processing steps that occurs along the way.
16+
When a publisher sends a user's <Link href="../ref-info/glossary-uid#gl-dii">DII</Link>&#8212;<Link href="../ref-info/glossary-uid#gl-hash">hashed</Link> or unhashed email addresses or phone numbers&#8212;to the UID2 <Link href="../ref-info/glossary-uid#gl-operator">Operator</Link>, and in return receives a <Link href="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link> to use for targeted advertising, there is a very specific sequence of processing steps that occurs along the way.
1717

18-
Some preliminary steps are taken by the publisher, but most of the processing steps are done by the UID2 <Link href="../ref-info/glossary-uid#gl-operator">Operator</Link>.
18+
Some preliminary steps are taken by the publisher, but most of the processing steps are done by the UID2 Operator.
1919

2020
It's very important that the publisher steps are performed in the correct sequence:
2121
- When steps are performed in sequence, the resulting value can be recognized as related to other [UID2 identifiers](../intro.md#uid2-identifier-types) generated from online activity by the same individual: the underlying [raw UID2](../ref-info/glossary-uid.md#gl-raw-uid2) matches the raw UID2s generated by other UID2 participants from the same DII, and therefore the token is suitable for targeted advertising.
@@ -41,19 +41,19 @@ For an example with sample values, see [Creating a UID2 Token&#8212;Example](#cr
4141
<tbody>
4242
<tr>
4343
<td>1</td>
44-
<td><Link href="../ref-info/glossary-uid#gl-normalize">Normalization</Link></td>
44+
<td><Link href="../ref-info/glossary-uid#gl-normalize">Normalize.</Link></td>
4545
<td>**Email**: Publisher or UID2 Operator<br/>**Phone number**: Publisher must normalize</td>
4646
<td>[Email Address Normalization](../getting-started/gs-normalization-encoding.md#email-address-normalization)<br/>[Phone Number Normalization](../getting-started/gs-normalization-encoding.md#phone-number-normalization)</td>
4747
</tr>
4848
<tr>
4949
<td>2</td>
50-
<td><Link href="../ref-info/glossary-uid#gl-sha-256">SHA-256</Link> hashing of normalized email address</td>
50+
<td>Apply <Link href="../ref-info/glossary-uid#gl-sha-256">SHA-256</Link> hashing to the normalized email address.</td>
5151
<td>Publisher or UID2 Operator</td>
5252
<td>[Email Address Hash Encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding)<br/>[Phone Number Hash Encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding)</td>
5353
</tr>
5454
<tr>
5555
<td>3</td>
56-
<td>Base64 encoding of SHA-256 hash</td>
56+
<td>Apply Base64 encoding to the SHA-256 hash.</td>
5757
<td>Publisher or UID2 Operator</td>
5858
<td>[Email Address Hash Encoding](../getting-started/gs-normalization-encoding.md#email-address-hash-encoding)<br/>[Phone Number Hash Encoding](../getting-started/gs-normalization-encoding.md#phone-number-hash-encoding)</td>
5959
</tr>

docs/ref-info/ref-tokens.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ Here are some key points about UID2 tokens:
2828
- Publishers send UID2 tokens in the bidstream.
2929
- Refreshing a UID2 token does not invalidate/expire the original or previous UID2 token. You can still use the earlier token until it expires.
3030

31+
For more information, see [How the UID2 Token Is Created](ref-how-uid-is-created.md).
32+
3133
## Refresh Tokens: Key Information
3234

3335
Here are some key points about refresh tokens:

docs/sdks/sdk-ref-javascript-v2.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: SDK for JavaScript (2.x and earlier versions)
3-
description: Reference information about earlier versions of the JavaScript client-side SDK.
2+
title: SDK for JavaScript (2.x and earlier)
3+
description: Reference information about 2.x and earlier versions of the JavaScript client-side SDK.
44
hide_table_of_contents: false
55
sidebar_position: 02
66
---
@@ -9,10 +9,10 @@ import Link from '@docusaurus/Link';
99
import ExampleUid2Cookie from '../snippets/_example-uid2-cookie.mdx';
1010
import ExampleJavaScriptV2Init from '../snippets/_example-javascript-v2-init.mdx';
1111

12-
# SDK for JavaScript Reference Guide (2.x and earlier versions)
12+
# SDK for JavaScript Reference Guide (v2.x and earlier)
1313

14-
:::tip
15-
This documentation is for earlier versions of the SDK for JavaScript. If you're using an earlier version, we recommend upgrading. See [SDK for JavaScript Reference Guide](sdk-ref-javascript.md), which includes a migration guide.
14+
:::important
15+
This documentation is for earlier versions of the SDK for JavaScript. If you're using an earlier version, we recommend upgrading. See [SDK for JavaScript Reference Guide](sdk-ref-javascript.md), which includes a migration guide to upgrade to the current version, v4.
1616
:::
1717

1818
Use this SDK to facilitate the process of establishing client identity using UID2 and retrieving advertising tokens. The following sections describe the high-level [workflow](#workflow-overview) for establishing UID2 identity, provide the SDK [API reference](#api-reference), and explain the [UID2 cookie format](#uid2-cookie-format).
@@ -47,11 +47,6 @@ This SDK is in the following open-source GitHub repository:
4747

4848
- [https://github.com/iabtechlab/uid2-web-integrations](https://github.com/iabtechlab/uid2-web-integrations)
4949

50-
<!-- The binary is published in these locations:
51-
52-
- NPM: [https://www.npmjs.com/package/@uid2/uid2-sdk](https://www.npmjs.com/package/@uid2/uid2-sdk)
53-
- CDN: [https://cdn.prod.uidapi.com/uid2-sdk-${VERSION_ID}.js](https://cdn.prod.uidapi.com/uid2-sdk-${VERSION_ID}.js) (** v3 JS SDK: stash per SW 8/15/23**) -->
54-
5550
## Terminology
5651

5752
In this document, the following terms apply:

0 commit comments

Comments
 (0)