Bidder Instance サービス
入札者は、特定の時点で少なくとも 2 つのインスタンスを実行している可能性があります。 各インスタンスは、いずれかの Xandr データセンターのインプレッション バスに関連付けられます。 インスタンス自体は、データセンターで Xandr でホストされるか、近くにある場合があります。 グローバル インプレッションの待機時間を短縮するために、さまざまな Xandr データセンターに bidder インスタンスを設定できます (以下を参照)。datacenter_id
各 bidder インスタンスは、1 つのデータセンターに関連付けられています。 入札者の負荷が高まるにつれて、データセンターごとに複数のインスタンスが必要になる可能性があります。 これらの複数のインスタンスに対して独自のローカル負荷分散プールを設定する代わりに、インプレッション バスが負荷分散を処理できます。
Bidder Instance Service API を使用して、各 bidder インスタンスのホスト名/IP/ポートの組み合わせをインプレッション バスに登録する必要があります。 この API サービスを使用すると、インスタンスを表示、変更、および削除することもできます。 各 bidder インスタンスは、 Bidder サービスによって定義された要求ハンドラーに対して、命名法を使用する必要があります。
注:
bidder インスタンスのしくみに関してよく寄せられる質問に対する回答については、 Bidder Instance - FAQ を参照してください。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.adnxs.com/bidder-instance/BIDDER_ID | すべての bidder インスタンスを表示します。 他のユーザーの入札者は表示されません。 |
GET |
https://api.adnxs.com/bidder-instance/BIDDER_ID/BIDDER_INSTANCE_ID | 特定の入札者インスタンスを表示します。 |
POST |
https://api.adnxs.com/bidder-instance/BIDDER_ID (bidder インスタンス JSON) |
新しい bidder インスタンスを追加します。 |
PUT |
https://api.adnxs.com/bidder-instance/BIDDER_ID/BIDDER_INSTANCE_ID (bidder インスタンス JSON) |
既存の入札者を変更します。 メモ: bidder インスタンス サービスは現在、削除をサポートしていません。インスタンスを削除するには、非アクティブに設定します。 警告: bidder インスタンスを作成または変更するときは、非推奨の "datacenter" パラメーターを使用してインスタンスのデータセンターを設定しないでください。 代わりに、以下に定義されている ID で常に "datacenter_id" パラメーターを使用してください。 |
JSON フィールド
フィールド | 必須 | 型 | 説明 |
---|---|---|---|
id |
はい (オン PUT ) |
int | bidder インスタンスの ID。 |
bidder_id |
○ | int | 入札者の ID。 |
active |
いいえ。既定値は true です | ブール値 | bidder インスタンスがアクティブかどうか。 |
datacenter_id |
はい (オン POST ) |
int | インスタンスが NYM = 6、LAX = 4、、AMS = 15、FRA = 7、SIN = 13 に関連付けられているデータセンター ID。 レガシ ID: AMS = 12 (2022 年 7 月 12 日まで)、SIN = 8 (2019 年 10 月 15 日まで) |
ip_address |
○ | 文字列 | bidder インスタンスの IP アドレス。 |
port |
○ | int | bidder インスタンスのポート。 |
last_activity |
いいえ | timestamp | この bidder インスタンスに対する最後の変更のタイムスタンプ。 |
hostname |
いいえ | varchar(128) | bidder インスタンスのホスト名 ("https://" を含めないようにしてください。"hostname":"rtb.yourdomain.com") |
qps_limit |
いいえ | int | この bidder インスタンスに送信される 1 秒あたりの最大クエリ数。 |
注:
QPS の制限は、データセンター内のすべての bidder インスタンスで同じに設定する 必要があります 。 これを行うには、 をデータセンターでアクティブなすべての bidder インスタンスで同じ値に設定 qps_limit
します。 たとえば、LAX に 3 つの入札者インスタンスがあり、データセンター全体で QPS の制限を 50,000 に設定する場合は、3 つの入札者インスタンスのそれぞれに 50,000 を設定 qps_limit
します。 がデータセンター内のすべての bidder インスタンスで同じでない場合 qps_limit
は、意図しない結果が得られる可能性があるため、各データセンターで値が同じであることを qps_limit
確認してください。
いつでも bidder インスタンスにホスト名を追加できます。 ただし、この API では bidder インスタンスを調整するときに IP アドレスが必要ですが、API 呼び出しに値 (URL またはドメイン) を含むホスト名フィールドを含めると、システムはホスト名に接続し、IP アドレスを無視します。 ホスト名を使用して新しい bidder インスタンスを投稿する場合は、ip_address フィールドにプレースホルダー値を使用できます。
例
認証トークン
API Services を使用する場合、認証は常に最初の手順です。 認証トークンは、後で使用するために Cookie ファイルに書き込むことができます。 詳細な手順については、「 認証サービス」を参照してください。
既存のインスタンスを表示する
$ curl -b cookies -c cookies 'https://api.adnxs.com/bidder-instance/2'
{
"response":{
"status":"OK",
"instances":[
{
"id":14,
"bidder_id":2,
"active":true,
"datacenter_id": 6,
"ip_address":"8.12.231.108",
"port":8081,
"last_activity":"2016-12-31 17:07:17"
"hostname": null
}
]
}
}
新しいインスタンスを追加する
ニューヨーク (NYM2) インスタンスがあります。これで、LAX1 bidder インスタンスを登録します。 次の JSON を作成します。
$ cat bidder_instance
{
"instance":{
"bidder_id":2,
"active":true,
"datacenter_id":4,
"ip_address":"8.12.231.108",
"port":8081,
"hostname":"rtb.yourdomain.com"
}
}
次に、この新しいインスタンスを入札者に追加します (2):
$ curl -b cookies -c cookies -X POST --data-binary @bidder_instance 'https://api.adnxs.com/bidder-instance/2'
{
"response":{
"status":"OK",
"id":53
}
}
そして、新しく追加されたインスタンスを表示するには:
$ curl -b cookies -c cookies 'https://api.adnxs.com/bidder-instance/2/53'
{
"response":{
"status":"OK",
"instance":[
{
"id":53,
"bidder_id":2,
"active":true,
"datacenter_id":4,
"ip_address":"64.210.63.108",
"port":8081,
"last_activity":"2016-12-31 19:24:23"
"hostname":"rtb.yourdomin.com"
}
]
}
}
既存のインスタンスに QPS キャップを追加する
既存のインスタンスに QPS 上限を追加する場合:
$ cat bidder-instance
{
"instance":{
"id":53,
"qps_limit":75000
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @bidder-instance "https://api.adnxs.com/bidder-instance/2/53"
{
"response":{
"status":"OK",
"id":53
}
}
インスタンスを表示する場合:
$ curl -b cookies -c cookies 'https://api.adnxs.com/bidder-instance/2'
{
"response":{
"status":"OK",
"instances":[
{
"id":14,
"bidder_id":2,
"active":true,
"datacenter_id":6,
"ip_address":"8.12.231.108",
"port":8081,
"last_activity":"2016-12-31 17:07:17"
"hostname":null
},
{
"id":53,
"bidder_id":2,
"active":true,
"datacenter_id":4,
"ip_address":"64.210.63.124",
"port":8081,
"qps_limit":75000
"last_activity":"2016-12-31 19:51:13"
"hostname":"rtb.yourdomain.com" }
]
}
}
インスタンスの変更
IP アドレスを変更する必要がある場合:
$ cat bidder-instance
{
"instance":{
"id":53,
"ip_address":"64.210.63.124"
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @bidder-instance "https://api.adnxs.com/bidder-instance/2/53"
{
"response":{
"status":"OK",
"id":53
}
}
次に、bidder(2) のすべてのインスタンスの現在の状態を表示します。
$ curl -b cookies -c cookies 'https://api.adnxs.com/bidder-instance/2'
{
"response":{
"status":"OK",
"instances":[
{
"id":14,
"bidder_id":2,
"active":true,
"datacenter_id":6,
"ip_address":"8.12.231.108",
"port":8081,
"last_activity":"2016-12-31 17:07:17"
"hostname":null
},
{
"id":53,
"bidder_id":2,
"active":true,
"datacenter_id":4,
"ip_address":"64.210.63.124",
"port":8081,
"last_activity":"2016-12-31 19:51:13"
"hostname":"rtb.yourdomain.com" }
]
}
}