DSP integration guide

このガイドは、ビッドストリームで UID2 の取引を行う DSP を対象としています。

DSP はビッドリクエストで UID2 Token を受け取り、この機能をサポートする Server-Side SDK のいずれかを使用して UID2 tokens を復号化し、入札に使用できる raw UID2s を取得します。

利用可能な Server-Side SDK の概要は、SDKs: Summary を参照してください。

注記

バックエンドが、利用可能な Server-Side SDK のいずれでもカバーされていない言語で書かれている場合は、UID2 の担当者に問い合わせてください。誰に聞けばいいかわからない場合は、連絡先情報 を参照してください。

Integration steps

以下は、RTB で UID2 をサポートするための DSP のインテグレーションワークフローで、大きく 2 つのステップで構成されています:

1. Honor user opt-outs
2. Decrypt UID2 tokens for RTB use

Honor user opt-outs

このセクションには、UID2 のユーザーオプトアウトを受け入れる必要がある DSP 向けの以下の情報が含まれています:

• Opt-out webhook
• POST /optout/status endpoint
• Bidding opt-out logic

UID2 のオプトアウトワークフローとユーザーがどのようにオプトアウトできるかの詳細は、User opt-out を参照してください。

Opt-out webhook

UID2 Service からユーザーオプトアウトを受け取り、それを受け入れるために DSP が事前に設定されたインターフェース (オプトアウト Webhook/API エンドポイント) を確立し、オンボーディング中に UID2 Service に提供します。ユーザーがオプトアウトすると、UID2 Service はユーザーの raw UID2 と対応するオプトアウトタイムスタンプを事前に設定されたインターフェースに送信します。

UID2 Service は、ユーザーのオプトアウトから数秒以内に次のデータを送信し、DSP は Decrypt UID2 tokens for RTB use で定義された入札ロジックを使用します。

Parameter	Description
identity	オプトアウトしたユーザーの raw UID2。
timestamp	ユーザーがオプトアウトした時刻を示す Unix タイムスタンプ (秒 単位) です (情報のみ)。

注記

オプトアウト Webhook の timestamp は 秒 単位です。これは、POST /optout/status エンドポイントが返す opted_out_since の値が ミリ秒 単位の Unix タイムスタンプであるのとは異なります。

DSP は、オプトアウトデータに 200 レスポンスコードでレスポンスする必要があります。

次の例は、raw UID2 と対応するタイムスタンプを受信するように構成された Webhook を示しています:

https://dsp.example.com/optout?user=%%identity%%&optouttime=%%timestamp%%

POST /optout/status endpoint

DSP は、POST /optout/status エンドポイントを使用して raw UID2 のオプトアウトステータスを確認できます。

Bidding opt-out logic

入札時 (2-b)に以下のロジックを使用し、ユーザーのオプトアウトを受け入れます。

Server-Side SDK のいずれか (SDKs: Summary を参照) を利用して、受信した UID2 Token を raw UID2 に復号します。decrypt 関数へのレスポンスには、raw UID2 が含まれます。

オプトアウトのロジックを次の図に示します。

ユーザーがオプトアウトした場合、UID2 は RTB に使用されるべきではありません。このような場合、DSP は入札のために代替 ID を送信するか、入札しないことを選択できます。

Decrypt UID2 tokens for RTB use

次の表は、Integration steps で示したワークフロー図の Step 2 の詳細です。

Step	SDK	Description
2-a	Server-Side SDK (SDKs: Summary を参照)	提供されている SDK を活用して、入力された UID2 Token を復号化します。レスポンスには UID2 と UID2 の作成時刻が含まれます。
2-b		DSP は UID2 のオプトアウトプロトコルを受け入れることが要求されます。ユーザーオプトアウトの設定と入札時の受け入れは、Honor user opt-outs を参照してください。

Recommendations for managing latency

注記

このセクションは、SDK for C# / .NET reference guide の Usage for DSPs にあるサンプルコードを参照してください。メソッド名は Java、Python、および C++ SDK でも同様です。

低遅延/高スループットのセットアップを行う場合は、以下の推奨事項に従ってください:

• 各サーバーに BidstreamClient クラスのローカルインスタンスを持ちます。これはプロセス内またはプロセス外で行うことができます。プロセス内が最も簡単です。
• クライアントの Refresh メソッドをバックグラウンドで定期的に呼び出します: たとえば、1 時間ごとに、グローバルフリートの再起動後のピークを避けるためにいくつかのランダム化を行います。
• トークンを暗号化する必要がある場合は、DecryptTokenIntoRawUid メソッドを呼び出します。プロセス内が最速ですが、正しく行えばプロセス外でも問題ありません。
  注記

  トークンの復号化メソッドはスレッドセーフなので、複数のスレッドで同時に呼び出すことができます。

FAQs

DSP に関するよくある質問は、FAQs for DSPs を参照してください。