Skip to content

Commit

Permalink
Merge pull request #731 from IABTechLab/gwh-APIDOCS-2634-03-uid2-mino…
Browse files Browse the repository at this point in the history
…r-edits

minor edits
  • Loading branch information
genwhittTTD authored Oct 18, 2024
2 parents 384a9f5 + dfbcfee commit a75a3f6
Show file tree
Hide file tree
Showing 21 changed files with 27 additions and 27 deletions.
4 changes: 2 additions & 2 deletions docs/getting-started/gs-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ For most participants, <Link href="../ref-info/glossary-uid#gl-public-operator">

The best choice depends on your unique scenario and needs. For more information to help you arrive at a decision, refer to the following:

1. [The UID2 Operator](../ref-info/ref-operators-public-private.md)
- [The UID2 Operator](../ref-info/ref-operators-public-private.md)

1. [UID2 Private Operator Integration Overview](../guides/integration-options-private-operator.md)
- [UID2 Private Operator Integration Overview](../guides/integration-options-private-operator.md)

## FAQs for Publishers

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/integration-aws-entity-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For a video presentation about integration with UID2 by using AWS Entity Resolut
The following table summarizes the functionality available with the AWS Entity Resolution integration.

| Encrypt Raw UID2 to UID2 Token | Decrypt UID2 Token to Raw UID2 | Generate UID2 Token from DII | Refresh UID2 Token | Map DII to Raw UID2s |
| :--- | :--- | :--- | :--- | :--- |
| :--- | :--- | :--- | :--- | :--- |
| No | No | No | No | Yes |

## Integration Summary
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/integration-options-publisher-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ The following table summarizes the advantages of each integration option.
(**GWH_KK don't like having two tables but I can't fit it all into one. Also the docs are different. Need input re the best docs to link to... SDK ref or integration guide?**)
| Option | Client/Server | Advantages | Documentation |
| :--- | :--- | :--- | :--- |
| :--- | :--- | :--- | :--- |
| Prebid.js 8.21.0 or later | Client | <ul><li>No server-side coding needed.</li><li>Fast and easy implementation.</li></ul> | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) |
| UID2 JavaScript SDK + Prebid.js 7.53.0 or later | Client | <ul><li>No need to upgrade to the latest Prebid.js version.</li><li>Easier to manage latency with a server-side implementation.</li><li>The JavaScript SDK takes care of generating and refreshing the token, and Prebid.js takes care of sending the token to the bidstream.</li></ul> | <ul><li>[Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md)</li><li>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md)</li></ul> |
| SDK for JavaScript | Server | <ul><li>The SDK takes care of generating and refreshing the token.</li><li>Coded in JavaScript.</li></ul> If you use JavaScript, and client-side implementation is not suitable for you, this is your best choice. | [SDK for JavaScript Reference Guide (2.x and earlier versions)](../sdks/sdk-ref-javascript-v2.md) |
Expand Down Expand Up @@ -252,7 +252,7 @@ For details, see:
| :--- | :--- | :--- | :--- |
| Prebid.js 8.21.0 or later<br/>[UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | Prebid.js 8.21.0 or later | Prebid.js 8.21.0 or later | Prebid.js 8.21.0 or later |
| UID2 JavaScript SDK + <br/>Prebid.js 7.53.0 or later | UID2 JS SDK<br/>[Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | UID2 JS SDK or Prebid.js 7.53.0 or later | Prebid.js 7.53.0 or later<br/>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) |
| SDK for JavaScript<ul><li>[Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md)</li><li>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)</li></ul> | JavaScript SDK | JavaScript SDK | Publisher's choice. For example, Prebid.js.<br/>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) |
| SDK for JavaScript<ul><li>[Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md)</li><li>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)</li></ul> | JavaScript SDK | JavaScript SDK | Publisher's choice. For example, Prebid.js.<br/>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) |
| SDK for Java<br/>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | [SDK for Java](../sdks/sdk-ref-java.md) | [SDK for Java](../sdks/sdk-ref-java.md)| Publisher's choice.<br/>Can be integrated with Prebid.js. |
| SDK for Python<br/> [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)| [SDK for Python](../sdks/sdk-ref-python.md) | [SDK for Python](../sdks/sdk-ref-python.md) | Publisher's choice.<br/>Can be integrated with Prebid.js. |
| GAM Secure Signals<br/> [xxx](integration-publisher-server-side.md)| [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) |
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/snowflake_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following listings for UID2 are available on the Snowflake marketplace:
The following table summarizes the functionality available with the UID2 Snowflake integration.

