Prebid Demand Partner Params Service を使用すると、ユーザーは PSP 構成上の特定のパートナーを表示、追加、削除、有効、無効にすることができます。 構成は、 構成サービスを介して管理されます。 デマンド パートナーを params サービスの任意の構成に追加し、Prebid Server Premium (PSP) を介して入札要求を受け取る前に、クロス パートナー設定サービス でデマンド パートナーを有効にする必要があります。 パートナー間設定に存在しないパートナーを追加しようとすると、エラーが発生します。
注:
パートナーは構成レベルでこのサービスを介して無効にできますが、 パートナー間設定サービス でパートナーに今後の変更を加えると、個々の構成が上書きされ、すべての構成でパートナーが有効/無効になります。 各パートナーがサポートするパラメーターの詳細については、「 Demand Partner Schema Service」を参照してください。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
GET |
- https://api.appnexus.com/prebid/prebid-demand-partner-params?prebid_settings_id={prebid_settings_id} | 特定の事前入札構成のすべての事前入札需要パートナー パラメーターを取得します。 |
GET |
https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId} | 特定の入札前デマンド パートナー パラメーターを取得します。 最後の URL パス コンポーネントとして param ID を含めます。 |
POST |
https://api.appnexus.com/prebid/prebid-demand-partner-params | 新しい需要パートナー パラメーターを作成します。 例と応答cURLについては、以下のPOSTセクションを参照してください。 |
PUT |
https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId} | 特定の入札前デマンド パートナー パラメーターを更新します。 URL パスの最後のコンポーネントとして param ID を含めます。 |
DELETE |
https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId} | 特定の入札前デマンド パートナー パラメーターを削除します。 最後の URL パス コンポーネントとして param ID を含めます。 |
GET
PSP 構成内の需要パートナー パラメーターのすべてまたは特定のセットを返します。 URL の最後のコンポーネントとして、パラメーターの prebid_settings_id (構成) または ID のいずれかを含めます。
cURL を使用して特定のパラメーターを返す呼び出しの例
curl --header "Content-Type: application/json" https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId}
cURL を使用して特定の構成のすべてのパラメーターを返す呼び出しの例
curl --header "Content-Type: application/json" https://api.appnexus.com/prebid/prebid-demand-partner-params?prebid_settings_id={prebid_settings_id}
応答
正常な応答は、要求された Prebid 構成または特定の要求されたパラメーターのすべてのパラメーターを返します。
| プロパティ | 型 | 説明 |
|---|---|---|
deleted |
integer | このパートナーの params オブジェクトが削除されているかどうかを示します。 指定できる値は次のとおりです。 0 = active, 1 = 削除済み |
enabled |
integer | デ マンド パートナー サービスを介してデマンド パートナーが有効か無効かを示します。 指定できる値は次のとおりです。1 = 有効, 0 = 無効 |
id |
integer | PSP 構成のデマンド パートナーに関連付けられたパラメーター セットの一意識別子。 |
last_modified |
string | デマンド パートナー構成パラメーターの最新の変更日。 |
last_modified_by |
string | デマンド パートナー パラメーターに最終変更を行ったユーザー。 |
member_id |
integer | 呼び出し元のメンバー ID。 |
name |
object | デマンド パートナーの名前。 |
params |
object | パートナーがサポートするパラメーターとマップされた値を含むオブジェクト。 サポートされているパラメーターは 、こちらにあります。 |
prebid_settings_id |
integer | PSP 構成の一意の識別子。 |
応答の例
[
{
"id": 1718542,
"member_id": 13859,
"prebid_settings_id": 196038,
"name": "appnexus",
"params": {
"placement_id": 123456
},
"enabled": 0,
"deleted": 0,
"last_modified_by": "user123",
"last_modified": "2024-08-22T21:45:05.000Z"
}
]
POST
新しい Prebid Demand Partner Param オブジェクトの作成を有効にします。
このサービスへの要求には、 enabled フィールドを含めてはなりません。 この値は、 デマンド パートナー サービスのパートナーの状態から継承されます。
cURL を使用した呼び出しの例
curl -d @demand-partner-params.json -X POST --header "Content-Type: application/json" 'https://api.appnexus.com/prebid/prebid-demand-partner-params'
JSON 要求の例
{
"prebid_settings_id": 196038,
"member_id": 13859,
"name": "adform",
"params": {
"inv": null,
"mid": "11111111",
"mname": null,
"priceType": null
}
}
パラメーター
| 名前 | 型 | 範囲 | 説明 |
|---|---|---|---|
name |
string | 必須 | Prebid デマンド パートナーの名前。 |
member_id |
integer | 必須 | 構成に関連付けられているメンバーの ID。 |
params |
object | 必須 | パートナーがサポートするパラメーターとマップされた値を含むオブジェクト。 サポートされているパラメーターは 、こちらにあります。 |
prebid_settings_id |
integer | 必須 | PSP 構成の一意識別子。 |
POST: 応答の例
[
{
"id": 1718543,
"member_id": 13859,
"prebid_settings_id": 196038,
"name": "adform",
"params": {
"inv": null,
"mid": "11111111",
"mname": null,
"priceType": null
},
"enabled": 1,
"deleted": 0,
"last_modified_by": "user123",
"last_modified": "2024-08-22T22:40:21.000Z"
}
]
PUT
既存の入札前需要パートナー パラメーターを上書きします。 URL パスの最後のコンポーネントとして prebidDemandPartnerParamId を含めます。 要求の本文で更新情報を JSON として渡します。
このサービスへの要求には、 enabled フィールドを含めてはなりません。 この値は、 デマンド パートナー サービスのパートナーの状態から継承されます。
PUT: cURL を使用した呼び出しの例
curl -d @config-update.json -X PUT --header "Content-Type: application/json https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId}
JSON 要求の例
{
"member_id": 13859,
"prebid_settings_id": 196038,
"name": "adform",
"params": {
"inv": null,
"mid": "11111111",
"mname": null,
"priceType": null
}
}
PUT: 応答
Prebid demand partner param オブジェクトを返します。
DELETE
既存の Prebid デマンド パートナー パラメーターを削除します。 パスの最後のコンポーネントとして prebidSettingsId を含めます。
DELETE: cURL を使用した呼び出しの例
curl -X DELETE https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId}
DELETE: 応答
成功すると、Prebid demand partner param オブジェクトが、deleted プロパティが 1 に設定された JSON オブジェクトとして返されます。 Prebid 需要パートナー パラメーターは、システムで使用できなくなります。 すべてのサブオブジェクトも削除されます。