diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e482ee98f..4e591b3b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,14 @@ npm run build This command generates static content into the `build` directory and can be served using any static contents hosting service. +## Build All Languages + +``` +npm run build && npm run serve +``` + +This command generates static content in all supported languages into the `build` directory and serves it to `http://localhost:3006/`. + ## Deployment -Whenever the `main` branch is updated, it will trigger the [Deploy to GitHub Pages](https://github.com/IABTechLab/uid2docs/actions/workflows/deploy.yml) workflow, which will automatically build the site and update the deployment. +Whenever the `main` branch is updated, it triggers the [Deploy to GitHub Pages](https://github.com/IABTechLab/uid2docs/actions/workflows/deploy.yml) workflow, which automatically builds the site and updates the deployment. diff --git a/README.md b/README.md index 6c752d9af..a23b23133 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -The content on this page has been moved. The new location is on the Unified ID website: [Unified ID 2.0 Overview](https://unifiedid.com/docs/intro). +# UID2 Documentation -Follow one of these links for the information you're looking for: +>Note: The new location for viewing UID2 documentation content is on the Unified ID website: [Unified ID 2.0 Overview](https://unifiedid.com/docs/intro). -- [Unified ID 2.0 Overview on the Unified ID website](https://unifiedid.com/docs/intro) -- [UID2 API v1 to v2 Upgrade Guide in GitHub](api/v2/upgrades/upgrade-guide.md) -- [Unified ID 2.0 Overview in Japanese](README-ja.md) -- [Information about how to contribute to the repository](CONTRIBUTING.md) +This repository contains all the content files and supporting site infrastructure for the [Unified ID 2.0 website](https://unifiedid.com). Site content is available in the following languages: + +- English (US) +- Japanese + +For information about build tools and about contributing to this repository, see [CONTRIBUTING.md](CONTRIBUTING.md). \ No newline at end of file diff --git a/api/README.md b/api/README.md deleted file mode 100644 index 310cfa0ae..000000000 --- a/api/README.md +++ /dev/null @@ -1,11 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Getting Started](https://unifiedid.com/docs/category/getting-started). - -Specific links: - -* [Contact Info](https://unifiedid.com/docs/getting-started/gs-account-setup#contact-info) -* [API Versions](https://unifiedid.com/docs/getting-started/gs-account-setup#api-versions) -* [Email Address Normalization](https://unifiedid.com/docs/getting-started/gs-normalization-encoding#email-address-normalization) -* [Email Address Hash Encoding](https://unifiedid.com/docs/getting-started/gs-normalization-encoding#email-address-hash-encoding) -* [Phone Number Normalization](https://unifiedid.com/docs/getting-started/gs-normalization-encoding#phone-number-normalization) -* [Phone Number Hash Encoding](https://unifiedid.com/docs/getting-started/gs-normalization-encoding#phone-number-hash-encoding) -* [License](https://unifiedid.com/docs/getting-started/gs-account-setup#license) diff --git a/api/v2/README.md b/api/v2/README.md deleted file mode 100644 index c81e8073f..000000000 --- a/api/v2/README.md +++ /dev/null @@ -1,7 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 API v2 Documentation](https://unifiedid.com/docs/summary-doc-v2). - -Specific links: - -* [Details on using the API](https://unifiedid.com/docs/summary-doc-v2) -* [Environments](https://unifiedid.com/docs/getting-started/gs-environments) -* [Authentication and Authorization](https://unifiedid.com/docs/getting-started/gs-auth) diff --git a/api/v2/endpoints/README.md b/api/v2/endpoints/README.md deleted file mode 100644 index a83cfc1ef..000000000 --- a/api/v2/endpoints/README.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 Endpoints](https://unifiedid.com/docs/endpoints/summary-endpoints). diff --git a/api/v2/endpoints/post-identity-buckets.md b/api/v2/endpoints/post-identity-buckets.md deleted file mode 100644 index 25b523374..000000000 --- a/api/v2/endpoints/post-identity-buckets.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [POST /identity/buckets](https://unifiedid.com/docs/endpoints/post-identity-buckets). diff --git a/api/v2/endpoints/post-identity-map.md b/api/v2/endpoints/post-identity-map.md deleted file mode 100644 index 88e60d23c..000000000 --- a/api/v2/endpoints/post-identity-map.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [POST /identity/map](https://unifiedid.com/docs/endpoints/post-identity-map). diff --git a/api/v2/endpoints/post-token-generate.md b/api/v2/endpoints/post-token-generate.md deleted file mode 100644 index 20a51a47a..000000000 --- a/api/v2/endpoints/post-token-generate.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [POST /token/generate](https://unifiedid.com/docs/endpoints/post-token-generate). diff --git a/api/v2/endpoints/post-token-refresh.md b/api/v2/endpoints/post-token-refresh.md deleted file mode 100644 index d8d2798a6..000000000 --- a/api/v2/endpoints/post-token-refresh.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [POST /token/refresh](https://unifiedid.com/docs/endpoints/post-token-refresh). diff --git a/api/v2/endpoints/post-token-validate.md b/api/v2/endpoints/post-token-validate.md deleted file mode 100644 index 12b732872..000000000 --- a/api/v2/endpoints/post-token-validate.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [POST /token/validate](https://unifiedid.com/docs/endpoints/post-token-validate). diff --git a/api/v2/endpoints/summary-endpoints.md b/api/v2/endpoints/summary-endpoints.md deleted file mode 100644 index a83cfc1ef..000000000 --- a/api/v2/endpoints/summary-endpoints.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 Endpoints](https://unifiedid.com/docs/endpoints/summary-endpoints). diff --git a/api/v2/getting-started/gs-encryption-decryption.md b/api/v2/getting-started/gs-encryption-decryption.md deleted file mode 100644 index 8848dd231..000000000 --- a/api/v2/getting-started/gs-encryption-decryption.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Encrypting Requests and Decrypting Responses](https://unifiedid.com/docs/getting-started/gs-encryption-decryption). diff --git a/api/v2/getting-started/gs-faqs.md b/api/v2/getting-started/gs-faqs.md deleted file mode 100644 index c5a9c1985..000000000 --- a/api/v2/getting-started/gs-faqs.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Frequently Asked Questions](https://unifiedid.com/docs/getting-started/gs-faqs). diff --git a/api/v2/guides/README.md b/api/v2/guides/README.md deleted file mode 100644 index 8de46a150..000000000 --- a/api/v2/guides/README.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 Integration Guides](https://unifiedid.com/docs/guides/summary-guides). diff --git a/api/v2/guides/advertiser-dataprovider-guide.md b/api/v2/guides/advertiser-dataprovider-guide.md deleted file mode 100644 index d8495027f..000000000 --- a/api/v2/guides/advertiser-dataprovider-guide.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Advertiser/Data Provider Integration Guide](https://unifiedid.com/docs/guides/advertiser-dataprovider-guide). diff --git a/api/v2/guides/custom-publisher-integration.md b/api/v2/guides/custom-publisher-integration.md deleted file mode 100644 index 670235b00..000000000 --- a/api/v2/guides/custom-publisher-integration.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Publisher Integration Guide, Server-Only (Without SDK)](https://unifiedid.com/docs/guides/custom-publisher-integration). diff --git a/api/v2/guides/dsp-guide.md b/api/v2/guides/dsp-guide.md deleted file mode 100644 index 5ae212594..000000000 --- a/api/v2/guides/dsp-guide.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [DSP Integration Guide](https://unifiedid.com/docs/guides/dsp-guide). diff --git a/api/v2/guides/google-ss-integration.md b/api/v2/guides/google-ss-integration.md deleted file mode 100644 index 56c1bcde4..000000000 --- a/api/v2/guides/google-ss-integration.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Google Ad Manager Secure Signals Integration Guide](https://unifiedid.com/docs/guides/google-ss-integration). diff --git a/api/v2/guides/images/cloudformation-step-2-2.png b/api/v2/guides/images/cloudformation-step-2-2.png deleted file mode 100644 index 90dc70f1d..000000000 Binary files a/api/v2/guides/images/cloudformation-step-2-2.png and /dev/null differ diff --git a/api/v2/guides/images/cloudformation-step-2.png b/api/v2/guides/images/cloudformation-step-2.png deleted file mode 100644 index 1f72a3c94..000000000 Binary files a/api/v2/guides/images/cloudformation-step-2.png and /dev/null differ diff --git a/api/v2/guides/images/cloudformation-step-3.png b/api/v2/guides/images/cloudformation-step-3.png deleted file mode 100644 index 8053fda94..000000000 Binary files a/api/v2/guides/images/cloudformation-step-3.png and /dev/null differ diff --git a/api/v2/guides/images/resource/advertiser-flow-mermaid.md b/api/v2/guides/images/resource/advertiser-flow-mermaid.md deleted file mode 100644 index 28e34cd14..000000000 --- a/api/v2/guides/images/resource/advertiser-flow-mermaid.md +++ /dev/null @@ -1,17 +0,0 @@ - sequenceDiagram - participant DP as Data Provider - participant UID2 as UID2 Service - participant DSP - loop 1. Retrieve a UID2 for DII using the identity map endpoints. - DP->>UID2: 1-a. Send a request containing DII to the identity mapping endpoints. - UID2->>DP: 1-b. Store the UID2 and salt bucket returned from the identity mapping service. - end - DP-->>DSP: 2. Send stored UID2s to DSPs to create audiences. - loop 3. Monitor for salt bucket rotations related to your stored UID2s. - DP->>UID2: 3-a. Monitor salt bucket rotations using the bucket service. - UID2->>DP: 3-b. Return salt buckets rotated since a given timestamp. - DP->>UID2: 3-c. Compare the rotated salt buckets to stored UID2 salt buckets.
If rotated, resend DII to identity mapping service for a new UID2. - UID2->>DP: 3-d. Store the UID2 and salt bucket returned from the identity mapping service. - end - - diff --git a/api/v2/guides/images/resource/advertiser-flow-mermaid.png b/api/v2/guides/images/resource/advertiser-flow-mermaid.png deleted file mode 100644 index 5933aa9ba..000000000 Binary files a/api/v2/guides/images/resource/advertiser-flow-mermaid.png and /dev/null differ diff --git a/api/v2/guides/images/resource/custom-publisher-flow-mermaid.md b/api/v2/guides/images/resource/custom-publisher-flow-mermaid.md deleted file mode 100644 index 509b75fb9..000000000 --- a/api/v2/guides/images/resource/custom-publisher-flow-mermaid.md +++ /dev/null @@ -1,49 +0,0 @@ - sequenceDiagram - participant U as User - participant P as Publisher - participant UID2 as UID2 Service - participant SSP - Note over U,SSP: 1. Establish Identity - U->>+P: 1-a. The user visits a publisher asset. - P->>-U: 1-b. The publisher explains the value exchange of the open internet and requests a login. - activate U - U->>P: 1-c. The user authenticates and authorizes the creation of a UID2. - deactivate U - activate P - P->>UID2: 1-d. The publisher sends the user's DII to the token generation service. - deactivate P - activate UID2 - UID2->>P: 1-e. The token generation service returns UID2 tokens. - deactivate UID2 - activate P - P->>U: 1-f. The publisher sets a UID2 for the user. - deactivate P - Note over U,SSP: 2. Bid Using UID2 Tokens - - P->>SSP: 2-a. The publisher calls the SSP for ads using the UID2 token. - activate SSP - SSP->>P: 2-b. The SSP returns ads to display. - deactivate SSP - activate P - P->>U: 2-c. The publisher displays the ads to the user. - deactivate P - - Note over U,SSP: 3. Refresh Tokens - U->>P: 3-a. The user returns to a publisher asset. - activate P - P->>UID2: 3-b. The publisher uses a refresh token to request new identity tokens for the user. - deactivate P - activate UID2 - UID2->>P: 3-c. If a user hasn't opted out, the refresh token service returns new identity tokens. - deactivate UID2 - activate P - P->>U: 3-d. The publisher sets the new UID2 for the user. - deactivate P - - Note over U,SSP: 4. User Logout - U->>P: 4-a. The user logs out from a publisher asset. - activate P - P->>U: 4-b. The user's identity clears. - deactivate P - - \ No newline at end of file diff --git a/api/v2/guides/images/resource/custom-publisher-flow-mermaid.md.svg b/api/v2/guides/images/resource/custom-publisher-flow-mermaid.md.svg deleted file mode 100644 index 5f5766631..000000000 --- a/api/v2/guides/images/resource/custom-publisher-flow-mermaid.md.svg +++ /dev/null @@ -1 +0,0 @@ -UserPublisherUID ServiceSSP1 Visits2 Authenticates3-1 Generate UID23-2 UID2 Tokens Returned4-1 Calling SSP for Ads4-2 Ads Displayed to User5-1 Revisits Publisher5-2 Refresh UID2 TokensRefreshed UID2 Tokens6 User LogoutUserPublisherUID ServiceSSP \ No newline at end of file diff --git a/api/v2/guides/images/resource/custom-publisher-flow-mermaid.png b/api/v2/guides/images/resource/custom-publisher-flow-mermaid.png deleted file mode 100644 index b67f7223e..000000000 Binary files a/api/v2/guides/images/resource/custom-publisher-flow-mermaid.png and /dev/null differ diff --git a/api/v2/guides/images/resource/dsp-guide-flow-mermaid.md b/api/v2/guides/images/resource/dsp-guide-flow-mermaid.md deleted file mode 100644 index 4673daee0..000000000 --- a/api/v2/guides/images/resource/dsp-guide-flow-mermaid.md +++ /dev/null @@ -1,20 +0,0 @@ - sequenceDiagram - participant U as User - participant SSP - participant DSP - participant UID2 as UID2 Service - participant TC as Transparency & Control Portal - Note over U,TC: 1. Honor user opt-outs. - U->>TC: 1-a. User opts out. - activate TC - TC->>UID2: 1-b. UID2 service receives opt-out. - deactivate TC - activate UID2 - UID2->>DSP: 1-c. DSP receives opt-out. - deactivate UID2 - Note over U,TC: 2. Decrypt UID2 tokens to use in RTB. - SSP-->>DSP: The SSP calls a DSP for bid. - DSP->>DSP: 2-a. Decrypt UID2 tokens. - DSP->>DSP: 2-b. Execute bidding logic, honoring user opt-outs from 1. - - \ No newline at end of file diff --git a/api/v2/guides/images/resource/dsp-guide-flow-mermaid.png b/api/v2/guides/images/resource/dsp-guide-flow-mermaid.png deleted file mode 100644 index c496bd28e..000000000 Binary files a/api/v2/guides/images/resource/dsp-guide-flow-mermaid.png and /dev/null differ diff --git a/api/v2/guides/images/resource/dsp-guide-optout-check-mermaid.md b/api/v2/guides/images/resource/dsp-guide-optout-check-mermaid.md deleted file mode 100644 index 6d8b8b930..000000000 --- a/api/v2/guides/images/resource/dsp-guide-optout-check-mermaid.md +++ /dev/null @@ -1,7 +0,0 @@ -graph LR -A[Decrypt UID2 Token] --> B[Retrieve Opt-out for UID2] - B --> C{Check Opt-out} - C --> |Opted Out| D[Bid without UID2] - C --> |Not Opted Out| E[Bid with UID2] - - diff --git a/api/v2/guides/images/resource/dsp-guide-optout-check-mermaid.png b/api/v2/guides/images/resource/dsp-guide-optout-check-mermaid.png deleted file mode 100644 index d83f78c96..000000000 Binary files a/api/v2/guides/images/resource/dsp-guide-optout-check-mermaid.png and /dev/null differ diff --git a/api/v2/guides/images/resource/publisher-flow-mermaid.md b/api/v2/guides/images/resource/publisher-flow-mermaid.md deleted file mode 100644 index 80ac0a841..000000000 --- a/api/v2/guides/images/resource/publisher-flow-mermaid.md +++ /dev/null @@ -1,42 +0,0 @@ - sequenceDiagram - participant U as User - participant P as Publisher - participant UID2 as UID2 Service - participant SSP - Note over U,SSP: 1. Establish Identity - U->>+P: 1-a. The user visits a publisher asset. - P->>-U: 1-b. The publisher explains the value exchange of the open internet and requests a login. - activate U - U->>P: 1-c. The user authenticates and authorizes the creation of a UID2. - deactivate U - activate P - P->>UID2: 1-d. The publisher sends the user's DII to the token generation service. - deactivate P - activate UID2 - UID2->>P: 1-e. The token generation service returns UID2 tokens. - deactivate UID2 - activate P - P->>U: 1-f. The publisher sets a UID2 for the user. - deactivate P - Note over U,SSP: 2. Bid Using UID2 Tokens - - P->>SSP: 2-a. The publisher calls the SSP for ads using the UID2 token. - activate SSP - SSP->>P: 2-b. The SSP returns ads to display. - deactivate SSP - activate P - P->>U: 2-c. The publisher displays the ads to the user. - deactivate P - - Note over U,SSP: 3. Refresh Tokens - U->>UID2: 3-a. The SDK sends a request to refresh the UID2 using the refresh token. - activate UID2 - UID2->>U: 3-b. If a user hasn't opted out, the refresh token service returns new identity tokens. - deactivate UID2 - Note over U,SSP: 4. User Logout - U->>P: 4-a. The user logs out from a publisher asset. - activate P - P->>U: 4-b. The user's identity clears. - deactivate P - - \ No newline at end of file diff --git a/api/v2/guides/images/resource/publisher-flow-mermaid.png b/api/v2/guides/images/resource/publisher-flow-mermaid.png deleted file mode 100644 index f7b87e599..000000000 Binary files a/api/v2/guides/images/resource/publisher-flow-mermaid.png and /dev/null differ diff --git a/api/v2/guides/images/resource/stack-creation-events.png b/api/v2/guides/images/resource/stack-creation-events.png deleted file mode 100644 index 1fdc8778b..000000000 Binary files a/api/v2/guides/images/resource/stack-creation-events.png and /dev/null differ diff --git a/api/v2/guides/images/resource/uid2-private-operator-aws-chart.jpeg b/api/v2/guides/images/resource/uid2-private-operator-aws-chart.jpeg deleted file mode 100644 index de98320e8..000000000 Binary files a/api/v2/guides/images/resource/uid2-private-operator-aws-chart.jpeg and /dev/null differ diff --git a/api/v2/guides/images/resource/uid2-private-operator-aws-chart.png b/api/v2/guides/images/resource/uid2-private-operator-aws-chart.png deleted file mode 100644 index a1730d72f..000000000 Binary files a/api/v2/guides/images/resource/uid2-private-operator-aws-chart.png and /dev/null differ diff --git a/api/v2/guides/images/stack-creation-resources.png b/api/v2/guides/images/stack-creation-resources.png deleted file mode 100644 index e4aaf4b96..000000000 Binary files a/api/v2/guides/images/stack-creation-resources.png and /dev/null differ diff --git a/api/v2/guides/images/uid2-private-operator-aws-chart.svg b/api/v2/guides/images/uid2-private-operator-aws-chart.svg deleted file mode 100644 index 6d437660a..000000000 --- a/api/v2/guides/images/uid2-private-operator-aws-chart.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
Availability Zone A
Availability Zone A
Availability Zone B
Availability Zone B
VPC
VPC
AWS Cloud
AWS Cloud
Internet Gateway
Internet...
Public Subnet 2
Public Subnet 2
Public Subnet 1
Public Subnet 1
DNS Resolution
DNS Reso...
UID2 Operators
UID2 Opera...
UID2 Operators
UID2 Opera...
UID2 Core Service
UID2 Cor...
Key and Optout Store
Key and O...
Auto
Scaling
Auto...Text is not SVG - cannot display \ No newline at end of file diff --git a/api/v2/guides/images/uid2-snowflake-integration-architecture.svg b/api/v2/guides/images/uid2-snowflake-integration-architecture.svg deleted file mode 100644 index 005e2133f..000000000 --- a/api/v2/guides/images/uid2-snowflake-integration-architecture.svg +++ /dev/null @@ -1,3 +0,0 @@ - - -

