Configuration Service

インベントリが Prebid Server Premium (PSP) と統合され、 パートナー間設定 が確認され、 需要パートナー が有効になったら、PSP 構成を使用してインベントリを需要パートナーにマップする必要があります。 これらのマッピングを使用すると、PSP は需要パートナーのパラメーターを使用して入札要求を送信できるため、パートナーは在庫を特定し、購入者に対してより適切に表現し、歩留まりを高め、フロアや広告品質などのパブリッシャー設定を尊重できます。

• 各構成は、柔軟なターゲット設定のセット (地域、インベントリの種類、キー値など) または収益化オブジェクト (配置、配置グループ、発行元) を明示的に指定することによって、収益化のパブリッシャー インベントリの一部を対象とします。
• 各構成には、パブリッシャーがインベントリに入札する 1 つ以上の需要パートナーが含まれています
• 各デマンド パートナーは、PSP で表示される オープンソースの Prebid Server Go アダプターで受け取る必要なパラメーターと省略可能なパラメーターを指定します。 これにより、パートナーは、プラットフォーム内のオブジェクトに入札要求を一致させることができます
• パブリッシャーは、各パートナーのプラットフォーム (通常は別のサプライ側プラットフォーム (SSP) のオブジェクトにマップされた値を使用して、需要パートナー パラメーターに入力します

需要パートナーの要件

パブリッシャーが PSP 構成で定義されているインベントリに対して入札を希望するすべての需要パートナーは、同じ構成に追加する必要があります。 構成の最初のセットを作成する前に、計画されている PSP 需要パートナーごとに要件を確認して、マッピング戦略を決定します。 一部のパートナーは、入札要求 (広告サイズ、地理的な場所、言語など) から情報を動的にプルしますが、他のパートナーは個別のパラメーター マッピングと PSP 構成を必要とする場合があります。 需要パートナーがプラットフォーム内のオブジェクトへの非常に詳細なマッピングを必要とする場合は、他のパートナーのマッピング方法と必要な構成の数が決まります。 需要パートナーが (入札要求または静的な Prebid パラメーターを使用して) 在庫を識別できるほど、購入者に提供できる情報が増え、発行元の収益が増加します。

需要パートナー パラメーターは次のとおりです。

• PSP 構成サービスでは、以下で詳しく説明するように、または UI 自体内で実行します 。
• 完全なコンテキストと詳細を提供する Prebid サイト。
• PSP 要求パートナー スキーマ サービスで。

以下のドキュメントでは、API を使用して構成を作成および管理する方法について説明します。 構成は 、UI を使用して管理することもできます。

REST API

GET

呼び出し元のメンバーのすべての Prebid 構成を返します。 結果は JSON として返されます。

パラメーター

状態フィルター引数を使用した curl を使用した呼び出しの例

curl --header "Content-Type: application/json" https://api.appnexus.com/prebid/config?status_filter=enabled

curl を使用して特定の構成を返す呼び出しの例

構成 ID を URL の最後のコンポーネントとして追加します。

curl --header "Content-Type: application/json"https://api.appnexus.com/prebid/config/{prebidSettingsId}

応答

応答が成功すると、メンバーのクロスパートナー設定とそのすべての PSP 構成を含む JSON が返されます。 クエリ文字列に特定の prebidSettingsId を含めると、その構成のみを含む応答が発生します。

需要パートナーの設定

構成プロパティ

メディアの種類

メディア タイプ オブジェクトは、要求パートナーへの要求に含まれる形式 (現在バナー、ネイティブ、およびビデオ) と広告サイズを決定します。

メタデータ プロパティのターゲット設定

デマンド パートナー構成のプロパティ

価格の細分性

価格粒度は、需要パートナーの入札を広告サーバーにグループ化する CPM 価格バケットを定義します。 これは、 クロスパートナー設定サービスで定義されます。

改ページ

応答の数は、 num_elements 引数を渡すことによって制限できます。 start_element引数を使用して、表示を開始する要素を設定できます。

15 個の結果に制限し、10 番目の要素で結果を開始する呼び出しの例

返される要素は、10 日から 25 日の間にインデックスが作成されます。

GET https://api.appnexus.com/prebid/config?num_element=15&start_element=10

応答の例

{
  "id": 450,
  "member_id": 13859,
  "bidder_timeout_ms": 500,
  "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
      }
    ]
  },
  "deleted": 0,
  "last_modified_by": "user123",
  "last_modified": "2024-08-21T16:37:24.000Z",
  "demand_partner_settings": {
    "appnexus": {
      "id": 2045,
      "bid_cpm_adjustment": 0.7,
      "enabled": 1
    },
    "openx": {
      "id": 2065,
      "bid_cpm_adjustment": 1,
      "enabled": 0
    },
    "ix": {
      "id": 2106,
      "bid_cpm_adjustment": 0.9,
      "enabled": 1
    },
    "adform": {
      "id": 2110,
      "bid_cpm_adjustment": 1,
      "enabled": 1
    }
  },
  "total_configs": 2,
  "configs": [
    {
      "id": 87053,
      "member_id": 13859,
      "name": "ConfigName1",
      "targeting_level_code": 1,
      "targeting_id": 25172737,
      "enabled": 1,
      "media_types": {
        "sizes": [],
        "types": [
          "video"
        ]
      },
      "targeting_metadata": {
        "os_family_ids": []
      },
      "deleted": 0,
      "last_modified_by": "user123",
      "last_modified": "2024-07-17T18:17:56.000Z",
      "targeting_level_name": "placement",
      "demand_partner_config_params": [
        {
          "id": 619584,
          "member_id": 13859,
          "prebid_settings_id": 87053,
          "name": "ix",
          "params": {
            "size": null,
            "siteId": "yyy.com"
          },
          "enabled": 1,
          "deleted": 0,
          "last_modified_by": "user123",
          "last_modified": "2024-07-17T18:36:40.000Z"
        }
      ]
    },
    {
      "id": 87784,
      "member_id": 13859,
      "name": "ConfigName2",
      "targeting_level_code": 1,
      "targeting_id": 25175861,
      "enabled": 1,
      "media_types": {
        "sizes": [],
        "types": [
          "banner",
          "video",
          "native"
        ]
      },
      "targeting_metadata": {
        "os_family_ids": []
      },
      "deleted": 0,
      "last_modified_by": "user123",
      "last_modified": "2024-07-31T21:34:34.000Z",
      "targeting_level_name": "placement",
      "demand_partner_config_params": [
        {
          "id": 619080,
          "member_id": 13859,
          "prebid_settings_id": 87784,
          "name": "openx",
          "params": {
            "unit": "3456",
            "platform": null,
            "delDomain": "abc.com",
            "customFloor": null,
            "customParams": null
          },
          "enabled": 0,
          "deleted": 0,
          "last_modified_by": "user123",
          "last_modified": "2024-08-21T21:10:28.000Z"
        },
        {
          "id": 619081,
          "member_id": 13859,
          "prebid_settings_id": 87784,
          "name": "ix",
          "params": {
            "size": null,
            "siteId": "abc.com"
          },
          "enabled": 1,
          "deleted": 0,
          "last_modified_by": "user123",
          "last_modified": "2024-07-17T18:36:06.000Z"
        },
        {
          "id": 625915,
          "member_id": 13859,
          "prebid_settings_id": 87784,
          "name": "adform",
          "params": {
            "inv": null,
            "mid": "1414158",
            "mname": null,
            "priceType": null
          },
          "enabled": 1,
          "deleted": 0,
          "last_modified_by": "user123",
          "last_modified": "2024-07-17T18:36:09.000Z"
        }
      ]
    }
  ]
}

       

