You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started/gs-permissions.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,5 +26,5 @@ The following table lists the key permissions, the types of participants that co
26
26
| :--- | :--- | :--- |
27
27
| Generator | Publishers | Permission to call the [POST /token/generate](../endpoints/post-token-generate.md), [POST /token/validate](../endpoints/post-token-validate.md), and [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints, to generate UID2 tokens from <Linkhref="../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> |
28
28
| Bidder | DSPs | Permission to decrypt UID2 tokens coming in from the <Linkhref="../ref-info/glossary-uid#gl-bidstream">bidstream</Link> from publishers into raw UID2s for bidding purposes. |
29
-
| 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 SDKor Snowflake</li><li>Decrypt UID2 tokens received from another authorized sharing participant into raw UID2s</li></ul> |
29
+
| 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, Snowflake, or Databricks</li><li>Decrypt UID2 tokens received from another authorized sharing participant into raw UID2s</li></ul> |
30
30
| 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 /identity/map](../endpoints/post-identity-map.md) (latest version)</li><li>The earlier v2 identity mapping endpoints: [POST /identity/map (v2)](../endpoints/post-identity-map.md) and [POST /identity/buckets](../endpoints/post-identity-buckets.md)</li></ul> |
Copy file name to clipboardExpand all lines: docs/guides/integration-advertiser-dataprovider-endpoints.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ import Link from '@docusaurus/Link';
11
11
12
12
# Advertiser/Data Provider Integration to HTTP Endpoints
13
13
14
-
This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, or AWS Entity Resolution.
14
+
This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, Databricks, or AWS Entity Resolution.
15
15
16
16
:::tip
17
17
For a summary of all integration options and steps for advertisers and data providers, see [Advertiser/Data Provider Integration Overview](integration-advertiser-dataprovider-overview.md).
Copy file name to clipboardExpand all lines: docs/guides/integration-advertiser-dataprovider-overview.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ The following table shows the implementation options that are available for adve
53
53
54
54
| High-Level Step | Implementation Options |
55
55
| --- | --- |
56
-
|[1: Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii)| Use any of the following options to map DII to raw UID2s:<ul><li>One of these UID2 SDKs:<ul><li>Python SDK: [Map DII to Raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s)</li><li>Java SDK: [Usage for Advertisers/Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers)</li></ul></li><li>Snowflake: [Map DII](integration-snowflake.md#map-dii)</li><li>AWS Entity Resolution: [AWS Entity Resolution Integration Guide](integration-aws-entity-resolution.md)</li><li>HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md)</li></ul> |
56
+
|[1: Generate Raw UID2s from DII](#1-generate-raw-uid2s-from-dii)| Use any of the following options to map DII to raw UID2s:<ul><li>One of these UID2 SDKs:<ul><li>Python SDK: [Map DII to Raw UID2s](../sdks/sdk-ref-python.md#map-dii-to-raw-uid2s)</li><li>Java SDK: [Usage for Advertisers/Data Providers](../sdks/sdk-ref-java.md#usage-for-advertisersdata-providers)</li></ul></li><li>Snowflake: [Map DII](integration-snowflake.md#map-dii)</li><li>Databricks: [Map DII](integration-databricks.md#map-dii)</li><li>AWS Entity Resolution: [AWS Entity Resolution Integration Guide](integration-aws-entity-resolution.md)</li><li>HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md)</li></ul> |
57
57
|[2: Store Raw UID2s and Refresh Timestamps](#2-store-raw-uid2s-and-refresh-timestamps)| Custom (your choice). |
58
58
|[3: Manipulate or Combine Raw UID2s](#3-manipulate-or-combine-raw-uid2s)| Custom (your choice). |
59
59
|[4: Send Stored Raw UID2s to DSPs to Create Audiences or Conversions](#4-send-stored-raw-uid2s-to-dsps-to-create-audiences-or-conversions)| Custom (your choice). |
@@ -87,6 +87,8 @@ To generate raw UID2s, use one of the following options:
87
87
88
88
- Snowflake: See [Map DII](integration-snowflake.md#map-dii).
89
89
90
+
- Databricks: See [Map DII](integration-databricks.md#map-dii).
91
+
90
92
- AWS Entity Resolution: See [AWS Entity Resolution Integration Guide](integration-aws-entity-resolution.md).
91
93
92
94
- HTTP endpoints: [POST /identity/map](../endpoints/post-identity-map.md). For details, see [Generate Raw UID2s from DII](integration-advertiser-dataprovider-endpoints.md#1-generate-raw-uid2s-from-dii).
Copy file name to clipboardExpand all lines: docs/guides/integration-databricks.md
+22-21Lines changed: 22 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,37 +10,35 @@ displayed_sidebar: docs
10
10
11
11
import Link from '@docusaurus/Link';
12
12
13
-
# UID2 Databricks Clean Room Integration Guide
13
+
# Databricks Clean Rooms Integration Guide
14
14
15
15
This guide is for advertisers and data providers who want to convert their user data to raw UID2s in a Databricks environment.
16
16
17
-
[**GWH__MC01 "Amazon Web Services, Google Cloud Platform, or Microsoft Azure." -- which do we use? Or, any and all? And Matt said: "Let's discuss next week."**]
18
-
19
17
## Integration Overview
20
18
21
-
A Databricks clean room is a secure and privacy-protected environment where multiple parties can work together on sensitive enterprise data without direct access to each other's data.
19
+
[Databricks Clean Rooms](https://docs.databricks.com/aws/en/clean-rooms/)is a Databricks data warehousing solution, where you as a partner can store your data and integrate with the UID2 framework. Using Databricks Clean Rooms, UID2 enables you to securely share consumer identifier data without exposing sensitive <Linkhref="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link>.
22
20
23
-
In the context of UID2, you set up the clean room and place your data there. You set up a trust relationship with the UID2 Operator and allow the Operator to convert your data to raw UID2s.
21
+
In the context of UID2, you set up the Databricks Clean Rooms environment and place your data there. You set up a trust relationship with the UID2 Operator and allow the Operator to convert your data to raw UID2s.
24
22
25
-
The Secure Clean Room environment ensures that all UID2 operations occur within your Databricks workspace. You never send raw <Linkhref="../ref-info/glossary-uid#gl-dii">DII</Link>, and all calculations are performed via programmable, policy-enforced queries.
23
+
With UID2 supported in the clean room, advertisers and data partners can securely process their first-party data within Databricks.
26
24
27
-
With UID2 supported in the Databricks environment, advertisers and data partners can securely connect their first-party data to drive more relevant and measurable campaigns across the open internet.
25
+
[**GWH__EE01 is it only first-party data, or just data? If they're just sending phone numbers and emails, I don't see what the difference is... it's just data?**]
28
26
29
-
[**GWH__MC11 is it only first-party data for the moment? If they're just sending phone numbers and emails, I don't see what the difference is... it's just data?**]
27
+
[**GWH__EE02 Please provide any additional content you want in the overview. Thx.**]
30
28
29
+
<!--
31
30
## Databricks Partner Network Listing
32
31
33
-
[**GWH__EE or MC for listing update when available. https://www.databricks.com/company/partners/technology? Guessing it will be here.**]
32
+
[**GWH__EE or MC for listing update when available. https://www.databricks.com/company/partners/technology?**]
33
+
-->
34
34
35
35
## Functionality
36
36
37
37
The following table summarizes the functionality available with the UID2 Databricks integration.
38
38
39
39
| 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 |
40
40
| :--- | :--- | :--- | :--- | :--- |
41
-
|—|—|—*|—|✅|
42
-
43
-
*You cannot use Databricks to generate a UID2 token directly from <Linkhref="../ref-info/glossary-uid#gl-dii">DII</Link>. However, you can convert DII to a raw UID2, and then encrypt the raw UID2 into a UID2 token.
41
+
|—|—|—|—|✅|
44
42
45
43
## Key Benefits
46
44
@@ -63,7 +61,7 @@ At a high level, the following are the steps to set up your Databricks integrati
63
61
64
62
### Create Clean Room for UID2 Collaboration
65
63
66
-
As a starting point, create a Databricks clean room—a secure environment for you to collaborate with UID2 to process your data.
64
+
As a starting point, create a Databricks Clean Rooms environment—a secure environment for you to collaborate with UID2 to process your data.
67
65
68
66
Follow the steps in [Create clean rooms](https://docs.databricks.com/aws/en/clean-rooms/create-clean-room) in the Databricks documentation. Use the correct sharing identifier based on the [UID2 environment](../getting-started/gs-environments) you want to connect to: see [UID2 Sharing Identifiers](#uid2-sharing-identifiers).
69
67
@@ -90,13 +88,13 @@ Add one or more tables or views to the clean room. You can use any names for the
90
88
91
89
### Map DII
92
90
93
-
Run the `identity_map_v3`clean room[notebook](https://docs.databricks.com/aws/en/notebooks/) to map email addresses, phone numbers, or their respective hashes to raw UID2s.
91
+
Run the `identity_map_v3`Databricks Clean Rooms[notebook](https://docs.databricks.com/aws/en/notebooks/) to map email addresses, phone numbers, or their respective hashes to raw UID2s.
94
92
95
93
A successful notebook run results in raw UID2s populated in the output table. For details, see [Output Table](#output-table).
96
94
97
-
## Running the Clean Room Notebook
95
+
## Running the Clean Rooms Notebook
98
96
99
-
This section provides details to help you use your Databricks clean room to process your DII into raw UID2s, including the following:
97
+
This section provides details to help you use your Databricks Clean Rooms environment to process your DII into raw UID2s, including the following:
100
98
101
99
-[Notebook Parameters](#notebook-parameters)
102
100
-[Input Table](#input-table)
@@ -115,7 +113,7 @@ For example, to map DII in the clean room table named `creator.default.emails`,
115
113
| Parameter Name | Description |
116
114
| :--- | :--- |
117
115
|`input_schema`| The schema containing the table or view. |
118
-
|`input_table`| The name of the table or view containing the DII to be mapped. |
116
+
|`input_table`| The name you specify for the table or view containing the DII to be mapped. |
119
117
120
118
### Input Table
121
119
@@ -163,7 +161,13 @@ The following table shows possible values for the `UNMAPPED` column in the outpu
163
161
164
162
## Testing in the Integ Environment
165
163
166
-
[**GWH__MC content for this section is to come.**]
164
+
If you'd like to test the Databricks Clean Rooms implementation before signing a UID2 POC, you can ask your UID2 contact for access in the integ (integration) environment. This environment is for testing only, and has no production data.
165
+
166
+
In the request, be sure to include your sharing identifier, and use the sharing identifier for the UID2 integration environment. For details, see [UID2 Sharing Identifiers](#uid2-sharing-identifiers).
167
+
168
+
While you're waiting to hear back, you could create the clean room, invite UID2, and put your assets into the clean room. For details, see [Integration Steps](#integration-steps).
169
+
170
+
When your access is ready, your UID2 contact notifies you.
167
171
168
172
## Reference
169
173
@@ -192,6 +196,3 @@ At the top, click the gear icon and select **Delta Sharing**.
192
196
On the **Shared with me** tab, in the upper right, click your Databricks sharing organization and then select **Copy sharing identifier**.
193
197
194
198
For details, see [Request the recipient's sharing identifier](https://docs.databricks.com/aws/en/delta-sharing/create-recipient#step-1-request-the-recipients-sharing-identifier) in the Databricks documentation.
Copy file name to clipboardExpand all lines: docs/guides/summary-guides.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -102,6 +102,7 @@ The following documentation resources are available for advertisers and data pro
102
102
| :--- | :--- |
103
103
|[Advertiser/Data Provider Overview](integration-advertiser-dataprovider-overview.md)| This guide provides an overview of integration options for organizations that collect user data and push it to other UID2 participants. |
104
104
|[Snowflake Integration Guide](integration-snowflake.md)| Instructions for generating UID2s from emails within Snowflake. |
105
+
|[Databricks Clean Rooms Integration Guide](integration-databricks.md)| Instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. |
105
106
|[AWS Entity Resolution Integration Guide](integration-aws-entity-resolution.md)| Instructions for integrating with the UID2 framework using AWS Entity Resolution. |
106
107
|[Advertiser/Data Provider Integration to HTTP Endpoints](integration-advertiser-dataprovider-endpoints.md)| This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, or AWS Entity Resolution. |
107
108
|[Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md)| A guide for advertisers and data providers who want to use this SDK for adding a UID2 token to their tracking pixels.<!-- UID2_only: Not applicable for EUID -->|
Copy file name to clipboardExpand all lines: docs/overviews/overview-advertisers.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,7 @@ The following documentation resources are available for advertisers and data pro
76
76
| :--- | :--- | :--- |
77
77
| Overview of integration options for organizations that collect user data and push it to other UID2 participants |[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md)| This guide covers integration workflows for mapping identity for audience-building and targeting. |
78
78
| Snowflake |[Snowflake Integration Guide](../guides/integration-snowflake.md)| This guide provides instructions for generating UID2s from emails within Snowflake. |
79
+
| Databricks Clean Rooms |[Databricks Clean Rooms Integration Guide](../guides/integration-databricks.md)| This guide provides instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. |
79
80
| AWS Entity Resolution |[AWS Entity Resolution Integration Guide](../guides/integration-aws-entity-resolution.md)| This guide provides instructions for integrating with the UID2 framework using AWS Entity Resolution. |
80
81
| Integration steps for organizations that collect user data and push it to other UID2 participants, using UID2 HTTP endpoints only |[Advertiser/Data Provider Integration to HTTP Endpoints](../guides/integration-advertiser-dataprovider-endpoints.md)| This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, or AWS Entity Resolution. |
81
82
| Integration steps for advertisers and data providers who want to use the client-side JavaScript SDK for adding a UID2 token to their tracking pixels. |[Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)| This guide provides instructions for generating UID2 tokens (advertising tokens) using only JavaScript client-side changes.<!-- UID2_only: Not applicable for EUID -->|
Copy file name to clipboardExpand all lines: docs/overviews/overview-data-providers.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,6 +81,7 @@ The following documentation resources are available for advertisers and data pro
81
81
| :--- | :--- | :--- |
82
82
| Overview of integration options for organizations that collect user data and push it to other UID2 participants |[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md)| This guide covers integration workflows for mapping identity for audience-building and targeting. |
83
83
| Snowflake |[Snowflake Integration Guide](../guides/integration-snowflake.md)| This guide provides instructions for generating UID2s from emails within Snowflake. |
84
+
| Databricks Clean Rooms |[Databricks Clean Rooms Integration Guide](../guides/integration-databricks.md)| This guide provides instructions for generating UID2s from emails or phone numbers in a Databricks Clean Rooms environment. |
84
85
| AWS Entity Resolution |[AWS Entity Resolution Integration Guide](../guides/integration-aws-entity-resolution.md)| This guide provides instructions for integrating with the UID2 framework using AWS Entity Resolution. |
85
86
| Integration steps for organizations that collect user data and push it to other UID2 participants, using UID2 HTTP endpoints only |[Advertiser/Data Provider Integration to HTTP Endpoints](../guides/integration-advertiser-dataprovider-endpoints.md)| This guide covers integration steps for advertisers and data providers to integrate with UID2 by writing code to call UID2 HTTP endpoints, rather than using another implementation option such as an SDK, Snowflake, or AWS Entity Resolution. |
86
87
| Integration steps for advertisers and data providers who want to use the client-side JavaScript SDK for adding a UID2 token to their tracking pixels. |[Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)| This guide provides instructions for generating UID2 tokens (advertising tokens) using only JavaScript client-side changes.<!-- UID2_only: Not applicable for EUID -->|
Copy file name to clipboardExpand all lines: docs/summary-doc-v2.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,5 +18,5 @@ For details on using the API, see the following pages.
18
18
| :--- | :--- |
19
19
|[Encrypting Requests and Decrypting Responses](getting-started/gs-encryption-decryption.md)| The high-level request-response workflow for the UID2 APIs, requirements for encrypting requests and decrypting responses, and respective script examples in different programming languages. |
20
20
|[Endpoints](endpoints/summary-endpoints.md)| The API reference for managing identity tokens and mapping email addresses, phone numbers, or hashes to their UID2s and salt bucket IDs used to generate the UID2s.<br/>NOTE: The integration environment and the production environment require different [API keys](ref-info/glossary-uid.md#gl-api-key). |
21
-
|[Integration Guides](guides/summary-guides.md)| The UID2 integration workflows for UID2 participants, such as publishers, DSPs, advertisers, and data providers, as well as Operator Enterprise Partners, such as Microsoft Azure, AWS, and Snowflake. |
21
+
|[Integration Guides](guides/summary-guides.md)| The UID2 integration workflows for UID2 participants, such as publishers, DSPs, advertisers, and data providers, as well as Operator Enterprise Partners, such as Microsoft Azure, AWS, Snowflake, and Databricks. |
22
22
|[SDKs](sdks/summary-sdks.md)| Links to documentation for using UID2 SDKs. |
0 commit comments