| title | UID2 Endpoints - Summary |
|---|---|
| description | UID2 Service で利用可能なエンドポイントの概要。 |
| hide_table_of_contents | false |
| sidebar_position | 1 |
| displayed_sidebar | docs |
import Link from '@docusaurus/Link';
すべての UID2 エンドポイントでは、API リクエストの暗号化(POST /token/refresh を除く) とレスポンスの復号化にクライアントシークレットが必要です。詳細といくつかのプログラミング言語でのコードの例は、リクエストの暗号化とレスポンスの復号化 を参照してください。
以下のエンドポイントは、UID2 Token (identity tokens, advertising tokens) を取得および管理するためのもので、主にパブリッシャーが使用します。
| Endpoint | Description | Request Encryption | Response Decryption |
|---|---|---|---|
| POST /token/generate | ユーザーの DII (メールアドレスまたは電話番号) から UID2 Token を生成します。DII が有効で、ユーザーがUID2をオプトアウトしていない場合、UID2 Token と関連する値を返します。 | 必須 | 必須 |
| POST /token/validate | Advertising Token (UID2) が指定されたメールアドレス、電話番号、またはそれぞれのハッシュと一致するかどうかを検証するためのテストに使用します。 | 必須 | 必須 |
| POST /token/refresh | POST /token/generate レスポンスから、ユーザーの Refresh Token 用に新しいトークンを生成します。 | N/A | 必須 |
以下のエンドポイントは、広告主とサードパーティのデータプロバイダーが使用します。パブリッシャーは、これらのエンドポイントを使用する必要はありません。
| Endpoint | Description | Request Encryption | Response Decryption |
|---|---|---|---|
| POST /identity/buckets | 最後に更新されたタイムスタンプを使用して、ローテーションされたソルトバケットを監視します。 | 必須 | 必須 |
| POST /identity/map (v2) | 1 つ以上のメールアドレス、電話番号、またはそれぞれのハッシュの UID2 とソルトバケット ID を取得します。 | 必須 | 必須 |
以下のエンドポイントは、広告主、サードパーティのデータプロバイダー、DSP、共有者が使用できます。パブリッシャーは、このエンドポイントを使用する必要はありません。
UID2 の Opt-Out ワークフローとユーザーが Opt-Out する方法の詳細は、User Opt-Out を参照してください。
| Endpoint | Description | Request Encryption | Response Decryption |
|---|---|---|---|
| POST /optout/status | raw UID2 のオプトアウトステータスをチェックします。このエンドポイントは raw UID2 のリストを入力として受け取り、オプトアウトした raw UID2 と、オプトアウトが行われた時刻を返します。 | 必須 | 必須 |