POST

新しい構成オブジェクトの作成を有効にします。

curl を使用した呼び出しの例

curl -d @config.json -X POST --header "Content-Type: application/json" 'https://api.appnexus.com/prebid/config'

POST: パラメーター

POST: パートナー構成のプロパティを要求する

POST: メディアの種類

メディア タイプ オブジェクトは、要求パートナーへの要求に含まれる形式 (現在バナー、ネイティブ、およびビデオ) と広告サイズを決定します。

POST: メタデータ プロパティのターゲット設定

JSON 要求の例

{
    "name": "ConfigName1",
    "targeting_level_code": 4,
    "targeting_id": 25401118,
    "enabled": true,
    "media_types": {
        "sizes": [
            {
                "height": 300,
                "width": 250
            }
        ],
        "types": [
            "banner",
            "video",
            "native"
        ]
    },
    "targeting_metadata": {
        "priority": 20
    },
    "demand_partner_config_params": [
        {
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            }
        }
    ]
}           
            

応答

正常に応答すると、新しい構成オブジェクトが返されます。

POST: JSON 応答の例

[
  {
    "id": 196038,
    "member_id": 13859,
    "name": "ConfigName1",
    "targeting_level_code": 4,
    "targeting_id": 22378872,
    "enabled": 1,
    "media_types": {
      "sizes": [
        {
          "height": 300,
          "width": 250
        }
      ],
      "types": [
        "banner",
        "native",
        "video"
      ]
    },
    "targeting_metadata": {
      "priority": 20
    },
    "deleted": 0,
    "last_modified_by": "user123",
    "last_modified": "2024-08-22T21:24:40.000Z",
    "demand_partner_config_params": [
      {
        "id": 1718542,
        "member_id": 13859,
        "prebid_settings_id": 196038,
        "name": "appnexus",
        "params": {
          "placement_id": 123456
        },
        "enabled": 1,
        "deleted": 0,
        "last_modified_by": "user123",
        "last_modified": "2024-08-22T21:24:40.000Z"
      }
    ]
  }
]          
                

