Bidder サービス

  • [アーティクル]

Bidder Service は、入札者を Xandr のインプレッション バスに接続し、入札者とインプレッション バスが通信を開始できるようにします。 Xandr 担当者がシステムに入札者を作成し、Bidder Service を使用して、入札者 ID を変更または取得します。

一部のサービスには入札者 ID が必要な場合があります。 入札者 ID を確認するには、以下で説明する "すべての入札者を参照してください" コマンドを実行します。

一部の入札者関数は、契約上の義務に基づいているため、特定のユーザーのみがアクセスできます。

(を使用して PUT) データ プロバイダー フィールドを変更する - 各プロバイダーとのデータ アクセス契約が必要です

bidder サンドボックス環境では、統合のためにすべての機能を使用できます。

REST API

HTTP メソッド エンドポイント 説明
GET https://api.adnxs.com/bidder/ ユーザーがアクセス許可を持っている入札者を表示します。 他のユーザーの入札者は表示されません。
GET https://api.adnxs.com/bidder/BIDDER_ID 特定の入札者を表示します。
POST https://api.adnxs.com/bidder
(bidder JSON)		 新しい入札者を追加します。
PUT https://api.adnxs.com/bidder/BIDDER_ID
(bidder JSON)		 既存の入札者を変更します。
DELETE https://api.adnxs.com/bidder/BIDDER_ID 既存の入札者を削除します。

JSON フィールド

フィールド 必須 型 説明
id はい、更新時 int 入札者の ID。
short_name はい (追加時) string 入札者の省略可能な短い名前。 技術的には必須ではありませんが、メトリックにはこのフィールドが必要であるため、必須と見なす必要があります。

メモ： 英数字 (A から Z、0 から 9) とアンダースコアのみを使用できます。 スペース、特殊文字、ピリオド、またはその他の句読点は使用しないでください。
name はい (追加時) string 入札者に関連付けられている名前。
active いいえ。既定値は true です ブール型 入札者が要求を受け取るかどうか。
bid_uri はい (追加時) string(255) 入札要求の URI (例: /bid)。
notify_uri いいえ string (255) 通知要求の URI (例: /notify)。 空の文字列ではなく null を使用して、これを空白に設定します。

