UID2 Endpoints: Summary

すべての UID2 エンドポイントでは、API リクエストの暗号化(POST /token/refresh を除く) とレスポンスの復号化にクライアントシークレットが必要です。詳細といくつかのプログラミング言語でのコードの例は、リクエストの暗号化とレスポンスの復号化を参照してください。

UID2 Tokens

以下のエンドポイントは、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	必須

以下のエンドポイントは、広告主とサードパーティのデータプロバイダーが使用します。パブリッシャーはこれらのエンドポイントを使用する必要はありません。

最新の Identity Map インテグレーションでは、1 つのエンドポイント POST /identity/map を呼び出すだけで済みます。POST /identity/buckets エンドポイントはワークフローの一部ではありません。

important

以前のバージョンを使用している場合は、改善点を活用するためにできるだけ早くアップグレードすることを推奨します。

最新の Identity Map インテグレーションでは、次のエンドポイントを使用します:

Endpoint	Description	Request Encryption	Response Decryption
POST /identity/map	1 つ以上のメールアドレス、電話番号、またはそのハッシュに対して、raw UID2、以前の raw UID2、および更新タイムスタンプをマップします。	必須	必須

以下のエンドポイントは、以前の Identity Map インテグレーション (バージョン 2) の一部です。

Endpoint	Description	Request Encryption	Response Decryption
POST /identity/buckets	ローテーションしたソルトバケットの最終更新タイムスタンプをモニターします。	必須	必須
POST /identity/map (v2)	1 つ以上のメールアドレス、電話番号、またはそれぞれのハッシュに対して、raw UID2 と salt bucket 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 と、オプトアウトが行われた時刻を返します。	必須	必須