PUT

既存の Prebid 構成を上書きします。 URL パスの最後のコンポーネントとして prebidSettingsId を含めます。 要求の本文に更新情報を JSON として渡します。

PUT: curl を使用した呼び出しの例

curl -d @config-update.json -X PUT --header "Content-Type: application/json https://api.appnexus.com/prebid/config/{prebidSettingsId}

PUT: JSON 要求の例

{
    "name": "ConfigName1",
    "targeting_level_code": 4,
    "targeting_id": 22378872,
    "enabled": 0,
    "media_types": {
        "sizes": [
            {
                "height": 300,
                "width": 250
            }
        ],
        "types": [
            "banner",
            "native",
            "video"
        ]
    },
    "targeting_metadata": {
        "priority": 20
    },
    "demand_partner_config_params": [
        {
            "id": 1718542,
            "member_id": 13859,
            "prebid_settings_id": 196038,
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            },
            "enabled": 1
        }
    ]
}

PUT: 応答

Prebid 構成オブジェクトを返します。

PATCH

既存の Prebid 構成を部分的に更新します。 パスの最後のコンポーネントとして prebidSettingsId を含めます。 要求の本文に更新情報を JSON として渡します。 要求には、更新する他の要素を含む最上位の config オブジェクトが含まれている必要があります。

PATCH: curl を使用した呼び出しの例

curl -d @config-update.json -X PATCH --header "Content-Type: application/json https://api.appnexus.com/prebid/config/{prebidSettingsId}

PATCH: JSON 要求の例

{
    "config": {
        "enabled": 0,
        "media_types": {
            "types": [
                "banner"
            ]
        }
    }
}

PATCH: 応答

Prebid 構成オブジェクトを返します。

DELETE

既存の Prebid 構成を削除します。 パスの最後のコンポーネントとして prebidSettingsId を含めます。

DELETE: curl を使用した呼び出しの例

curl -X DELETE https://api.appnexus.com/prebid/config/{prebidSettingsId}

DELETE: 応答

成功すると、示された構成は JSON オブジェクトとして返され、削除されたプロパティは true に設定されます。 システム内では使用できなくなります。 すべてのサブオブジェクトも削除されます。

関連項目

• PSP キャンペーン オブジェクト サービス
• Demand Partner Schema Service
• デマンド パートナー サービス
• Prebid Demand Partner Params Service
• 広告サイズ サービス
• Media Type Service
• クロスパートナー設定サービス
• 新しい PSP 構成を作成する
• Prebid Server Premium Demand パートナー統合
• 一般的な問題とベスト プラクティス