Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 @@ -16,7 +16,7 @@ Used by: This endpoint is used mainly by advertisers and data providers. For det
:::important
If you're using the latest version (v3) of `POST /v3/identity/map`, you don't need to use `POST /identity/buckets` at all. You only need to use it if you're using the earlier version (v2) of `POST /v2/identity/map`.

If you're using the v2 version, we recommend that you upgrade as soon as possible, to take advantage of improvements. For migration guidance, see [Migration from POST /v2/identity/map](post-identity-map.md#migration-from-post-v2identitymap).
This endpoint is scheduled for deprecation. If you're using the v2 version, you must upgrade as soon as possible. For migration guidance, see [Migration from POST /v2/identity/map](post-identity-map.md#migration-from-post-v2identitymap). For deprecation information, see [Deprecation schedule: Endpoint versions](../ref-info/deprecation-schedule.md#endpoint-versions).
:::

## Request format
Expand Down
4 changes: 2 additions & 2 deletions docs/endpoints/summary-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ The following endpoints are part of the earlier identity map integration (versio

| Endpoint | Description | Request encryption | Response decryption |
| :--- | :--- | :--- | :--- |
| [POST /identity/buckets](post-identity-buckets.md) | Monitors rotated salt buckets using their last updated timestamp. | Required | Required |
| [POST /v2/identity/map](post-identity-map-v2.md) | Maps raw UID2s and salt bucket IDs for one or more email addresses, phone numbers, or their respective hashes. | Required | Required |
| [POST /identity/buckets](post-identity-buckets.md) (deprecated) | Monitors rotated salt buckets using their last updated timestamp. | Required | Required |
| [POST /v2/identity/map](post-identity-map-v2.md) (deprecated) | Maps raw UID2s and salt bucket IDs for one or more email addresses, phone numbers, or their respective hashes. | Required | Required |

## Opt-out status

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/gs-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ The following table lists the key permissions, the types of participants that co
| Generator | Publishers | Permission to call the [POST&nbsp;/token/generate](../endpoints/post-token-generate.md), [POST&nbsp;/token/validate](../endpoints/post-token-validate.md), and [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md) endpoints, to generate UID2 tokens from <Link href="../ref-info/glossary-uid#gl-dii">DII</Link> and to refresh them, using one of these integration methods:<ul><li>A Prebid integration</li><li>The SDK for JavaScript</li><li>An integration that directly calls the applicable API endpoints for retrieving and managing UID2 tokens</li></ul> |
| Bidder | DSPs | Permission to decrypt UID2 tokens coming in from the <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link> from publishers into raw UID2s for bidding purposes. |
| Sharer | Any participant type that takes part in UID2 sharing.<br/>For details, see [UID2 sharing: Overview](../sharing/sharing-overview.md). | Permission to do both of the following:<ul><li>Encrypt raw UID2s into UID2 tokens for sharing with another authorized sharing participant, using a UID2 SDK or Snowflake</li><li>Decrypt UID2 tokens received from another authorized sharing participant into raw UID2s</li></ul> |
| Mapper | Advertisers<br/>Data Providers | Permission to call the following endpoints to map multiple email addresses, phone numbers, or their respective hashes to their raw UID2s, previous raw UID2s, and refresh timestamps:<ul><li>[POST&nbsp;/v3/identity/map](../endpoints/post-identity-map.md) (latest version)</li><li>The earlier v2 identity mapping endpoints: [POST&nbsp;/v2/identity/map](../endpoints/post-identity-map-v2.md) and [POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md)</li></ul> |
| Mapper | Advertisers<br/>Data Providers | Permission to call the following endpoints to map multiple email addresses, phone numbers, or their respective hashes to their raw UID2s, previous raw UID2s, and refresh timestamps:<ul><li>[POST&nbsp;/v3/identity/map](../endpoints/post-identity-map.md) (latest version)</li><li>The earlier v2 identity mapping endpoints (deprecated): [POST&nbsp;/v2/identity/map](../endpoints/post-identity-map-v2.md) and [POST&nbsp;/identity/buckets](../endpoints/post-identity-buckets.md)</li></ul> |
9 changes: 5 additions & 4 deletions docs/guides/integration-snowflake.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following table shows the differences between the old and new identity mappi

| Function | Version | Return fields | Key differences | Comments |
| :-- | :-- | :-- | :-- | :-- |
| `FN_T_IDENTITY_MAP` | Previous | `UID`, `BUCKET_ID`, `UNMAPPED` | Basic identity mapping with salt bucket tracking | Legacy function using salt bucket monitoring for refresh management. For details, see [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md).|
| `FN_T_IDENTITY_MAP` (deprecated) | Previous | `UID`, `BUCKET_ID`, `UNMAPPED` | Basic identity mapping with salt bucket tracking | Legacy function using salt bucket monitoring for refresh management. For details, see [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md).|
| `FN_T_IDENTITY_MAP_V3` | Current | `UID`, `PREV_UID`, `REFRESH_FROM`, `UNMAPPED` | Enhanced with previous UID2 access and refresh timestamps | Returns previous UID2 for 90 days after rotation and uses refresh timestamps instead of salt bucket monitoring. For details, see [Map DII](#map-dii).|

### Key benefits
Expand Down Expand Up @@ -122,12 +122,13 @@ You can map DII to UID2s by using the following function:

- `FN_T_IDENTITY_MAP_V3` (for details, see [Map DII](#map-dii))

The following function is deprecated in favor of `FN_T_IDENTITY_MAP_V3`. You can still use it if you are on the previous Snowflake version (see [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md)), but we recommend upgrading as soon as possible:
The following function and view are used with the previous Snowflake integration version (see [Snowflake integration guide (pre-July 2025)](integration-snowflake-previous.md)):

- `FN_T_IDENTITY_MAP` (deprecated)
- `SALT_BUCKETS` (deprecated)

:::note
If you are using the deprecated function, and need help migrating to the newer function, see [Migration guide](#migration-guide).
:::important
`FN_T_IDENTITY_MAP` and the `SALT_BUCKETS` view are scheduled for deprecation. If you're using them, you must upgrade to `FN_T_IDENTITY_MAP_V3` as soon as possible. If you need help migrating, see [Migration guide](#migration-guide). For deprecation information, see [Deprecation schedule: Snowflake function versions](../ref-info/deprecation-schedule.md#snowflake-function-versions).
:::

To identify the UID2s that you must regenerate, monitor the `REFRESH_FROM` timestamps returned by the `FN_T_IDENTITY_MAP_V3` function. For details, see [Monitor raw UID2 refresh and regenerate raw UID2s](#monitor-raw-uid2-refresh-and-regenerate-raw-uid2s).
Expand Down
23 changes: 21 additions & 2 deletions docs/ref-info/deprecation-schedule.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,10 @@ The latest ZIP file is linked in the Release Notes column in the following table

## Endpoint versions

:::important
After the deprecation date, these endpoints are no longer supported. We reserve the right to disable them at any time after that date; a specific disable date has not yet been determined.
:::

Version 2 of the `POST /identity/map` endpoint has been superseded by version 3, which includes the additional advantages listed in [Version 3 improvements](../endpoints/post-identity-map.md#version-3-improvements).

With version 3 of the `POST /identity/map` endpoint, the `POST /identity/buckets` endpoint is no longer used at all.
Expand All @@ -95,5 +99,20 @@ The following table shows the deprecation schedule for the v2 endpoints.

Endpoint | Deprecation Date |
| ------- | ------ |
| `POST /v2/identity/map` | September 30, 2026 |
| `POST /v2/identity/buckets` | September 30, 2026 |
| `POST /v2/identity/map` | December 31, 2026 |
| `POST /v2/identity/buckets` | December 31, 2026 |

## Snowflake function versions

:::important
After the deprecation date, this function and view are no longer supported. We reserve the right to disable them at any time after that date; a specific disable date has not yet been determined.
:::

The `FN_T_IDENTITY_MAP` function has been superseded by `FN_T_IDENTITY_MAP_V3`, which includes the additional advantages listed in [Changes from previous version](../guides/integration-snowflake.md#changes-from-previous-version). With `FN_T_IDENTITY_MAP_V3`, the `SALT_BUCKETS` view is no longer needed for refresh management.

The following table shows the deprecation schedule for the Snowflake functions and views used with the previous identity mapping function.

Function/View | Deprecation Date |
| ------- | ------ |
| `FN_T_IDENTITY_MAP` | December 31, 2026 |
| `SALT_BUCKETS` | December 31, 2026 |
Loading