Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gwh apidocs 1786 cstg minor mods #414

Merged
merged 4 commits into from
Jan 10, 2024
Merged
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
6 changes: 3 additions & 3 deletions docs/getting-started/gs-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ To authenticate to the UID2 endpoints in a server-side implementation, you need

- A client [API key](gs-credentials.md#api-key-and-client-secret). The API key is included as a bearer token in the request's Authorization header. For example:<br/>
`Authorization: Bearer YourTokenBV3tua4BXNw+HVUFpxLlGy8nWN6mtgMlIk=`
- A client secret for encrypting API requests and decrypting API responses. This is needed for all endpoints except [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md). <br/>For details and Python examples, see [Encrypting Requests and Decrypting Responses](gs-encryption-decryption.md).
- A client secret for encrypting API requests and decrypting API responses. This is needed for all endpoints except [POST&nbsp;/token/refresh](../endpoints/post-token-refresh.md). <br/>For details, and encryption/decryption examples in several different coding languages, see [Encrypting Requests and Decrypting Responses](gs-encryption-decryption.md).

:::note
If you're a publisher and are implementing UID2 on the client side, the authentication and authorization is managed automatically by your implementation, such as the Prebid.js implementation or JavaScript SDK implementation. (**GWH UPTOHERE WRITE THIS PROPERLY**)
:::
If you're a publisher and are implementing UID2 on the client side, the authentication and authorization is managed automatically by your implementation, such as Prebid.js (see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md)) or the JavaScript SDK (see [JavaScript Express Integration Guide](../guides/publisher-client-side.md)).
:::
2 changes: 1 addition & 1 deletion docs/getting-started/gs-encryption-decryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
# Encrypting Requests and Decrypting Responses

:::note
If you're a publisher and are implementing UID2 on the client side, this information doesn't apply to you. etc. implementation manages it... Tthe authentication and authorization is managed automatically by your implementation, such as the Prebid.js implementation or JavaScript SDK implementation. (**GWH UPTOHERE WRITE THIS PROPERLY**)
If you're a publisher and are implementing UID2 on the client side, encryption and decryption is by your implementation, such as Prebid.js (see [UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md)) or the JavaScript SDK (see [JavaScript Express Integration Guide](../guides/publisher-client-side.md)).
:::

For almost all UID2 [endpoints](../endpoints/summary-endpoints.md), requests sent to the endpoint must be [encrypted](#encrypting-requests) and responses from the endpoint must be [decrypted](#decrypting-responses).
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/integration-prebid-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This guide includes the following information:
- [Storing the UID2 Token in the Browser](#storing-the-uid2-token-in-the-browser)
- [When to Pass DII to the UID2 Module](#when-to-pass-dii-to-the-uid2-module)
- [Checking the Integration](#checking-the-integration)
- [Optional: Reduce Latency by Setting the API Base URL](#optional-reduce-latency-by-setting-the-api-base-url)
- [Optional: Reduce Latency by Setting the API Base URL for the Production Environment](#optional-reduce-latency-by-setting-the-api-base-url-for-the-production-environment)
-->

## Prebid.js Version
Expand Down Expand Up @@ -196,7 +196,7 @@ An example of a tool for validating and debugging Prebid.js configuration is Pro
- Documentation on prebid.org: [Professor Prebid User Guide](https://docs.prebid.org/tools/professor-prebid.html)

## Optional: Reduce Latency by Setting the API Base URL for the Production Environment
<!-- GWH "Reduce Latency by Setting the API Base URL" section is identical for client side and server side. -->
<!-- GWH "Optional: Reduce Latency by Setting the API Base URL for the Production Environment" section is identical for client side and server side. -->
By default, the UID2 module makes API calls to a UID2 server in the USA. Depending on where your users are based, you might consider choosing a server closer to your users to reduce latency.

To specify a different UID2 server when you're configuring the UID2 module, set the optional params.uid2ApiBase parameter, as shown in the following example:
Expand Down
6 changes: 3 additions & 3 deletions docs/guides/integration-prebid-server-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This guide includes the following information:
- [Configuration Parameters for userSync](#configuration-parameters-for-usersync)
- [Configuration Parameter Examples: Value](#configuration-parameter-examples-value)
- [Sample Token](#sample-token)
- [Optional: Reduce Latency by Setting the API Base URL](#optional-reduce-latency-by-setting-the-api-base-url)
- [Optional: Reduce Latency by Setting the API Base URL for the Production Environment](#optional-reduce-latency-by-setting-the-api-base-url-for-the-production-environment)
-->

This guide is for publishers who have access to [DII](../ref-info/glossary-uid.md#gl-dii) (email address or phone number) on the server side and want to integrate with UID2 and generate [UID2 tokens](../ref-info/glossary-uid.md#gl-uid2-token) (advertising tokens) to be passed by Prebid.js in the RTB bid stream.
Expand Down Expand Up @@ -381,8 +381,8 @@ The following sample is fictitious, but shows what the token response object, re
}
```

## Optional: Reduce Latency by Setting the API Base URL
<!-- GWH "Reduce Latency by Setting the API Base URL" section is identical for client side and server side. -->
## Optional: Reduce Latency by Setting the API Base URL for the Production Environment
<!-- GWH "Optional: Reduce Latency by Setting the API Base URL for the Production Environment" section is identical for client side and server side. -->
By default, the UID2 module makes API calls to a UID2 server in the USA. Depending on where your users are based, you might consider choosing a server closer to your users to reduce latency.

To specify a different UID2 server when you're configuring the UID2 module, set the optional params.uid2ApiBase parameter, as shown in the following example:
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/publisher-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ __uid2.init({
Tokens from the UID2 integration environment are not valid for passing to the bid stream. For the integration environment, you will have different **subscription ID** and **public key** values.
:::

### Optional: Reduce Latency by Setting the API Base URL
### Optional: Reduce Latency by Setting the API Base URL for the Production Environment

By default, in the production environment, the JS SDK makes API calls to a UID2 server in the USA. Depending on where your users are based, you might consider choosing a server closer to your users in order to reduce latency.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,6 @@ sidebar_position: 04

Prebid.js を使って UID2 とインテグレーションするには、サイトの HTML と JavaScript を変更する必要があります。このガイドに従えば、Server-Side の作業は必要ありません。

<!--
This guide includes the following information:

- [Prebid.js Version](#prebidjs-version)
- [Integration Example](#integration-example)
- [Integration Overview: High-Level Steps](#integration-overview-high-level-steps)
- [Complete UID2 Account Setup](#complete-uid2-account-setup)
- [Add Prebid.js to Your Site](#add-prebidjs-to-your-site)
- [Configure the UID2 Module](#configure-the-uid2-module)
- [Storing the UID2 Token in the Browser](#storing-the-uid2-token-in-the-browser)
- [When to Pass DII to the UID2 Module](#when-to-pass-dii-to-the-uid2-module)
- [Checking the Integration](#checking-the-integration)
- [Optional: Reduce Latency by Setting the API Base URL](#optional-reduce-latency-by-setting-the-api-base-url)
-->

## Prebid.js Version

この実装には Prebid.js version 8.21.0 以降が必要です。バージョン情報については、[https://github.com/prebid/Prebid.js/releases](https://github.com/prebid/Prebid.js/releases) を参照してください。
Expand Down Expand Up @@ -195,8 +180,8 @@ Prebid.js の設定を検証・デバッグするツールの例として、オ
- Chrome ウェブストアのダウンロード場所: [Professor Prebid](https://chromewebstore.google.com/detail/professor-prebid/kdnllijdimhbledmfdbljampcdphcbdc)
- prebid.org のドキュメント: [Professor Prebid User Guide](https://docs.prebid.org/tools/professor-prebid.html)

## Optional: Reduce Latency by Setting the API Base URL
<!-- GWH "Reduce Latency by Setting the API Base URL" section is identical for client side and server side. -->
## Optional: Reduce Latency by Setting the API Base URL for the Production Environment
<!-- GWH "Optional: Reduce Latency by Setting the API Base URL for the Production Environment" section is identical for client side and server side. -->
デフォルトでは、UID2 module はアメリカにある UID2 サーバーに API コールを行います。ユーザーの居住地によっては、レイテンシー(遅延時間)を短縮するために、ユーザーに近いサーバーを選択することを検討してください。

UID2 module を設定するときに別の UID2 サーバーを指定するには、次の例に示すように、オプションの `params.uid2ApiBase` パラメータを設定します:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,6 @@ sidebar_position: 04
---

# UID2 Server-Side Integration Guide for Prebid.js
<!--
This guide includes the following information:

- [Prebid.js Version](#prebidjs-version)
- [UID2 Prebid Module Page](#uid2-prebid-module-page)
- [Integration Overview: High-Level Steps](#integration-overview-high-level-steps)
- [Complete UID2 Account Setup](#complete-uid2-account-setup)
- [Add Prebid.js to Your Site](#add-prebidjs-to-your-site)
- [Configure the UID2 Module](#configure-the-uid2-module)
- [Generating a UID2 Token on the Server](#generating-a-uid2-token-on-the-server)
- [Client Refresh Mode](#client-refresh-mode)
- [Client Refresh Mode Response Configuration Options](#client-refresh-mode-response-configuration-options)
- [Client Refresh Mode Cookie Example](#client-refresh-mode-cookie-example)
- [Configuration](#configuration)
- [Client Refresh Mode uid2Token Example](#client-refresh-mode-uid2token-example)
- [Server-Only Mode](#server-only-mode)
- [Server-Only Mode Cookie Example](#server-only-mode-cookie-example)
- [Server-Only Mode Value Example](#server-only-mode-value-example)
- [Prebid Implementation Notes and Tips](#prebid-implementation-notes-and-tips)
- [Storing the UID2 Token in the Browser](#storing-the-uid2-token-in-the-browser)
- [When to Pass a New Token to the UID2 Module](#when-to-pass-a-new-token-to-the-uid2-module)
- [Passing a New Token: Client Refresh Mode](#passing-a-new-token-client-refresh-mode)
- [Passing a New Token: Server-Only Mode](#passing-a-new-token-server-only-mode)
- [Determining Whether the Module Has a Valid Token](#determining-whether-the-module-has-a-valid-token)
- [Checking the Integration](#checking-the-integration)
- [Configuration Parameters for userSync](#configuration-parameters-for-usersync)
- [Configuration Parameter Examples: Value](#configuration-parameter-examples-value)
- [Sample Token](#sample-token)
- [Optional: Reduce Latency by Setting the API Base URL](#optional-reduce-latency-by-setting-the-api-base-url)
-->

このガイドは、Server-Side で [DII](../ref-info/glossary-uid.md#gl-dii)(メールアドレスまたは電話番号) にアクセスでき、UID2 とインテグレーションして、RTB ビッドストリームで Prebid.js によって渡される [UID2 Token](../ref-info/glossary-uid.md#gl-uid2-token)(Advertising Token) を生成したいパブリッシャー向けのものです。

Expand Down Expand Up @@ -382,8 +352,8 @@ pbjs.setConfig({
}
```

## Optional: Reduce Latency by Setting the API Base URL
<!-- GWH "Reduce Latency by Setting the API Base URL" section is identical for client side and server side. -->
## Optional: Reduce Latency by Setting the API Base URL for the Production Environment
<!-- GWH "Optional: Reduce Latency by Setting the API Base URL for the Production Environment" section is identical for client side and server side. -->
デフォルトでは、UID2 module はアメリカにある UID2 サーバーに API コールを行います。ユーザーの居住地によっては、レイテンシー(遅延時間)を短縮するために、ユーザーに近いサーバーを選択することを検討してください。

UID2 module を設定するときに別の UID2 サーバーを指定するには、次の例に示すように、オプションの `params.uid2ApiBase` パラメータを設定します:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ __uid2.init({
UID2 テスト環境からのトークンは、ビッドストリームに渡しても無効です。テスト環境では、**subscription ID** と **public key** の値が異なります。
:::

### Optional: Reduce Latency by Setting the API Base URL
### Optional: Reduce Latency by Setting the API Base URL for the Production Environment

デフォルトでは、本番環境の JS SDK はアメリカにある UID2 サーバーに API コールを行います。ユーザーの所在地によっては、待ち時間を短縮するために、ユーザーに近いサーバーを選択することができます。

Expand Down