Prebid Demand Partner Params サービス
Prebid Demand Partner Params Service を使用すると、ユーザーは PSP 構成で特定のパートナーを表示、追加、削除、有効化、無効化できます。 構成は 、構成サービスを使用して管理されます。 要求パートナーは、パラメーター サービスの構成に追加する前に、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} | 特定の Prebid 構成のすべての Prebid demand パートナー パラメーターを取得します。 |
GET |
https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId} | 特定の Prebid demand パートナー パラメーターを取得します。 最後の 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} | 特定の Prebid Demand パートナー パラメーターを更新します。 URL パスの最後のコンポーネントとして param ID を含めます。 |
DELETE |
https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId} | 特定の Prebid Demand パートナー パラメーターを削除します。 最後の 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 |
ブール値 | このパートナーの params オブジェクトが削除されているかどうかを示します。 |
enabled |
ブール値 | Prebid Demand パートナーパラメーターが有効または無効になっているかどうかを示します。 |
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 オブジェクトの作成を有効にします。
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
},
"enabled": 1
}
パラメーター
名前 | 型 | 範囲 | 説明 |
---|---|---|---|
name |
string | 必須 | Prebid デマンド パートナーの名前。 |
enabled |
ブール値 | 必須 | Prebid Demand パートナーパラメーターが有効または無効になっているかどうかを示します。 |
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
既存の Prebid Demand パートナー パラメーターを上書きします。 URL パスの最後のコンポーネントとして prebidDemandPartnerParamId
を含めます。 要求の本文に更新情報を JSON として渡します。
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
},
"enabled": 0
}
PUT
:応答
Prebid demand partner param オブジェクトを返します。
DELETE
既存の Prebid Demand パートナー パラメーターを削除します。 パスの最後のコンポーネントとして prebidSettingsId
を含めます。
DELETE
: cURL を使用した呼び出しの例
curl -X DELETE https://api.appnexus.com/prebid/prebid-demand-partner-params/{prebidDemandPartnerParamId}
DELETE
:応答
成功すると、Prebid demand partner param オブジェクトが JSON オブジェクトとして返され、削除されたプロパティが true に設定されます。 Prebid 需要パートナーパラメーターは、システムで使用できなくなります。 サブオブジェクトも削除されます。