UID2 minor edits#1018
Conversation
sunnywu
left a comment
sunnywu
left a comment
There was a problem hiding this comment.
Documentation cleanup looks good overall — title renames, link fix, and Operator casing are consistently applied across English and Japanese mirrors. Flagging a few small inconsistencies where the rename was applied incompletely.
| title: UID2 Client-Server Integration Guide for Prebid.js | ||
| title: Client-Server Integration Guide for Prebid.js | ||
| sidebar_label: Client-Server Integration for Prebid.js | ||
| pagination_label: UID2 Client-Server Integration for Prebid.js |
There was a problem hiding this comment.
Claude Review: pagination_label still says UID2 Client-Server Integration for Prebid.js, even though title was just updated to drop the UID2 prefix. The sibling file integration-prebid-client-side.md updated both — looks like an oversight here. Same issue in the Japanese mirror at i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-prebid-client-server.md.
There was a problem hiding this comment.
Done, 2 instances, thx.
| A raw UID2 is an identifier for a user at a specific moment in time. The raw UID2 for a specific user changes roughly once per year as part of the UID2 refresh process. | ||
|
|
||
| The v3 Identity Map API provides a refresh timestamp (`r` field) in the response that indicates when each raw UID2 might rotate. Use this timestamp to determine when to regenerate raw UID2s for your stored data. | ||
| The v3 `POST /identity/map` API provides a refresh timestamp (`r` field) in the response that indicates when each raw UID2 might rotate. Use this timestamp to determine when to regenerate raw UID2s for your stored data. |
There was a problem hiding this comment.
Claude Review: Now that the canonical endpoint name is POST /v3/identity/map, writing The v3 `POST /identity/map` API reads as redundant/inconsistent with the rest of the rename. Suggest just: The `POST /v3/identity/map` API….
There was a problem hiding this comment.
Done, two instances in English files, thx (translator will take care of the Japanese in this instance).
| A raw UID2 is an identifier for a user at a specific moment in time. The raw UID2 for a specific user changes roughly once per year as part of the UID2 refresh process. | ||
|
|
||
| The v3 Identity Map API provides a refresh timestamp (`r` field) in the response that indicates when each raw UID2 might rotate. Use this timestamp to determine when to regenerate raw UID2s for your stored data. | ||
| The v3 `POST /identity/map` API provides a refresh timestamp (`r` field) in the response that indicates when each raw UID2 might rotate. Use this timestamp to determine when to regenerate raw UID2s for your stored data. |
There was a problem hiding this comment.
Claude Review: Same as the equivalent change in integration-advertiser-dataprovider-endpoints.md — v3 `POST /identity/map` API is redundant under the new naming convention. Suggest The `POST /v3/identity/map` API….
There was a problem hiding this comment.
Yep done see above thx.
| ### Latest Identity Map Endpoint (v3) | ||
| ### Latest POST /v3/identity/map Endpoint | ||
|
|
||
| In the latest identity map integration, you only need to call one endpoint, `POST /identity/map`. The `POST /identity/buckets` endpoint is not part of the workflow. |
There was a problem hiding this comment.
Claude Review: Heading on line 41 was just updated to Latest POST /v3/identity/map Endpoint, but this body sentence still refers to one endpoint, `POST /identity/map` . Reads inconsistently — consider matching the heading by writing POST /v3/identity/map here too. Same hunk in i18n/ja/docusaurus-plugin-content-docs/current/endpoints/summary-endpoints.md.
There was a problem hiding this comment.
Done. Japanese doesn't entirely match until the translator does his pass.
sunnywu
left a comment
sunnywu
left a comment
There was a problem hiding this comment.
Follow-up: two more spots where the UID2-prefix removal is applied asymmetrically. Also flagging an anchor-rendering verification ask: the new headings like ## Migration from POST /v2/identity/map rely on the default github-slugger producing migration-from-post-v2identitymap (slashes stripped). Worth doing a local yarn build to confirm none of the new in-page anchors silently 404.
| | You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, but you want to refresh tokens on the client side—or you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>. | Client-Server Integration | [UID2 Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) | | ||
| | You have access to <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> (email address or phone number) on the client side/within the mobile app, and want to keep changes within your app only. | Client-Side integration | [Client-Side Integration Guide for Mobile](integration-mobile-client-side.md) | | ||
| | You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, but you want to refresh tokens on the client side—or you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>. | Client-Server Integration | [Client-Server Integration Guide for Mobile](integration-mobile-client-server.md) | | ||
| | You have access to DII on the server side only and can do the necessary development to generate UID2 tokens server-side, or you are using a <Link href="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>. | Server-Side Integration | [UID2 Server-Side Integration Guide for Mobile](integration-mobile-server-side.md) | |
There was a problem hiding this comment.
Claude Review: This row still reads [UID2 Server-Side Integration Guide for Mobile] while the two rows above had the UID2 prefix dropped in this PR. The link text technically matches the target file's current title (integration-mobile-server-side.md was not touched and still starts with UID2 Server-Side…), but the rendered table now shows a mixed list:
- Client-Side Integration Guide for Mobile
- Client-Server Integration Guide for Mobile
- UID2 Server-Side Integration Guide for Mobile
Is the intent to follow up with a separate rename of the server-side mobile guide? Or should this stay as-is to match EUID PR #406? Worth confirming. Same asymmetry in the JA mirror.
There was a problem hiding this comment.
@sunnywu let's follow up. I agree there's really no point in this inconsistency, but a couple of the titles felt too generic to me without UID2/EUID. We should bring them together but better to do this in a separate task if it's OK with you. I will write it.
| @@ -456,8 +456,8 @@ May 17, 2024 | |||
| We've added the following integration guides to support publishers who want to implement UID2 for their Android or iOS mobile apps: | |||
|
|
|||
| - [UID2 Mobile Integration Overview for Android and iOS](../guides/integration-mobile-overview) | |||
There was a problem hiding this comment.
Claude Review: This historical entry's link text still says [UID2 Mobile Integration Overview for Android and iOS], but integration-mobile-overview.md's actual title was changed in this same PR to drop the UID2 prefix. The PR did rewrite other historical references (e.g., Identity Map v3 → POST /v3/identity/map heading earlier in this same file), so the policy is inconsistent — either keep historical link text frozen, or update it to match current titles. Same instance in i18n/ja/.../ref-info/updates-doc.md.
There was a problem hiding this comment.
Made all consistent without the UID2.
sunnywu
left a comment
sunnywu
left a comment
There was a problem hiding this comment.
Third pass — two more sibling-heading inconsistencies inside files this PR already modifies. Plus one scope question: UID2 Mobile Integration Overview for Android and iOS was renamed to drop the UID2 prefix in this PR, but the sibling overview titles UID2 Integration Overview for Prebid and UID2 Integration Overview for JavaScript still keep the prefix. Worth confirming whether the mobile-overview rename was intentional in isolation (matching EUID #406 exactly) or whether the JS/Prebid overviews should follow.
| July 11, 2025 | ||
|
|
||
| We've released a new version of the Identity Map API (v3) that provides significant improvements for advertisers and data providers. This update includes documentation for the [POST /identity/map](../endpoints/post-identity-map.md) endpoint, the [SDK for Java Reference Guide](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers), and the [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md). | ||
| We've released a new version of the Identity Map API (v3) that provides significant improvements for advertisers and data providers. This update includes documentation for the [POST /v3/identity/map](../endpoints/post-identity-map.md) endpoint, the [SDK for Java Reference Guide](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers), and the [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md). |
There was a problem hiding this comment.
Claude Review: The heading immediately above this paragraph (line 121) is still ### Identity Map v3 (Endpoint Doc), but the sibling heading just above it on line ~104 was renamed in this same PR from ### Identity Map v3 (Python SDK, Snowflake) to ### POST /v3/identity/map (Python SDK, Snowflake). They're a paired set of July 2025 v3-launch announcements — for consistency the (Endpoint Doc) one should follow the same rename. Same instance in i18n/ja/.../ref-info/updates-doc.md line 86.
There was a problem hiding this comment.
Done in both files.
| The following instructions provide an example of how to map DII to raw UID2s using the latest version of the `POST /identity/map` endpoint. | ||
|
|
||
| For the earlier version, see [Previous SDK Version (using POST /identity/map v2)](#previous-sdk-version-using-post-identitymap-v2). For migration steps to the latest version, see [Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map). | ||
| For the earlier version, see [Previous SDK Version (using POST /v2/identity/map)](#previous-sdk-version-using-post-v2identitymap). For migration steps to the latest version, see [Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map). |
There was a problem hiding this comment.
Claude Review: This link's anchor was updated to the new style (#previous-sdk-version-using-post-v2identitymap), but the second link in this same sentence still points at #migration-from-version-using-v2-identity-map — and the corresponding heading at line 389, ## Migration From Version Using v2 Identity Map, was not renamed. By contrast, the analogous heading in post-identity-map.md was renamed from ## Migration from v2 Identity Map → ## Migration from POST /v2/identity/map in this PR. Either rename this heading (and its inbound link on line 494) for consistency, or leave the endpoint-doc rename matching this style. The same unrenamed heading also exists in docs/sdks/sdk-ref-python.md (file untouched by this PR) and both JA mirrors.
There was a problem hiding this comment.
Agreed. Updated.
sunnywu
left a comment
sunnywu
left a comment
There was a problem hiding this comment.
Fourth pass — found one real bug (the rename was applied to the H1 but the frontmatter title field was missed). After this, I'm done — the rest of the PR is internally consistent.
| import SnptPreparingEmailsAndPhoneNumbers from '../snippets/_snpt-preparing-emails-and-phone-numbers.mdx'; | ||
|
|
||
| # UID2 Mobile Integration Overview for Android and iOS | ||
| # Mobile Integration Overview for Android and iOS |
There was a problem hiding this comment.
Claude Review: The H1 here was renamed to drop UID2, and pagination_label on line 4 was also updated — but the frontmatter title field on line 2 still reads title: UID2 Mobile Integration Overview for Android and iOS. Docusaurus uses the frontmatter title for the browser tab and <title> tag, so the rendered page will show UID2 Mobile Integration Overview for Android and iOS in the tab while the visible H1 reads Mobile Integration Overview for Android and iOS. The same mismatch exists in the JA mirror at i18n/ja/docusaurus-plugin-content-docs/current/guides/integration-mobile-overview.md line 2. Suggest updating both title: lines to match.
There was a problem hiding this comment.
This was fixed in earlier edits in this pass. Thank you. There are no remaining instances of the UID2 prefix for this document. Just the couple of others that I've identified for a separate task later.
sunnywu
left a comment
sunnywu
left a comment
There was a problem hiding this comment.
Doc-only PR aligning UID2 docs with EUID PR #406/#411: drops the UID2 prefix from many guide titles/links, renames v2 identity map style references to POST /v2/identity/map (and v3 equivalents), and standardises Private Operator / Public Operator capitalisation. Spot-checked anchor slugs (e.g. #migration-from-post-v2identitymap, #using-post-v2identitymap, #previous-sdk-version-using-post-v2identitymap) and they correctly match the slugifier rules for the renamed headings. The link-target fix in gs-permissions.md (v2 row now points to post-identity-map-v2.md instead of post-identity-map.md) is a nice catch. Two small consistency observations inline — both minor, neither blocking.
| The following instructions provide an example of how to map DII to raw UID2s using the latest version of the `POST /identity/map` endpoint. | ||
|
|
||
| For the earlier version, see [Previous Version (v2 Identity Map)](#previous-version-v2-identity-map). For migration steps to the latest version, see [Migration From Version Using v2 Identity Map](#migration-from-version-using-v2-identity-map). | ||
| For the earlier version, see [Previous Version (v2 Identity Map)](#previous-version-v2-identity-map). For migration steps to the latest version, see [Migration From Version Using POST /v2/identity/map](#migration-from-version-using-post-v2identitymap). |
There was a problem hiding this comment.
Claude Review: Within this single sentence the second link was renamed (Migration From Version Using v2 Identity Map → Migration From Version Using POST /v2/identity/map) but the first link (Previous Version (v2 Identity Map)) was left in the old style — and the heading it points to at line 400 (### Previous Version (v2 Identity Map)) is also unchanged. Compare with docs/sdks/sdk-ref-java.md:303, where the analogous sentence renamed both references and the ## Previous SDK Version (using POST /v2/identity/map) heading at line 490 was updated to match. Worth applying the same rename here (line 400 heading + this link text + the link at line 407) so the Java and Python SDK pages stay in sync. Same in the JA copy.
2 participants
To match mods made in EUID PR #406 and also a few extras in EUID PR #411.