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

UID2 tokens and refresh tokens

パブリッシャーがユーザーの DII—ハッシュ化またはハッシュされていないメールアドレスまたは電話番号—を UID2 Operator に送信すると、UID2 SDK のいずれかを使用するか、POST /token/generate エンドポイントを使用するかに関わらず、UID2 Operator は DII を raw UID2 に変換し、UID2 Token に暗号化して返します。UID2 Token には、Refresh Token を含む関連値が付属しています。パブリッシャーは、UID2 Token をビッドストリームで使用できます。

UID2 tokens: Key information​

UID2 Token に関する主なポイントは次のとおりです:

  • UID2 Token は一意の値です: 2 つの UID2 Token が同じであることはありません。
  • UID2 Token は大文字と小文字が区別されます。
  • パブリッシャーは、UID2 Token をビッドストリームに送信します。
  • トークンの値は、opaque (不透明)な文字列です: 文字列の形式や長さについての仮定をしないでください。
  • ブラウザ、CTV、電話、タブレットなどの電子デバイスでのユーザーのアクティビティの異なるインスタンスを表す UID2 Token は、依然として同じ raw UID2 に一致させることができます。
  • トークン生成時に、UID2 Operator はユーザーのオプトアウトを確認します。ユーザーが UID2 からオプトアウトしている場合、UID2 Token は生成されません。詳細は、User opt-out を参照してください。
  • トークンは有効期限がありますが、Refresh Token を使用してリフレッシュできます。
  • 現在の UID2 Token が有効期限切れになる前に、常に現在の Refresh Token をリフレッシュすることで、新しい UID2 Token と対応する新しい Refresh Token を取得するために何度でもリフレッシュできます。
  • UID2 Token をリフレッシュしても、元の UID2 Token は無効になりません。有効期限が切れるまで、以前のトークンを引き続き使用できます。

詳細は、How the UID2 token is created を参照してください。

Refresh tokens: Key information​

Refresh Token に関する主なポイントは次のとおりです:

  • Refresh Token は、UID2 Token と一緒に発行される文字列です。
  • Refresh Token は大文字と小文字が区別されます。
  • 値は、opaque (不透明)な文字列です: 文字列の形式や長さについての仮定をしないでください。
  • Refresh Token は、UID2 Token が有効期限切れになる前に、新しい UID2 Token と新しい Refresh Token を生成するために使用できます。
  • Refresh Token の使用は任意です: 既存のトークンをリフレッシュする代わりに、毎回 DII から新しいトークンを生成することを選択することもできます。
  • Token Refresh は、さまざまな方法で管理できます:
  • 新しい UID2 Token が生成され、Refresh Token に対するレスポンスとして返されると、新しい Refresh Token も返されます。
  • ほとんどの場合、Server-Side で生成されたトークンでも、Client-Side でトークンをリフレッシュできます。各 SDK のリフレッシュ機能についての詳細は、SDK functionality (Refresh UID2 Token 列) を参照してください。
  • UID2 Operator Service が、新しい UID2 Token をリクエストする際に Refresh Token を受け取ると、ユーザーのオプトアウトを確認します。ユーザーが UID2 からオプトアウトしている場合、新しい UID2 Token は生成されません。詳細は、User opt-out を参照してください。

Keeping the token current​

UID2 Token を有効期限内に保つことが非常に重要です。トークンが有効な場合のみ、UID2 の利点を享受できます。

UID2 Token を最新の状態に保つには、次の2つの方法があります：

  • POST /token/refresh エンドポイントまたは多くの UID2 SDK のトークン更新機能を使用して、頻繁に更新してください。詳細は Recommended token refresh frequency を参照してください。
  • 既存トークンの更新に代わる方法として、POST /token/generate エンドポイントまたは多くの UID2 SDK のトークン生成機能を使用して、毎回新しいトークンを生成してください。

現在、推奨されているリフレッシュ間隔は 1 時間です。1 時間ごとの間隔にすることで、トークンが期限切れになるのを避け、ビッドストリームに送信できるようになります。また、新しいトークンが生成される前にユーザーのオプトアウトが確認されるため、ユーザーのオプトアウト設定が迅速に反映されるようになります。

リフレッシュのタイミングを決定するには、以下の UID2 API エンドポイントのいずれかを呼び出した際のレスポンスの refresh_from フィールドのタイムスタンプを使用できます:

refresh_from フィールドは Unix タイムスタンプで、トークンが生成された時間から 1 時間後の値をミリ秒で表します。

ヒント

推奨されるリフレッシュ間隔は将来変更される可能性があります。固定値を使用する代わりに、refresh_from 値に基づいて計算することが最善です。

Managing token refresh with an SDK​

トークンの更新を管理する簡単な方法は、その目的のために関数を持つ UID2 SDK のいずれかを使用することです: Java SDK または Python SDK。

これらの SDK のいずれも、トークンをリフレッシュする必要があるかどうかを判断するための関数を持つ publisher クラスを含んでいます。

以下の例では、これらの SDK のいずれかを使用して、まず、トークンをリフレッシュできるかどうかを確認し、次にリフレッシュが必要かどうかを確認する方法を示します。リフレッシュが必要な場合は、リフレッシュ関数を呼び出してトークンをリフレッシュできます。

  1. Identity がリフレッシュ可能かどうか (つまり、Refresh Token が期限切れになっていないか) を判断します:

    if (identity == null || !identity.isRefreshable()) { we must no longer use this identity (for example, remove this identity from the user's session) }

  2. リフレッシュが必要かどうかを判断します:

    if (identity.isDueForRefresh()) {..}

コード例を使用する前に、使用している言語の前提条件と注意事項を確認してください。詳細は、該当する SDK のドキュメントを参照してください:

FAQs​

トークンのリフレッシュに関するよくある質問は、パブリッシャー向け FAQ を参照してください。