ETL-ed data
ETL-ed dat...
Data
Data
...
...
...
...
Partner Snowflake Account
Partner Snowflake Account
Enriched
Enriched
data
data
...
...
Query
Query
...
...
...
...
UID2 Snowflake Account
UID2 Snowflake Account
Private
functions
Private...
Background refresh tasks
Background refre...Private Tables
Shared functions and views
Shared functions...
UID2 Share
UID2 Share
UID2 Core / Opt-Out Cloud Setup
UID2 Core / Opt-Out Cloud Setup
UID2 Core
UID2 Core
UID2 Opt-Out
UID2 Opt-Out
UID2 Snowflake ETL
UID2 Snowflake E...

UID2 Service data
UID2 Servi...
UID2 Operator
UID2 Operator
UID2 Operator Services Setup
UID2 Operator Services SetupViewer does not support full SVG 1.1 \ No newline at end of file diff --git a/api/v2/guides/operator-guide-aws-marketplace.md b/api/v2/guides/operator-guide-aws-marketplace.md deleted file mode 100644 index 8048dc1c7..000000000 --- a/api/v2/guides/operator-guide-aws-marketplace.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 Private Operator for AWS Integration Guide](https://unifiedid.com/docs/guides/operator-guide-aws-marketplace). diff --git a/api/v2/guides/operator-guide-azure-enclave.md b/api/v2/guides/operator-guide-azure-enclave.md deleted file mode 100644 index e13137ebd..000000000 --- a/api/v2/guides/operator-guide-azure-enclave.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 Private Operator for Azure Integration Guide](https://unifiedid.com/docs/guides/operator-guide-azure-enclave). diff --git a/api/v2/guides/publisher-client-side.md b/api/v2/guides/publisher-client-side.md deleted file mode 100644 index 074d93562..000000000 --- a/api/v2/guides/publisher-client-side.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 SDK for JavaScript Integration Guide](https://unifiedid.com/docs/guides/publisher-client-side). diff --git a/api/v2/guides/snowflake_integration.md b/api/v2/guides/snowflake_integration.md deleted file mode 100644 index b57d92ce7..000000000 --- a/api/v2/guides/snowflake_integration.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Snowflake Integration Guide](https://unifiedid.com/docs/guides/snowflake_integration). diff --git a/api/v2/guides/summary-guides.md b/api/v2/guides/summary-guides.md deleted file mode 100644 index 8de46a150..000000000 --- a/api/v2/guides/summary-guides.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 Integration Guides](https://unifiedid.com/docs/guides/summary-guides). diff --git a/api/v2/sdks/README.md b/api/v2/sdks/README.md deleted file mode 100644 index 4f683c35c..000000000 --- a/api/v2/sdks/README.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [SDKs](https://unifiedid.com/docs/sdks/summary-sdks). diff --git a/api/v2/sdks/client-side-identity.md b/api/v2/sdks/client-side-identity.md deleted file mode 100644 index 58e69bd03..000000000 --- a/api/v2/sdks/client-side-identity.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 SDK for JavaScript Reference Guide](https://unifiedid.com/docs/sdks/client-side-identity). diff --git a/api/v2/sdks/dsp-client-v1-overview.md b/api/v2/sdks/dsp-client-v1-overview.md deleted file mode 100644 index 8081fdba4..000000000 --- a/api/v2/sdks/dsp-client-v1-overview.md +++ /dev/null @@ -1,8 +0,0 @@ -This page has been moved. The new location is on the Unified ID website. - -Choose the applicable SDK guide out of the following: - -- [UID2 SDK for C#/.NET (Server-Side) Reference Guide](https://unifiedid.com/docs/sdks/uid2-sdk-ref-csharp-dotnet) -- [UID2 SDK for C++ (Server-Side) Reference Guide](https://unifiedid.com/docs/sdks/uid2-sdk-ref-cplusplus) -- [UID2 SDK for Java (Server-Side) Reference Guide](https://unifiedid.com/docs/sdks/uid2-sdk-ref-java) -- [UID2 SDK for Python (Server-Side) Reference Guide](https://unifiedid.com/docs/sdks/uid2-sdk-ref-python) diff --git a/api/v2/sdks/images/uid2-js-sdk-workflow.svg b/api/v2/sdks/images/uid2-js-sdk-workflow.svg deleted file mode 100644 index 6eac708f7..000000000 --- a/api/v2/sdks/images/uid2-js-sdk-workflow.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
No identity
No identity
Identity is
successfully refreshed
Identity is...
No identity
No identity
init()
init()
Identity is valid,
no refresh is needed
Identity is valid,...
Identity is
successfully refreshed
Identity is...
No identity
No identity
Initialization
getAdvertisingToken() -> undefined
isLoginRequired() -> undefined
Initialization...
Identity Is Available
getAdvertisingToken() -> <valid>
isLoginRequired() -> false
Identity Is Available...
REFRESHED
REFRESHED
ESTABLISHED
ESTABLISHED
NO_IDENTITY
NO_IDENTITY
REFRESH_EXPIRED
REFRESH_EXPIRED
OPTOUT
OPTOUT
EXPIRED
EXPIRED
INVALID
INVALID
Identity Is Not Available
getAdvertisingToken() -> undefined
isLoginRequired() -> true
Identity Is Not Available...
Identity Is Temporarily Unavailable
getAdvertisingToken() -> undefined
isLoginRequired() -> false
Identity Is Temporarily Unavailable...
Identity has expired,
auto-refresh failed
Identity has expired,...Viewer does not support full SVG 1.1 \ No newline at end of file diff --git a/api/v2/sdks/summary-sdks.md b/api/v2/sdks/summary-sdks.md deleted file mode 100644 index 4f683c35c..000000000 --- a/api/v2/sdks/summary-sdks.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [SDKs](https://unifiedid.com/docs/sdks/summary-sdks). diff --git a/api/v2/summary-doc-v2.md b/api/v2/summary-doc-v2.md deleted file mode 100644 index c81e8073f..000000000 --- a/api/v2/summary-doc-v2.md +++ /dev/null @@ -1,7 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [UID2 API v2 Documentation](https://unifiedid.com/docs/summary-doc-v2). - -Specific links: - -* [Details on using the API](https://unifiedid.com/docs/summary-doc-v2) -* [Environments](https://unifiedid.com/docs/getting-started/gs-environments) -* [Authentication and Authorization](https://unifiedid.com/docs/getting-started/gs-auth) diff --git a/api/v2/upgrades/upgrade-guide.md b/api/v2/upgrades/upgrade-guide.md deleted file mode 100644 index ecd705e6b..000000000 --- a/api/v2/upgrades/upgrade-guide.md +++ /dev/null @@ -1,157 +0,0 @@ -[UID2 Overview](../../../README.md) > [Getting Started](../../README.md) > [v2](../summary-doc-v2.md) > UID2 API v1 to v2 Upgrade Guide - -# UID2 API v1 to v2 Upgrade Guide - -This guide outlines the differences between the UID2 v1 and v2 APIs and explains how to upgrade to the v2 API. - -- [Improvements and Changes from Version 1](#improvements-and-changes-from-version-1) -- [Prerequisites and Timeline](#prerequisites-and-timeline) -- [Publisher Upgrade Workflow](#publisher-upgrade-workflow) -- [Advertiser and Data Provider Upgrade Workflow](#advertiser-and-data-provider-upgrade-workflow) -- [FAQs](#faqs) - -## Improvements and Changes from Version 1 - -The v2 updates to the UID2 API include the following: - -- [Application API layer encryption](../getting-started/gs-encryption-decryption.md) has been added. It provides E2E content protection and prevents sensitive UID2 information from leaking to a network operator or the UID2 service operator.
This also means that performing calls to the v2 endpoints requires encrypting the POST request body and decrypting the response. -- In addition to the client API key for [authentication](../summary-doc-v2.md#authentication-and-authorization), a client secret is now required for encrypting API requests and decrypting API responses. -- The HTTP request type of all GET endpoints in the UID2 API v1 has changed from GET to POST in the [UID2 API v2](../endpoints/summary-endpoints.md). -- No more query parameters are required in requests. The new POST methods take input parameters as the request body in JSON format. -- No URL-encoding of parameter values is required. -- The [POST /identity/map](../endpoints/post-identity-map.md) endpoint now retrieves UID2s and salt bucket IDs for one or multiple email addresses, phone numbers, or the respective hashes. - -See also [UID2 API v2 Documentation](../summary-doc-v2.md). - -## Prerequisites and Timeline - -Before you start the upgrade, be sure to review the following requirements: - -- To be able to authenticate to the UID2 endpoints, [contact the UID2 administrator](../../README.md#contact-info) and obtain a secret key for encrypting API requests and decrypting API responses. See also [Authentication and Authorization](../summary-doc-v2.md#authentication-and-authorization). -- You must complete your upgrade by **March 31, 2023**, when all v1 SDK files and endpoints, the v0 SDK files, and any unversioned endpoints will be deprecated and removed. - - -## Publisher Upgrade Workflow - -This section includes the following information about backward compatibility and upgrade steps for publishers: - -- [Backward Compatibility for Publishers](#backward-compatibility-for-publishers) -- [Upgrade Steps for Publishers](#upgrade-steps-for-publishers) - -### Backward Compatibility for Publishers - -You can upgrade calls to the token generation and refresh endpoints independently. Here's what you need to know: - - - You can pass refresh tokens returned by the v1 `GET /token/generate` or v1 `GET /token/refresh` endpoints to the v2 [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint, but responses will not be encrypted. - - The v2 [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint encrypts responses only for refresh tokens returned by the v2 [POST /token/generate](../endpoints/post-token-generate.md) or v2 [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints, with the assumption that the caller has the refresh response key returned by these endpoints. - - You can pass refresh tokens returned by the v2 [POST /token/generate](../endpoints/post-token-generate.md) or v2 [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint to the v1 `GET /token/refresh` endpoint, which never encrypts responses. - -The UID2 SDK for JavaScript v2 (see [UID2 SDK for JavaScript Reference Guide](../sdks/client-side-identity.md)) is a drop-in replacement for the UID2 SDK for JavaScript SDK v1. Here's what you need to know: - - The first-party cookie used for storing the user's identity is fully interoperable between the two versions of the SDK. This means that the UID2 SDK for JavaScript v2 can read v1 cookies and vice versa. - - The [v2 SDK init() function](../sdks/client-side-identity.md#initopts-object-void) accepts the identity object returned by the v1 `GET /token/generate` endpoint. - - The v1 SDK `init()` function accepts the identity object returned by the v2 [POST /token/generate](../endpoints/post-token-generate.md) endpoint. - -### Upgrade Steps for Publishers - -To upgrade to the UID API v2, complete the following steps: - -1. [Upgrade the UID2 SDK for JavaScript](#upgrade-the-uid2-sdk-for-javascript). -1. [Upgrade calls to the token generate endpoint](#upgrade-token-generation-calls). -1. (Required only for integrations that do not use the [UID2 SDK for JavaScript)](../sdks/client-side-identity.md): [Upgrade calls to the token refresh endpoint](#upgrade-token-refresh-calls). - -#### Upgrade the UID2 SDK for JavaScript - -To upgrade the UID2 SDK for JavaScript, you need to update the script that loads the SDK. Here's what you need to keep in mind during this step: - -- If you are using `version 0` of the UID2 SDK for JavaScript, be sure to upgrade to `version 1` of the SDK first. -- If you load the SDK from another location or hold a private copy of the SDK, be sure to update the locations accordingly. - -On your pages, update the script to load version 2 of the SDK instead of version 1. - -SDK version 1: - -```html - -``` - -SDK version 2: - -```html - -``` - -#### Upgrade Token Generation Calls - -As part of the upgrade, on the server side of your application, you must replace calls to the v1 `GET /token/generate` endpoint with calls to the v2 [POST /token/generate](../endpoints/post-token-generate.md) endpoint. - -Here's what you need to know and do: - -- Performing a [POST /token/generate](../endpoints/post-token-generate.md) call requires encrypting the request body and decrypting the response. For details and examples, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). -- The JSON response from the [POST /token/generate](../endpoints/post-token-generate.md) endpoint contains a new property: `refresh_response_key`. - - If you are using the UID2 SDK for JavaScript (see [UID2 SDK for JavaScript Reference Guide](../sdks/client-side-identity.md)), regardless of the version, you must pass this key to the `init()` function of the SDK along with other response properties. - - If you are not using the SDK and are storing the response data in custom storage (for example, a database or a custom first-party cookie), you must update the storage to store the refresh response key. - - No updates are required for any existing sessions that store refresh tokens returned by the v1 `GET /token/refresh` endpoint and do not have a corresponding refresh response key. These sessions will continue working as is. - -#### Upgrade Token Refresh Calls - ->NOTE: If you are using the [UID2 SDK for JavaScript Reference Guide](../sdks/client-side-identity.md) to refresh and manage tokens, no further action is required. - -If you refresh tokens either on server or on client side without using the SDK, keep in mind the following, when making requests to the v2 [POST /token/refresh](../endpoints/post-token-refresh.md) endpoint: - - - You can pass the returned refresh token without any modifications in the request body. - - Refresh tokens returned by the v2 endpoints are expected to have a `refresh_response_key` value returned together with the refresh token. This key is required for [decrypting the response](../getting-started/gs-encryption-decryption.md). - - If the response contains a new refresh token, you must save it along with the corresponding `refresh_response_key` value into the user's identity storage (for example, a database or a custom first-party cookie). - - Refresh tokens returned by the v1 endpoints do not have the associated `refresh_response_key`, so the response will not be encrypted. - -## Advertiser and Data Provider Upgrade Workflow - -- [Backward Compatibility for Advertisers and Data Providers](#backward-compatibility-for-advertisers-and-data-providers) -- [Upgrade Steps for Advertisers and Data Providers](#upgrade-steps-for-advertisers-and-data-providers) - - -### Backward Compatibility for Advertisers and Data Providers - -Here's what you need to know about upgrading to the UID2 API v2: - -- The v1 `GET /identity/map` endpoint for mapping a single user's directly identifying information (DII) to UID2 has been replaced with the v2 [POST /identity/map](../endpoints/post-identity-map.md) endpoint, which maps DII for single and multiple users. -- UID2s and bucket IDs returned by the v2 [POST /identity/map](../endpoints/post-identity-map.md) and [POST /identity/buckets](../endpoints/post-identity-buckets.md) endpoints are the same as those returned by the corresponding v1 endpoints. -- The [Snowflake Integration Guide](../guides/snowflake_integration.md) is not affected by the upgrade to the UID2 v2 API and requires no changes. - -### Upgrade Steps for Advertisers and Data Providers - -To upgrade to the UID API v2, replace calls to the following v1 endpoints with the corresponding v2 endpoints. - -| v1 Endpoint | v2 Endpoint | Comments | -| :--- |:--- |:--- | -| `GET /identity/buckets` | [POST /identity/buckets](../endpoints/post-identity-buckets.md) |The HTTP request type has changed. | -| `POST /identity/map` | [POST /identity/map](../endpoints/post-identity-map.md)| The v2 endpoint is identical to the v1 endpoint, except it also maps DII for single users. | -| `GET /identity/map` |[POST /identity/map](../endpoints/post-identity-map.md) |The HTTP request type has changed.
The new POST endpoint maps DII for single and multiple users. | - ->IMPORTANT: Performing calls to the UID2 API v2 requires encrypting the POST request body and decrypting the response. For details and examples, see [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md). - - -## FAQs - -### Do I have to do the upgrade? - -Yes. The UID2 API v2 is not compatible with UID2 API v1 and requires an upgrade. - -### What are the key differences between the old and new APIs? - -For details, see [Improvements and Changes from Version 1](#improvements-and-changes-from-version-1). - -### When can I start the upgrade? - -Any time, but be sure to complete it by March 31, 2023. - -### Can I continue using the v1 API and API keys? - -Yes. The v1 endpoints will be supported until March 31, 2023. After that date, all deprecated v1 SDK files and endpoints, the v0 SDK files, and any unversioned endpoints will be removed. Previously issued client API keys will be required for the v2 endpoints and will continue working with the v1 endpoints until their removal. - -### How do I obtain a client secret key for the new API? - -To obtain your secret key, [contact the UID2 administrator](../../README.md#contact-info). See also [Prerequisites and Timeline](#prerequisites-and-timeline). - -### How do I encrypt requests and decrypt responses? - -The [Encrypting Requests and Decrypting Responses](../getting-started/gs-encryption-decryption.md) page explains the workflow and provides examples in Python. diff --git a/workflows/images/UID2-workflows-ja.jpg b/workflows/images/UID2-workflows-ja.jpg deleted file mode 100644 index 3b0ebcfe9..000000000 Binary files a/workflows/images/UID2-workflows-ja.jpg and /dev/null differ diff --git a/workflows/images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg b/workflows/images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg deleted file mode 100644 index c32369d7c..000000000 Binary files a/workflows/images/UID2AdvertiserAndThirdPartyDataProviderWorkflow.jpg and /dev/null differ diff --git a/workflows/images/UID2BuySIdeDSPWorkflow.jpg b/workflows/images/UID2BuySIdeDSPWorkflow.jpg deleted file mode 100644 index 601aa19ab..000000000 Binary files a/workflows/images/UID2BuySIdeDSPWorkflow.jpg and /dev/null differ diff --git a/workflows/images/UID2PublisherAndSSPWorkflow.jpg b/workflows/images/UID2PublisherAndSSPWorkflow.jpg deleted file mode 100644 index 15e510f2c..000000000 Binary files a/workflows/images/UID2PublisherAndSSPWorkflow.jpg and /dev/null differ diff --git a/workflows/images/UID2Workflows.jpg b/workflows/images/UID2Workflows.jpg deleted file mode 100644 index f8078bd35..000000000 Binary files a/workflows/images/UID2Workflows.jpg and /dev/null differ diff --git a/workflows/images/user_trust_workflow.jpg b/workflows/images/user_trust_workflow.jpg deleted file mode 100644 index 3d025d3cc..000000000 Binary files a/workflows/images/user_trust_workflow.jpg and /dev/null differ diff --git a/workflows/workflow-overview-3p-data-provider.md b/workflows/workflow-overview-3p-data-provider.md deleted file mode 100644 index 9fe58f68e..000000000 --- a/workflows/workflow-overview-3p-data-provider.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Third-Party Data Provider Workflow Overview](https://unifiedid.com/docs/workflows/workflow-overview-3p-data-provider). diff --git a/workflows/workflow-overview-buy-side.md b/workflows/workflow-overview-buy-side.md deleted file mode 100644 index bc696b4b4..000000000 --- a/workflows/workflow-overview-buy-side.md +++ /dev/null @@ -1,2 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Buy-Side Workflow Overview](https://unifiedid.com/docs/workflows/workflow-overview-buy-side). - diff --git a/workflows/workflow-overview-opt-out.md b/workflows/workflow-overview-opt-out.md deleted file mode 100644 index 9861fc18a..000000000 --- a/workflows/workflow-overview-opt-out.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Opt-Out Workflow Overview](https://unifiedid.com/docs/getting-started/gs-opt-out.md#opt-out-workflow). diff --git a/workflows/workflow-overview-supply-side.md b/workflows/workflow-overview-supply-side.md deleted file mode 100644 index 5223de5d0..000000000 --- a/workflows/workflow-overview-supply-side.md +++ /dev/null @@ -1 +0,0 @@ -This page has been moved. The new location is on the Unified ID website: [Supply-Side Workflow Overview](https://unifiedid.com/docs/workflow-overview-supply-side).