パートナー間設定サービスを使用すると、Prebid Server Premium (PSP) のメンバーのメンバー全体の設定を取得および編集できます。 これには、グローバル入札者のタイムアウト、入札の価格粒度の詳細、および通貨設定が含まれます。 パートナー間設定は、 UI のグローバル設定です。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
GET |
https://api.appnexus.com/prebid/cross-partner-settings | 呼び出し元のメンバーのすべてのクロス パートナー設定を取得します。 |
POST |
https://api.appnexus.com/prebid/cross-partner-settings | 新しいパートナー間設定を作成します。 リクエストの本文でクロスパートナー設定を JSON として渡します。 |
PUT |
https://api.appnexus.com/prebid/cross-partner-settings | 既存のパートナー間設定を更新します。 要求の本文で、更新されたクロスパートナー設定を JSON として渡します。 |
PATCH |
https://api.appnexus.com/prebid/cross-partner-settings | 既存のパートナー間設定の一部を更新します。 要求の本文で、更新されたクロスパートナー設定を JSON として渡します。 |
GET
メンバーのすべてのグローバル PSP 設定を取得します。
応答
正常な応答では、メンバー全体の設定を含む JSON が返されます。
| プロパティ | 型 | 説明 |
|---|---|---|
bidder_timeout_ms |
integer | Prebid Server Premium パートナーおよびマーケットプレースのその他の入札者が応答できる最大時間 (ミリ秒単位)。 |
deleted |
integer | クロスパートナー設定が削除されたかどうかを示します。 指定できる値は次のとおりです。 0 = active, 1 = 削除済み |
id |
integer | パートナー間設定オブジェクトの一意識別子。 |
last_modified |
string | パートナー間設定オブジェクトの最終変更日。 |
last_modified_by |
string | パートナー間設定オブジェクトを最後に変更したユーザー。 |
member_id |
integer | パートナー間設定オブジェクトが属するメンバーの一意の識別子。 |
price_granularity |
object | デマンド パートナーの入札が広告サーバーでグループ化される CPM 価格バケットを定義します。 以下の 価格の粒度の表 を参照してください。 |
注:
完全なタイムアウト階層 (優先度が高いから低い順に並べる) は次のとおりです。
- デバッグ オークション タイムアウト値 (2000ms) [if debug=1/true]。
- 発行元によって設定された広告要求
auction_timeout_ms値。 - 配置レベルの
auction_timeout_ms値。 この値を設定するには、Microsoft の担当者にお問い合わせください。 - PSP グローバル設定 (クロス パートナー) パブリッシャーによって設定されたタイムアウト値。 こちらのガ イダンスを参照してください。
- 特定のデータ センターのメンバー レベルの
default_auction_timeout_ms値。 この値を設定するには、Microsoft の担当者にお問い合わせください。 - メンバー レベルの
default_auction_timeout_ms値。 この値を設定するには、Microsoft の担当者にお問い合わせください。 - Microsoft データ センター/グローバル既定値 (150 ミリ秒)。
価格の細分性
価格の粒度は、デマンド パートナーの入札が広告サーバーでグループ化される CPM 価格バケットを定義します。 詳細については、 Prebid のドキュメントを参照してください。
| プロパティ | 型 | 説明 |
|---|---|---|
label |
string | 入札前のドキュメントで定義されているスケールの種類 (低、中、高、自動、密度、カスタム)。 |
ranges |
配列 | 価格の粒度範囲を記述するコンテナー オブジェクト。 |
ranges.max |
integer | 範囲の最大長。 |
ranges.increment |
浮動小数点数 | 範囲内でインクリメントする量。 |
precision |
integer | 価格を丸める小数点以下の桁数。 既定値は 2 であるため、価格 2.1234 は小数点以下 2 桁の 2.12 に四捨五入されます。 |
currency_code |
文字列 | 価格バケットの計算に必要な通貨コードを含む文字列。 Microsoft が承認した通貨のリストの一部である必要があります。 |
応答の例
{
"id":5,
"member_id":13859,
"bidder_timeout_ms":250,
"price_granularity":{
"label":"Dense",
"ranges":[
{
"max":3,
"increment":0.01
},
{
"max":8,
"increment":0.05
},
{
"max":20,
"increment":0.5
}
],
"currency_code":"USD",
"precision":2
},
"last_modified":"2019-10-31T17:37:50Z",
"last_modified_by":"user123",
"deleted":0
}
POST
新しいパートナー間設定を作成します。
POST curl を使用した呼び出しの例
curl https://api.appnexus.com/prebid/cross-partner-settings
POST JSON の例
{
"id":123,
"member_id":13859,
"bidder_timeout_ms":995,
"price_granularity":{
"label":"Dense",
"ranges":[
{
"max":3,
"increment":0.01
},
{
"max":8,
"increment":0.05
},
{
"max":20,
"increment":0.5
}
],
"precision":2,
"currency_code":"USD"
}
}
POST: パラメーター
| プロパティ | 型 | 範囲 | 説明 |
|---|---|---|---|
bidder_timeout_ms |
integer | 必須 | Prebid Server Premium パートナーおよびマーケットプレースのその他の入札者が応答できる最大時間 (ミリ秒単位)。 |
price_granularity |
object | 必須 | 価格の粒度の設定。 このオブジェクトの詳細については、以下の 価格粒度の表 を参照してください。 |
POST: 価格の細分性
価格の粒度は、デマンド パートナーの入札が広告サーバーでグループ化される CPM 価格バケットを定義します。 詳細については、 Prebid のドキュメントを参照してください。
| プロパティ | 型 | 範囲 | 説明 |
|---|---|---|---|
label |
配列 | 必須 | 入札前のドキュメントで定義されているスケールの種類 (低、中、高、自動、密度、カスタム)。 |
ranges |
配列 | 必須 | 価格の粒度範囲を記述するコンテナー オブジェクト。 |
ranges.max |
integer | 必須 | 範囲の最大長。 |
ranges.increment |
浮動小数点数 | 必須 | 範囲内でインクリメントする量。 |
precision |
integer | 必須 | 価格を丸める小数点以下の桁数。 既定値は 2 であるため、価格 2.1234 は小数点以下 2 桁の 2.12 に四捨五入されます。 |
currency_code |
string | 必須 | 価格バケットの計算に必要な通貨コードを含む文字列。 Microsoft が承認した通貨のリストの一部である必要があります。 |
PUT
既存のパートナー間設定を上書きします。 要求の本文で、情報を JSON として渡します。
curl を使用した呼び出しの例
curl https://api.appnexus.com/prebid/cross-partner-settings
JSON の例
{
"id": 450,
"bidder_timeout_ms": 400,
"price_granularity": {
"label": "Auto",
"currency_code": "USD",
"precision": 2,
"ranges": [
{
"max": 5,
"increment": 0.05
},
{
"max": 10,
"increment": 0.1
},
{
"max": 20,
"increment": 0.5
}
]
}
}
応答
更新された Prebid 需要パートナー オブジェクトを返します。
PATCH
既存のパートナー間設定をUpdatesします。 要求の本文で、情報を JSON として渡します。
curl を使用した呼び出しの例
curl https://api.appnexus.com/prebid/cross-partner-settings
JSON の例
{
"bidder_timeout_ms": 500
}
応答
更新された Prebid demand partner オブジェクトを返します。