| 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 |
| :--- | :--- | :--- | :--- | :--- |
| :--- | :--- | :--- | :--- | :--- |
| &#9989; | &#9989; | &#8212;* | &#8212; | &#9989; |

*You cannot use Snowflake to generate a UID2 token directly from DII. However, you can convert DII to a raw UID2, and then encrypt the raw UID2 into a UID2 token.
Expand Down
4 changes: 2 additions & 2 deletions docs/portal/client-side-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ In the UID2 Portal, if you want to use an implementation option that generates U
| Value | Implementation Type | Details | Documentation Link |
| :--- | :--- | :---| :---|
| Key pair | All (web or mobile) | At least one. In your implementation, you'll share the public key. | [Subscription ID and Public Key](../getting-started/gs-credentials.md#subscription-id-and-public-key) |
| Domain | Web | At least one. Provide a complete list of your root-level domains. | [Client-Side Web Integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) |
| Mobile App ID | Mobile | Any IDs that apply to your mobile apps, such as Android App ID, iOS/tvOS Bundle ID, or iOS App Store ID. | [Client-Side Mobile Integrations](../getting-started/gs-account-setup.md#client-side-mobile-integrations) |
| Domain | Web | At least one. Provide a complete list of your root-level domains. | [Client-Side Web Integrations](../getting-started/gs-account-setup.md#client-side-web-integrations) |
| Mobile App ID | Mobile | Any IDs that apply to your mobile apps, such as Android App ID, iOS/tvOS Bundle ID, or iOS App Store ID. | [Client-Side Mobile Integrations](../getting-started/gs-account-setup.md#client-side-mobile-integrations) |

:::important
It's important to provide a complete list of root-level domain names for your sites, and mobile app IDs for your apps. This is a security measure, for client-side implementation only. If a domain or app is not defined in the UID2 Portal, UID2 token requests from that domain or app will fail.
Expand Down
2 changes: 1 addition & 1 deletion docs/portal/portal-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The integration options are shown in the following table.

| Integration | Examples | Instructions |
| :--- | :--- | :--- |
| Client-side integration | **Advertisers** generate UID2 tokens on the client side for tracking pixels.<br/>**Publishers** generate UID2 tokens on the client side for <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link> use. | Go to the **Client-Side Integration** page and set up key pairs and root-level domains. We use these to identify your transactions.<br/>For details, see [Client-Side Integration](client-side-integration.md). |
| Client-side integration | **Advertisers** generate UID2 tokens on the client side for tracking pixels.<br/>**Publishers** generate UID2 tokens on the client side for <Link href="../ref-info/glossary-uid#gl-bidstream">bidstream</Link> use. | Go to the **Client-Side Integration** page and set up key pairs and root-level domains. We use these to identify your transactions.<br/>For details, see [Client-Side Integration](client-side-integration.md). |
| Server-side integration | **Advertisers** generate raw UID2s to be delivered for audience targeting.<br/>**Publishers** generate UID2 tokens on the server side for bidstream use. | Go to the **API Keys** page and create at least one set of credentials. When you add an API key, you're assigned two values, a secret and a key, which you'll use in your implementation.<br/>For details, see [API Keys](api-keys.md). |

Some participants might use both client-side and server-side integration. For example, advertisers might generate UID2 tokens on the client side for pixels ([Client-Side Integration](client-side-integration.md)), but integrate on the server side for raw UID2 generation ([API Keys](api-keys.md)).
Expand Down
2 changes: 1 addition & 1 deletion docs/ref-info/ref-server-side-token-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ For security reasons, the API key and secret used in token generation *must* be
Options are summarized in the following table.

| Integration Solution  | Generate Token | Refresh Token |
| :--- | :--- | :--- |
| :--- | :--- | :--- |
| [SDK for Java](../sdks/sdk-ref-java.md) | ✅ ||
| [SDK for Python](../sdks/sdk-ref-python.md)|||
| [Direct integration (API endpoints with custom code)](../endpoints/post-token-generate.md) |||
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/sdk-ref-cplusplus.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Available information returned through the SDK is outlined in the following tabl
| `InvalidPayload` | The incoming UID2 advertising token is not a valid payload. |
| `ExpiredToken` | The incoming UID2 advertising token has expired. |
| `KeysNotSynced` | The client has failed to synchronize keys from the UID2 service. |
| `VersionNotSupported` | The client library does not support the version of the encrypted token. |
| `VersionNotSupported` | The client library does not support the version of the encrypted token. |
## Usage for UID2 Sharers
Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/sdk-ref-csharp-dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Whether decrypting with the `BidstreamClient` or the `SharingClient`, the SDK re
| `InvalidPayload` | The incoming UID2 token is not a valid payload. |
| `ExpiredToken` | The incoming UID2 token has expired. |
| `KeysNotSynced` | The client has failed to synchronize keys from the UID2 service. |
| `VersionNotSupported` | The client library does not support the version of the encrypted token. |
| `VersionNotSupported` | The client library does not support the version of the encrypted token. |

## Usage for DSPs

Expand Down
2 changes: 1 addition & 1 deletion docs/sdks/summary-sdks.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Review the SDK functionality to determine which SDK or SDKs you want to use, the
The following table summarizes the functionality available with each SDK.

| UID2 SDK for... | Client-Side or Server-Side | 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&ast; | Monitor Rotated Salt Buckets |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
|JavaScript | Client | &#8212; | &#8212; | &#9989; | &#9989; | &#8212; | &#8212; |
|Java | Server | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#8212; |
|Python | Server | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; | &#9989; |
Expand Down
2 changes: 1 addition & 1 deletion docs/sharing/sharing-tokenized-from-data-pixel.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Tokenized sharing in pixels is applicable to the following audiences:

Different participants might use pixels in different ways. The following table shows two common use cases for pixels in the advertising technology ecosystem.

| | Tracking Pixel | Creative Pixel |
| | Tracking Pixel | Creative Pixel |
| :--- | :--- | :--- |
| What it measures | Conversion/retargeting (user does something) | Impression (user sees an ad) |
| Where | Advertiser or publisher site | Publisher site via DSP |
Expand Down
2 changes: 1 addition & 1 deletion docs/sharing/sharing-tokenized-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Choose the integration option that's right for your implementation, and then cli
| Starting Point | Encryption Option/Scenario | Link to Details |
| :--- | :--- | :--- |
| DII | Sharing UID2 tokens from DII in the bidstream | [Tokenized Sharing in the Bidstream](sharing-tokenized-from-data-bid-stream.md) |
| DII | Sharing UID2 tokens from DII in tracking pixels | [Workflow: Tokenized Sharing in Tracking Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels) |
| DII | Sharing UID2 tokens from DII in tracking pixels | [Workflow: Tokenized Sharing in Tracking Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-tracking-pixels) |
| Raw UID2 | Sharing UID2 tokens from raw UID2s in creative pixels | [Workflow: Tokenized Sharing in Creative Pixels](sharing-tokenized-from-data-pixel.md#workflow-tokenized-sharing-in-creative-pixels) |
| Raw UID2 | Sharing UID2 tokens from raw UID2s using an SDK | [Implementing Sharing Encryption/Decryption with an SDK](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-with-an-sdk) |
| Raw UID2 | Sharing UID2 tokens from raw UID2s using Snowflake | [Implementing Sharing Encryption/Decryption Using Snowflake](sharing-tokenized-from-raw.md#implementing-sharing-encryptiondecryption-using-snowflake) |
Expand Down
2 changes: 1 addition & 1 deletion docs/snippets/_private-operator-release-matrix.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| Release | Version | Date | Release Notes | AWS Version | GCP Download | Azure Download |
| Release | Version | Date | Release Notes | AWS Version | GCP Download | Azure Download |
| ------- | ------ | ------ | ------ | ------ | ------ | ------ |
| Q1 2024 | 5.26.19 | February 13, 2024 | [v5.26.19-56899dc0d7](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.26.19-56899dc0d7) | 5.26.19-56899dc0d7 | [5.26.19-56899dc0d7 GCP ZIP](https://github.com/IABTechLab/uid2-operator/releases/download/v5.26.19-56899dc0d7/uid2-operator-deployment-artifacts-5.26.19-56899dc0d7-gcp-oidc.zip) | [5.26.19-56899dc0d7 Azure ZIP](https://github.com/IABTechLab/uid2-operator/releases/download/v5.26.19-56899dc0d7/uid2-operator-deployment-artifacts-5.26.19-56899dc0d7-azure-cc.zip) |
| Q2 2024 | 5.37.12 | June 12, 2024 | [v5.37.12](https://github.com/IABTechLab/uid2-operator/releases/tag/v5.37.12) | 5.37.12 | [gcp-oidc-deployment-files-5.37.12.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.37.12/gcp-oidc-deployment-files-5.37.12.zip) | [azure-cc-deployment-files-5.37.12.zip](https://github.com/IABTechLab/uid2-operator/releases/download/v5.37.12/azure-cc-deployment-files-5.37.12.zip) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ The following table summarizes the advantages of each integration option.
(**GWH_KK don't like having two tables but I can't fit it all into one. Also the docs are different. Need input re the best docs to link to... SDK ref or integration guide?**)
| Option | Client/Server | Advantages | Documentation |
| :--- | :--- | :--- | :--- |
| :--- | :--- | :--- | :--- |
| Prebid.js 8.21.0 or later | Client | <ul><li>No server-side coding needed.</li><li>Fast and easy implementation.</li></ul> | [UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) |
| UID2 JavaScript SDK + Prebid.js 7.53.0 or later | Client | <ul><li>No need to upgrade to the latest Prebid.js version.</li><li>Easier to manage latency with a server-side implementation.</li><li>The JavaScript SDK takes care of generating and refreshing the token, and Prebid.js takes care of sending the token to the bidstream.</li></ul> | <ul><li>[Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md)</li><li>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md)</li></ul> |
| SDK for JavaScript | Server | <ul><li>The SDK takes care of generating and refreshing the token.</li><li>Coded in JavaScript.</li></ul> If you use JavaScript, and client-side implementation is not suitable for you, this is your best choice. | [SDK for JavaScript Reference Guide (2.x and earlier versions)](../sdks/sdk-ref-javascript-v2.md) |
Expand Down Expand Up @@ -252,7 +252,7 @@ For details, see:
| :--- | :--- | :--- | :--- |
| Prebid.js 8.21.0 or later<br/>[UID2 Client-Side Integration Guide for Prebid.js](integration-prebid-client-side.md) | Prebid.js 8.21.0 or later | Prebid.js 8.21.0 or later | Prebid.js 8.21.0 or later |
| UID2 JavaScript SDK + <br/>Prebid.js 7.53.0 or later | UID2 JS SDK<br/>[Client-Side Integration Guide for JavaScript](integration-javascript-client-side.md) | UID2 JS SDK or Prebid.js 7.53.0 or later | Prebid.js 7.53.0 or later<br/>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) |
| SDK for JavaScript<ul><li>[Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md)</li><li>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)</li></ul> | JavaScript SDK | JavaScript SDK | Publisher's choice. For example, Prebid.js.<br/>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) |
| SDK for JavaScript<ul><li>[Client-Server Integration Guide for JavaScript](integration-javascript-client-server.md)</li><li>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)</li></ul> | JavaScript SDK | JavaScript SDK | Publisher's choice. For example, Prebid.js.<br/>[UID2 Client-Server Integration Guide for Prebid.js](integration-prebid-client-server.md) |
| SDK for Java<br/>[Publisher Integration Guide, Server-Side](integration-publisher-server-side.md) | [SDK for Java](../sdks/sdk-ref-java.md) | [SDK for Java](../sdks/sdk-ref-java.md)| Publisher's choice.<br/>Can be integrated with Prebid.js. |
| SDK for Python<br/> [Publisher Integration Guide, Server-Side](integration-publisher-server-side.md)| [SDK for Python](../sdks/sdk-ref-python.md) | [SDK for Python](../sdks/sdk-ref-python.md) | Publisher's choice.<br/>Can be integrated with Prebid.js. |
| GAM Secure Signals<br/> [xxx](integration-publisher-server-side.md)| [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) | [Google Ad Manager Secure Signals Integration Guide](integration-google-ss.md) |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -341,8 +341,8 @@ logrotate のドキュメントに従って指示に従ってください: [logr
| Action | Command |
| :--- | :--- |
| 何がローテーションされるかの詳細を提供します。 | `sudo logrotate -f /etc/logrotate.conf --debug` |
| スケジュールされた間隔を変更することなく、手動で `logrotate` を1回実行します。 | `sudo logrotate -f /etc/logrotate.conf --force` |
| `syslog-ng` をリロードします。 | `sudo /usr/sbin/syslog-ng-ctl reload` |
| スケジュールされた間隔を変更することなく、手動で `logrotate` を1回実行します。 | `sudo logrotate -f /etc/logrotate.conf --force` |
| `syslog-ng` をリロードします。 | `sudo /usr/sbin/syslog-ng-ctl reload` |

## Technical Support

Expand Down
Loading

0 comments on commit a75a3f6

Please sign in to comment.