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

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　は大文字と小文字が区別されます。
  • トークンの値は、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 をビッドストリームに送信します。
  • UID2 Token をリフレッシュしても、元の UID2 Token は無効になりません。有効期限が切れるまで、以前のトークンを引き続き使用できます。

Refresh Tokens: Key Information​

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

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

推奨されるリフレッシュ間隔は、1 時間です。

リフレッシュのタイミングを決定するには、POST /token/generate エンドポイントのレスポンス (Successful Response) または POST /token/refresh エンドポイントのレスポンス (Successful Response With Tokens を参照してください) の refresh_from フィールドのタイムスタンプを使用できます。このフィールドの値は、ミリ秒単位で表された Unix 時間のタイムスタンプです。

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 を参照してください。