UID2 credentials

UID2 の 参加者は、参加形態に応じて、少なくとも 1 つの固有の認証情報セットを必要とします。必要な認証情報のセットは、次の表に示すように、UID2 にどのように参加しているかによって異なります。

Audience	Credentials	Integration
Client-Side 実装を使用する参加者	次の両方: Subscription ID Public key これら 2 つをあわせて client keypair と呼ぶこともあります。	次のいずれかを使用したインテグレーション: Client-side integration guide for Prebid.js Client-side integration guide for JavaScript Client-side integration guide for mobile
Client-Server 実装を使用する参加者	次の両方: API Key、Client Key とも呼ばれます。 Client Secretは、参加者と UID2 Service のみが知る値です。	次のいずれかを使用したインテグレーション: Client-server integration guide for JavaScript Client-server integration guide for Prebid.js Client-server integration guide for mobile
Server-Side 実装を使用する参加者	次の両方: API Key、Client Key とも呼ばれます。 Client Secretは、参加者と UID2 Service のみが知る値です。	次のいずれかを使用したインテグレーション: Publisher integration guide, server-side Advertiser/data provider integration overview

Separate credentials per environment/role

インテグレーション環境 と本番環境の両方を使用している場合、それぞれの環境用に別々の認証情報が提供されます。詳細は Getting your credentials を参照してください。

さらに、いくつかのケースでは、異なるシナリオに対して異なるセットの認証情報を持つことを推奨しますが、必須ではありません。たとえば:

• UID2 Token を生成するパブリッシャーである場合(POST /token/generate または他の方法で)、自分のために raw UID2 を生成/マッピングする場合(POST /v3/identity/map を参照)、それぞれの活動に対して異なる認証情報を持つことがあります。
• 広告主の場合、広告主キーを使用して複数のサービスプロバイダーが運用するシナリオで、各サービスプロバイダーに対して異なる認証情報を割り当てることができます。

Getting your credentials

以下の表は、各 インテグレーションアプローチ と各 environment に対して、認証情報を取得する方法を示しています。

Environment	Integration Type	Getting Credentials
Prod	Client-Side	UID2 Portal > Client-side integration
	Client-Server	UID2 Portal > API keys
	Server-Side	UID2 Portal > API keys
Integ	Client-Side	UID2 の担当者に問い合わせてください。
	Client-Server
	Server-Side

Subscription ID and public key

Client-Side の実装(Client-side integration guide for Prebid.js または Client-side integration guide for JavaScript を参照) を使用している場合は、以下の認証情報を受け取ります:

• Subscription ID: UID2 Service に対してサイトを識別する値です。
• Public key: この値は暗号化に使用されます。

Client keypair は、Client-Side でトークンを生成する実装を使用するアカウントを一意に定義するために使用される、これら 2 つの値をまとめたグループ用語です。

UID2 を Client-Side で実装する場合、UID2 JavaScript SDK、client-side integration for mobile、または Prebid.js を使用している場合は、設定の一部として SDK または Prebid.js に値を提供してください。

Notes:

• API キーと Client Secret とは異なり、Subscription ID と Public key は安全に保管する必要はありません。

• 値は特定の environment で有効です。インテグレーション環境と本番環境の両方を使っている場合、環境ごとに認証情報のセットを取得します。

• Subscription ID と Public Key の認証情報は、Client-Side トークンの生成にのみ使用できます。追加のロールが必要な場合は (API permissions を参照)、そのロールの API キーと Client Secret をリクエストしてください。

API key and client secret

Client-Server または Server-Side の実装を使用している場合(Client-server integration guide for Prebid.js または Client-server integration guide for JavaScript を参照)、API Key と Client Secret を使用して、Operator Service に接続し、API エンドポイントを呼び出すことができます。これらの値は、サービスの参加者を識別します。

以下は API Key と Client Secret に関する情報です:

• これらの値は安全に保管する必要があります。詳細は、Security of API key and client secret を参照してください。
• UID2 参加者は、複数のキーを持つことができます。
• 各キーには、それを使用できるエンドポイントを決定する 権限 のセットがあります。
• 各キーには対応する Client Secret があります。
• ほとんどの API エンドポイントは、認証のために API Key と Client Secret の両方を必要とします。詳細は Authentication and authorization を参照してください。
• インテグレーション環境と本番環境の両方を使用する場合、環境ごとに個別の API Key を受け取ります。
• Client Secret は特定の environment で有効です。インテグレーション環境と本番環境の両方を使っている場合、環境ごとに Client Secret を取得します。

UID2 アカウントのセットアップの一環として、1つ以上の API Key が発行され、それぞれに対応する Client Secret が割り当てられます。連絡先の詳細は Contact info を参照してください。

Security of API key and client secret

キーと Client Secret のセキュリティは非常に重要です。以下のガイドラインに従ってください:

• API Key と Client Secret を受け取ったら、安全な場所に保管してください。
• これらの値が保存され使用されているすべての場所を追跡しておき、キーをローテーションする必要がある場合にすぐに実行できるようにしておいてください。
• 既存のキーとシークレットが漏洩した場合、新しいキーとシークレットに置き換えるプロセスを確立してください。

API Key と Client Secret は、認証情報が漏洩するリスクを減らすために、定期的に(たとえば1年ごとに)更新することを推奨します。

Refreshing credentials

新しい認証情報をリクエストするには、次のいずれかを行います:

• UID2 Portal にアクセスできる場合、新しい本番環境の認証情報が必要な場合: Getting your credentials に記載されているページに移動します。
• UID2 Portal へのアクセス権がない場合、またはインテグレーション環境用の新しい認証情報が必要な場合は、UID2 の担当者に問い合わせてください。