入札者サービスは、入札者を Xandr のインプレッション バスに接続し、入札者とインプレッション バスが通信を開始できるようにします。 Xandr 担当者がシステムで入札者を作成し、お客様は入札者サービスを使用して変更を行ったり、入札者 ID を取得したりします。
一部のサービスでは、入札者 ID が必要になる場合があります。 ご使用の入札者 ID を確認するには、以下で説明する [すべての入札者を表示] コマンドを実行します。
一部の入札者機能は、契約上の義務に基づいているため、特定のユーザーしかアクセスできません。
データ プロバイダーのフィールドの変更 ( PUT 経由) - 各プロバイダーとのデータ アクセス契約が必要です
入札者サンドボックス環境では、すべての機能が統合の目的で使用できます。
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 は現在、 bid_uri と notify_uri を個別のホストに配置することをサポートしていません。- null の場合、入札者は通知リクエストを受け取りません。 |
click_uri |
いいえ | string(255) | クリック要求の URI ( /clickなど)。 これを空に設定するには、空の文字列ではなく null を使用します。
クリック要求を参照してください。 |
pixel_uri |
いいえ | string(255) | ピクセル要求の URI ( /pixelなど)。 これを空に設定するには、空の文字列ではなく null を使用します。 「ピクセル要求」を参照してください。 |
ready_uri |
はい (追加時) | string(50) |
入札者インスタンスのステータス チェックの URI (例: /ready)。 |
audit_notify_uri |
いいえ | string(255) | クリエイティブ監査の更新を渡すための URI (例: https://send.mycompany.com/auditnotifyrequests) |
parent_profile_id |
いいえ | int | 親入札者プロファイルの ID。 入札者プロファイルを使用して、入札者に到達する入札要求トラフィックをフィルター処理できます。 「 従来の入札者プロファイル サービス 」と「 入札者プロファイル - FAQ」を参照してください。 |
child_profiles |
いいえ | 入札者プロファイルの ID を持つオブジェクトの配列。 | 使用する子プロファイルを指定するオブジェクトの配列。 例: [{"id":123}, {"id":124}]。 |
dongle |
いいえ | string | デバッグ インプレッションで入札者のデバッグ出力を保護するパスワード。
入札応答のdebug_textを参照してください。
タイプ "bidder" のユーザーのみが使用できます。 |
notify_full_auction |
いいえ | ブール型 | これを "true" に設定すると、インプレッション バスの通知要求にfull_tag_infoとbid_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 |
ブール型 | 入札者が要求に対して入札を持っていない場合に、入札者に通知するかどうかを示します。 通知は、[ notify_uri ] フィールドで指定された URI に送信されます。 URI を指定しない場合、通知は送信されません。 |
exclude_unowned |
いいえ | ブール型 | この入札者に関連付けられているメンバーが所有していない在庫を除外します。 |
send_unaudited |
いいえ、既定値は false |
ブール型 | このフラグは、入札者に監査されていないトラフィックを送信するかどうかを決定します。 警告: 厳密に言えば、このフィールドは非推奨ですが、常に true に設定する必要があります。 このフィールドが false に設定されている場合、入札者は入 札リクエストを受け取りません。 |
bid_percent |
いいえ | int | 受信するプラットフォーム トラフィックの合計の割合 (50 = 50%)。 入札者に送信される要求はランダムに選択されますが、入札者に関連付けられているメンバーのセグメントに属するユーザーに対する要求を常に受信するように入札者が選択できます。 bid_percent を 0 に設定すると、入札者は少なくとも 1 つのメンバーのセグメントにいるユーザーに対するリクエストのみを受け取ります。 このフィルターは、 従来の入札者プロファイル サービスを通過するトラフィックに適用されます。 |
always_send_owned_segments |
いいえ | ブール型 | 入札者が所有または入札者と共有しているセグメントのユーザーに対するインプレッションが、 入札者プロファイルのpassthrough_percentをバイパスするかどうかを決定します。 メモ: これは、入札者プロファイルのpassthrough_percentのみをオーバーライドします。入札者にインプレッションを送信するかどうかを決定する際には、国または地域、メンバー、サイズ、ドメイン フィルターなどの他の制限はすべて引き続き考慮されます。 |
object_limit_notify_email |
いいえ | 文字列の配列 | Xandr は、各入札者がプラットフォーム上で作成および使用できるオブジェクトの数を制限します。 この制限には、非アクティブ オブジェクトと未使用のオブジェクトが含まれます。 このフィールドには、オブジェクト制限の 85%、95%、100% のしきい値に達したときに通知される電子メール アドレスが含まれています。 |
protocol_id |
いいえ | int |
読み取り専用です。 これは、この入札者に関連付けられているプロトコルについて説明します。それは、その入札者の種類を記述します。 たとえば、 protocol_id が 6 の場合、この入札者は Xandr との統合に OpenRTB 2.0 仕様を使用していることを意味します。 新しく作成された入札者の既定の統合値は、 1、 none です。 これは、 入札要求 と 入札応答で定義されている既定のプロトコルです。
protocol_idが 6 の入札者は、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 | このビッダー インスタンスへの最後の変更のタイムスタンプ。 |
max_seats |
いいえ | 整数 | カスタム購入者の座席 ID を使用して入札する入札者は、このフィールドに 0 より大きい値を含めます。 これは、入札者に登録できる最大シート数です。 メモ: この機能は現在クローズド ベータ版です。 参加に関心がある場合は、Xandr の担当者にお問い合わせください。 |
default_member |
いいえ | オブジェクト | 購入者の座席 ID 入札を使用する入札者には、このフィールドに指定された既定のメンバーが含まれます。 注: 既定のメンバーは、入札者のメインの課金メンバーであり、クリエイティブ登録のメンバー ID としても使用されます。 メモ: この機能は現在クローズド ベータ版です。 参加に関心がある場合は、Xandr の担当者にお問い合わせください。 |
注:
入札者プロフィール サービスを使用してフィルタリングと調整を行います。
入札者が受け取るトラフィックをフィルタリングするには、 従来の入札者プロファイル サービスを使用します。 いくつかのフィルタリングおよび調整フィールドは入札者サービスにまだ存在しますが、間もなく入札者プロファイル サービスに移行されます。 クラスフィルターは両方で使用できます。これらには、Bidder Profile Service の使用をお勧めします。
非推奨のフィールド
| フィールド | 必須 | 型 | 説明 |
|---|---|---|---|
send_class_2 |
いいえ、既定値は true |
ブール型 | このフラグは、入札者にクラス 2 トラフィックを送信するかどうかを決定します。 インベントリ クラスによる調整は、 従来の入札者プロファイル サービスを介して行うことも可能です。 |
send_class_3 |
いいえ、既定値は true |
ブール型 | このフラグは、入札者にクラス 3 トラフィックを送信するかどうかを決定します。 インベントリ クラスによる調整は、 従来の入札者プロファイル サービスを介して行うことも可能です。 |
send_unaudited |
いいえ、既定値は false |
ブール型 | このフラグは、入札者に監査されていないトラフィックを送信するかどうかを決定します。 メモ: インベントリ クラスによる調整は、 従来の入札者プロファイル サービスを介して行うこともできます。 警告: 入札要求を表示するには、このフィールドを設定する必要があります 入札者が入札要求を受け取るには、 send_unaudited を true に設定する必要があります。 詳細については、「 入札者の統合」を参照してください。 |
send_owned_blocklist |
いいえ | ブール型 | この入札者に関連付けられているメンバーが所有している場合は、ブロック リスト インベントリを送信します。 |
userdata_entity_id |
いいえ | int | このフィールドは非推奨です。 |
userdata_javascript |
いいえ | string | 入札者がユーザーの Cookie データを更新するときに呼び出すことのできるカスタム JavaScript 関数。 |
setuid_function |
いいえ | string | SetUID 呼び出しで使用する JavaScript 関数の名前。 |
例
認証トークン
API サービスを使用する場合、認証は常に最初のステップです。 認証トークンは、将来使用するために cookie ファイルに書き込むことができます。 詳細な手順については、「 認証サービス」を参照してください。
入札者情報を表示する
Xandr によってすでに入札者が追加されている場合は、JSON 形式の入札者 ID などの入札者情報が既に用意されていることになります。 この情報は、次のコマンドで表示できます。
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"
}
}
}