注:
- は notify_uri 相対 URI である必要があります。 現在、Xandr では、 と notify_uri を個別のbid_uriホストに配置することはできません。
- null の場合、入札者は通知要求を受け取りません。
click_uri いいえ string(255) クリック要求の URI (例: /click)。 空の文字列ではなく null を使用して、これを空白に設定します。 「 [要求] をクリックする」を参照してください。
pixel_uri いいえ string(255) ピクセル要求の URI (例: /pixel)。 空の文字列ではなく null を使用して、これを空白に設定します。 「ピクセル要求」を参照してください。
ready_uri はい (追加時) string(50) Bidder インスタンスの状態チェックの URI (例: /ready)。
audit_notify_uri いいえ string(255) クリエイティブ監査更新プログラムを渡すための URI (例: https://send.mycompany.com/auditnotifyrequests)
parent_profile_id いいえ int 親入札者プロファイルの ID。 Bidder プロファイルを使用すると、入札者に到達した入札要求トラフィックをフィルター処理できます。 「従来の Bidder プロファイル サービス」と「Bidder Profile - FAQ」を参照してください。
child_profiles いいえ 入札者プロファイルの ID を持つオブジェクトの配列。 使用する子プロファイルを指定するオブジェクトの配列。 (例: [{"id":123}, {"id":124}])。
dongle いいえ string 入札者のデバッグ出力をデバッグインプレッションで保護するパスワード。 入札応答を参照してくださいdebug_text。 "bidder" タイプのユーザーのみが使用できます。
notify_full_auction いいえ ブール型 これを "true" に設定すると、インプレッション バスに通知要求に と bid_info が含まれますfull_tag_info。 入札受付コールバックがまだ受信されていないため、保留中後の通知 (post_pending 通知要求で に true 設定) にはこれらのタグは含まれません。
notify_lost いいえ。既定値は false ブール型 フィールドで指定された notify_uri URI で、すべての落札について入札者に通知されるかどうかを示します。 URI が指定されていない場合、通知は送信されません。
- の場合 true、すべての落札について入札者に通知されます。
- の場合 false、入札者に通知 要求エラー コード ID が 100 を超える落札についてのみ通知されます。 OpenRTB 入札者のエラー ID が 100 未満の場合は、エラーをログに記録したり、紛失通知を送信したりすることはありません。
notify_pending いいえ。既定値は false ブール型 フィールドで指定された notify_uri URI で保留中の入札について、入札者に通知されるかどうかを示します。 URI が指定されていない場合、通知は送信されません。
notify_no_bid いいえ。既定値は false ブール型 入札者に要求の入札がない場合に、入札者に通知されるかどうかを示します。 通知は、フィールドで指定された URI に notify_uri 送信されます。 URI が指定されていない場合、通知は送信されません。
exclude_unowned いいえ ブール型 この入札者に関連付けられているメンバーが所有していないインベントリを除外します。
send_unaudited いいえ。既定値は false ブール型 このフラグは、入札者が未監査のトラフィックを送信するかどうかを決定します。

警告： 厳密には、このフィールドは非推奨ですが、常に に設定する true必要があります。 このフィールドが に false設定されている場合、入札者は 入札要求を受け取りません。
bid_percent いいえ int 受信するプラットフォーム トラフィックの合計の割合 (50 = 50%)。 入札者に送信される要求はランダムに選択されますが、入札者は、入札者に関連付けられているメンバーのセグメント内のユーザーに対する要求を常に受け取ることができます。 bid_percentを 0 に設定した場合、入札者は少なくとも 1 つのメンバーのセグメント内のユーザーに対する要求のみを受け取ります。 このフィルターは、 レガシ Bidder プロファイル サービスを介してトラフィックを作成するトラフィックに適用されます。
always_send_owned_segments いいえ ブール型 Bidder が所有または共有しているセグメントのユーザーのインプレッションが、Bidder プロファイルのpassthrough_percentをバイパスするかどうかを決定 します。

メモ： これにより、入札者プロファイルのpassthrough_percentのみがオーバーライドされます。国、メンバー、サイズ、ドメインのフィルターなどの他のすべての制限は、入札者にインプレッションを送信するかどうかを決定する際に考慮されます。
object_limit_notify_email いいえ 文字列の配列 Xandr は、各入札者がプラットフォーム上で作成して使用できるオブジェクトの数を制限します。 この制限には、非アクティブオブジェクトと未使用オブジェクトが含まれます。 このフィールドには、オブジェクト制限のしきい値が 85%、95%、100% に達したときに通知される電子メール アドレスが含まれます。
protocol_id いいえ int 読み取り専用。 この入札者に関連付けられているプロトコルについて説明します。このプロトコルは、入札者の種類を記述します。 たとえば、 の6は、protocol_idこの入札者が Xandr との統合に OpenRTB 2.0 仕様を使用することを意味します。 新しく作成された bidder の既定の統合値は、 です1none。 これは、 入札要求 と 入札応答で定義されている既定のプロトコルです。 6 の入札者はprotocol_id、OpenRTB 2.0 仕様 (PDF) に従って統合されます。
OpenRTB 2.4、 protocol_id: 10 の仕様。
次の値がサポートされています (各 ID の後に、その ID に protocol_name 関連付けられている が続きます)。
- 1: none
- 2: wp7
- 3: contentads
- 4: admarket
- 5: adexpert
- 6: openrtb2.0
- 10: openrtb2.4
protocol_name いいえ string 読み取り専用。 この入札者に関連付けられているプロトコルの名前。 の受け入れ可能なすべての値とその名前へのマッピングについては、上記のprotocol_id定義protocol_idを参照してください。
last_activity いいえ timestamp この bidder インスタンスに対する最後の変更のタイムスタンプ。
max_seats いいえ 整数 カスタム購入者シート ID を使用した入札の入札には、このフィールドに 0 より大きい値が含まれます。 これは、入札者の下で登録できる最大シート数です。

メモ： この機能は現在、クローズド ベータ版です。 参加に興味がある場合は、Xandr の担当者にお問い合わせください。
default_member いいえ オブジェクト 購入者のシート ID 入札を使用する入札者には、このフィールドに既定のメンバーが指定されます。 既定のメンバーは、入札者のメイン課金メンバーであり、クリエイティブ登録のメンバー ID としても使用されることに注意してください。

メモ： この機能は現在、クローズド ベータ版です。 参加に興味がある場合は、Xandr の担当者にお問い合わせください。

注:

Bidder Profile Service を使用してフィルター処理と調整を行います。

入札者が受け取るトラフィックをフィルター処理するには、 レガシ Bidder プロファイル サービスを使用します。 いくつかのフィルター処理フィールドと調整フィールドは Bidder サービスにまだ存在しますが、近日中に Bidder Profile Service に移行されます。 クラス フィルターは両方で使用できます。これらの場合は、Bidder Profile Service を使用することをお勧めします。

非推奨のフィールド

フィールド 必須 型 説明
send_class_2 いいえ。既定値は true ブール型 このフラグは、入札者がクラス 2 トラフィックを送信するかどうかを決定します。 従来の Bidder プロファイル サービスを使用して、インベントリ クラスによる調整も可能であることに注意してください。
send_class_3 いいえ。既定値は true ブール型 このフラグは、入札者がクラス 3 トラフィックを送信するかどうかを決定します。 従来の Bidder プロファイル サービスを使用して、インベントリ クラスによる調整も可能であることに注意してください。
send_unaudited いいえ。既定値は false ブール型 このフラグは、入札者が未監査のトラフィックを送信するかどうかを決定します。

メモ： 従来の Bidder プロファイル サービスを使用して、インベントリ クラスによる調整も可能です。

警告： 入札要求を表示するには、このフィールドを設定する必要があります
入札者が入札要求をtrue受け取るには、 を に設定send_unauditedする必要があります。 詳細については、「 Bidder の統合」を参照してください。
send_owned_blocklist いいえ ブール型 この入札者に関連付けられているメンバーが所有している場合は、ブロックリスト インベントリを送信します。
userdata_entity_id いいえ int このフィールドは非推奨です。
userdata_javascript いいえ string 入札者がユーザーの Cookie データを更新するときに呼び出すことができるカスタム JavaScript 関数。
setuid_function いいえ string SetUID 呼び出しで使用する JavaScript 関数の名前。

例

認証トークン

API Services を使用する場合、認証は常に最初の手順です。 認証トークンは、後で使用するために Cookie ファイルに書き込むことができます。 詳細な手順については、「 認証サービス」を参照してください。

入札者情報を表示する

Xandr が既に入札者を追加している場合は、入札者 ID などの入札者情報が JSON 形式で既に存在します。 この情報は、次のコマンドを使用して表示できます。

S curl -b cookies -c cookies "https://api.adnxs.com/bidder"
{
   "response":{
      "status":"OK",
      "bidder":{
         "id":4,
         "name":"Test Bidder",
         "short_name":"TestBidder",
         "active":true,
         "parent_profile_id": 12345,
         "child_profiles":[{"id":1000},{"id":2000},{"id":3000}],
         "bid_uri":"/bid",
         "notify_uri":"/notify",
         "click_uri":null,
         "ready_uri":null,
         "pixel_uri":"/pixel",
         "audit_notify_uri":null,
         "last_activity":"2009-01-07 22:07:08"
      }
   }
}

入札者を変更する

入札者 ID がわかったら、JSON 形式のテキスト ファイルを使用して入札者を変更できます。 準備完了 URI パラメーターを変更する JSON の例を次に示します。

注:

これらの含まれるフィールドは更新されます。 その他のフィールドはすべて変更されません。

$ cat bidder
{
      "bidder":{
         "id":4,
         "ready_uri":"/ready"
      }
   }

次に、 コマンドを PUT 使用して、インプレッション バス キャッシュ内のこのデータを更新します。

$ curl -b cookies -c cookies -X PUT --data-binary @bidder 'https://api.adnxs.com/bidder/4'
{
   "response":{
      "status":"OK",
      "id":4
   }
}

Bidder 4 を表示すると、次の情報が表示されます。

$ curl -b cookies -c cookies 'https://api.adnxs.com/bidder/4'
{
   "response":{
      "status":"OK",
      "bidder":{
         "id":4,
         "name":"Test Bidder",
         "short_name":"TestBidder",
         "active":true,
         "parent_profile_id": 12345,
         "child_profiles":[{"id":1000},{"id":2000},{"id":3000}],      
         "bid_uri":"/bid",
         "notify_uri":"/notify",
         "click_uri":null,
         "ready_uri":"/ready",
         "ready_string":"Ready:1"
         "pixel_uri":"/pixel",
         "audit_notify_uri":null,
         "last_activity":"2009-01-07 22:07:08"
      }
      }
}