メインコンテンツまでスキップ

UID2 Credentials

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

AudienceCredentialsIntegration
Client-Side 実装を使用する参加者次の両方: これら 2 つをあわせて client keypair と呼ぶこともあります。次のいずれかを使用したインテグレーション:
Client-Server 実装を使用する参加者次の両方:
  • API key、client key とも呼ばれます。
  • Client secret は、参加者と UID2 Service のみが知る値です。
次のいずれかを使用したインテグレーション:
Server-Side 実装を使用する参加者次の両方:
  • API key、client key とも呼ばれます。
  • Client secret　は、参加者と UID2 Service のみが知る値です。
次のいずれかを使用したインテグレーション:

Separate Credentials Per Environment/Role​

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

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

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

Getting Your Credentials​

以下の表は、各 integration approach と各 environment に対して、認証情報を取得する方法を示しています。

EnvironmentIntegration TypeGetting Credentials


Prod		Client-SideUID2 Portal > Client-Side Integration
Client-ServerUID2 Portal > API Keys
Server-SideUID2 Portal > API Keys


Integ		Client-Side

Ask your UID2 contact.
Client-Server
Server-Side

Subscription ID and Public Key​

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

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

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

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

Notes:

  • API Key とクライアントシークレットとは異なり、Subscription ID と Public key は安全に保管する必要はありません。

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

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

API Key and Client Secret​

Client-Side または Server-Side の実装を使用している場合(UID2 Client-Server Integration Guide for Prebid.js または Client-Server Integration Guide for JavaScript を参照してください)、API Key とクライアントシークレットを使用して、Operator Service に接続し、API エンドポイントを呼び出すことができます。これらの値は、サービスの参加者を識別します。

以下は API Key とクライアントシークレットに関する情報です:

  • これらの値を安全に保管しなければなりません。詳細は、Security of API Key and Client Secret を参照してください。
  • UID2 参加者は、複数のキーを持つことができます。
  • 各キーには、それを使用できるエンドポイントを決定する Permissions のセットがあります。
  • 各キーには対応するクライアントシークレットがあります。
  • ほとんどの API エンドポイントは、認証のために API Key とクライアントシークレットの両方を必要とします。詳細は Authentication and Authorizatio を参照してください。
  • インテグレーション環境と本番環境では、異なる API Key が必要です。各環境の認証情報を取得する方法については、Getting Your Credentials を参照してください。
  • クライアントシークレットは特定の Environment で有効です。インテグレーション環境と本番環境の両方を使っている場合、それぞれの環境用のクライアントシークレットを取得します。

UID2 アカウントのセットアップの一環として、1つ以上の API Key が発行され、それぞれに対応するクライアントシークレットが割り当てられます。相談相手の詳細は Contact Info を参照してください。

Security of API Key and Client Secret​

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

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

API Key とクライアントシークレットは、認証情報が漏洩するリスクを減らすために、定期的に(たとえば1年ごとに)更新するのがベストです。

Refreshing Credentials​

To request new credentials at any time, do one of the following: 新しい認証情報をリクエストするには、次のいずれかを行います:

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