構成サービス

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

  • 各構成は、配置、配置グループ、パブリッシャー、地域、在庫タイプ、キーと値などの 1 つ以上のディメンションを使用して、Monetize のパブリッシャー インベントリの一部をターゲットとします。
  • 各構成には、パブリッシャーがインベントリに入札する 1 つ以上の需要パートナーが含まれています
  • 各デマンド パートナーは、 PSP に表示されるオープンソースの Prebid Server Go アダプターで受け取る必須パラメーターとオプション パラメーターを指定します。 これにより、パートナーは入札要求をプラットフォーム内のオブジェクトと一致させることができます
  • パブリッシャーは、各パートナーのプラットフォーム (通常は別のサプライサイド プラットフォーム (SSP) 内のオブジェクトにマップされた値を使用して、デマンド パートナーのパラメーターを入力します

デマンド パートナーの要件

パブリッシャーが PSP 構成で定義されたインベントリに入札するすべての需要パートナーを、同じ構成に追加する必要があります。 最初の構成セットを作成する前に、計画されている各 PSP 需要パートナーで要件を確認して、マッピング戦略を決定します。 入札要求から情報 (広告サイズ、地域、言語など) を動的にプルするパートナーもあれば、個別のパラメーター マッピングや PSP 構成を必要とするパートナーもあります。 デマンド パートナーがプラットフォーム内のオブジェクトに対して非常に細かいマッピングを必要とする場合、それによって他のパートナーのマッピング方法と必要な構成の数が決まります。 デマンド パートナーが (入札要求または静的な事前入札パラメーターのいずれかを通じて) インベントリをより適切に識別できればなるほど、購入者に提供できる情報が増え、パブリッシャーの収益が増加します。

デマンド パートナー パラメーターを以下に示します。

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

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/prebid/config すべての Prebid 構成を返します。
GET https://api.appnexus.com/prebid/config/{prebidSettingsId} 特定の Prebid 構成を返します。
POST https://api.appnexus.com/prebid/config 新しい Prebid 構成を追加します。
PUT https://api.appnexus.com/prebid/config/{prebidSettingsId} 既存の Prebid 構成を更新します。
PATCH https://api.appnexus.com/prebid/config/{prebidSettingsId} 既存の Prebid 構成の一部を更新します。
DELETE https://api.appnexus.com/prebid/config/{prebidSettingsId} 既存の Prebid 構成を削除します。

GET

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

パラメーター

プロパティ 範囲 説明
status_filter string 省略可能 構成が有効か無効かに基づいて結果をフィルター処理します。 クエリに status_filter 引数を渡し、値を enabled または disabled に設定します。

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

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

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

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

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

応答

正常な応答は、メンバーのパートナー間設定とすべての PSP 構成を含む JSON を返します。 クエリ文字列に特定の prebidSettingsId を含めると、その構成のみを含む応答になります。

プロパティ 説明
bidder_timeout_ms integer これは、 cross-partner-settings サービスで定義されます。
configs 配列 メンバーまたは特定の構成オブジェクトの構成オブジェクトを含むコンテナー。 構成オブジェクトに含まれる項目については、以下の 構成プロパティ 表を参照してください。
deleted integer オブジェクトが削除されたかどうかを示します。 指定できる値は次のとおりです。
0 = active,
1 = 削除済み
demand_partner_settings 配列 デマンド パートナー プロパティ。 demand_partner_settings オブジェクトに含まれるアイテムについては、以下のデマンド パートナー設定表を参照してください。
id integer - 要求で prebidSettingsIdが指定されていない場合、応答の最初の ID は、メンバーの一意の パートナー間設定 ID を表します。 configs オブジェクトには、各構成の ID 値が含まれます。
- 要求で prebidSettingsIdを指定すると、それが応答の一意の識別子になります。 この ID は、この API の他のエンドポイントでは prebid_settings_id と呼ばれます。
last_modified string 構成オブジェクトの最新の変更日。
last_modified_by string 構成オブジェクトに対して最後の変更を行ったユーザー。
member_id integer 構成に関連付けられているメンバーの ID。
price_granularity object デマンド パートナーの入札が広告サーバー内でグループ化される CPM 価格バケットを定義します。 以下の 価格の粒度 の表を参照してください。 オブジェクトは、 cross-partner-settings サービスを介して管理されます。
total_configs integer 返された構成の数。

パートナーの設定を要求します

プロパティ 説明
bid_cpm_adjustment 浮動小数点数 オークションでの入札の競争力を調整するために、デマンド パートナーの CPM 入札価格に適用される乗数値。 詳細については、 Demand Partner Service を参照してください。
enabled integer デマンド パートナーが有効か無効かを示します。 指定できる値は次のとおりです。
1= 有効,
0= 無効
id integer デマンド パートナー設定の ID。
name string デマンド パートナーの名前。 詳細については、 Demand Partner Service を参照してください。

構成プロパティ

プロパティ 説明
deleted integer 構成オブジェクトは使用できないが、そのデータはまだ表示できることを示します。 指定できる値は次のとおりです。
0 = active,
1 = 削除済み
demand_partner_config_params 配列 デマンド パートナーのアダプター パラメーターと、PSP からの入札要求で受け取る値を含むコンテナー。 demand_partner_config_params オブジェクトに含まれるアイテムについては、以下のデマンド パートナー構成プロパティ テーブルを参照してください。
enabled integer 構成が有効か無効かを示します。 指定できる値は次のとおりです。
1= 有効,
0= 無効
id integer この ID は、API の他のエンドポイントでは prebid_settings_id と呼ばれます。
last_modified string 構成の最新の変更日。 日付/時刻として書式設定されます。
last_modified_by string 構成オブジェクトに対して最後の変更を行ったユーザー。
member_id integer 構成に関連付けられているメンバーの ID。
name string 構成の名前。
targeting_level_code integer 構成に関連付けられているオブジェクトのタイプ:
- 4 ライン アイテム/ターゲティング プロファイル
targeting_id integer 構成が関連付けられているオブジェクト (明細行品目など) の識別子。 要求は、入札要求がライン アイテムまたはプロファイルのターゲティングと一致する場合に、デマンド パートナーに送信されます。 ライン アイテムは、 PSP キャンペーン オブジェクト サービスによって作成された 'psp' サブタイプである必要があります。これにより、ライン アイテムが自動的に作成され、プロファイルにリンクされます。
targeting_metadata object ターゲット オブジェクトの修飾子が含まれます。 targeting_metadata オブジェクトに含まれる項目の詳細については、ターゲティング メタデータ プロパティ テーブルを参照してください。 targeting_metadata.priority フィールドは必須です。
psp_profile object profile オブジェクトは、PSP 構成に入札要求を照合するために使用される在庫ターゲティング属性を定義します。

プロファイルは次のいずれかです。
1. PSP UI を使用すると自動生成される、または
2. psp-campaign-objects API を介したユーザー入力に基づいて作成されます。

プロファイルを変更するには、 psp-campaign-objects API を使用します。 構成サービスは、GET応答でのみ psp_profile オブジェクトを返します。

ターゲティング メタデータ プロパティ

プロパティ 説明
priority integer 各オークションでは、1 つの PSP 構成とそのデマンド パートナー パラメーターのセットが使用されます。
複数の構成がオークションに一致する場合:
  - ユーザー定義の 優先度 が最も高い構成が選択されます。
  - 複数の構成が同じ 優先度を共有する場合は、ID が高い (より新しい) ものが使用されます。

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

プロパティ 説明
deleted integer 構成オブジェクトは使用できないが、そのデータはまだ表示できることを示します。 指定できる値は次のとおりです。
0 = active,
1 = 削除済み
enabled integer デマンド パートナーが有効か無効かを示します。 詳細については、 デマンド パートナー サービスを参照してください。
指定できる値は次のとおりです。
1= 有効,
0= 無効
id integer 特定のデマンド パートナーのパラメーター マッピングの ID。
last_modified string demand_partner_configの最新の変更日。
last_modified_by string demand_partner_configに最終変更を行ったユーザー。
member_id integer demand_partner_configに関連付けられているmember_id。
name string デマンド パートナーの 事前入札者名
params object パートナー固有のパラメーターとマップされた値。 詳細については、 デマンド パートナー パラメーター サービスを参照してください。
prebid_settings_id integer 複数の需要パートナー パラメーター マッピングを含めることができる構成の ID。

価格の細分性

価格の粒度は、デマンド パートナーの入札が広告サーバーでグループ化される CPM 価格バケットを定義します。 これは、 Cross-Partner Settings Service で定義されます。

プロパティ 説明
currency_code string 価格バケットの計算に必要な通貨コードを含む文字列。 Microsoft が承認した通貨リストの一部である必要があります。
label string 入札前のドキュメントで定義されているスケールの種類 (低、中、高、自動、密度、カスタム)。 cross-partner-settings サービスを参照してください。
precision integer 価格を丸める小数点以下の桁数。 既定値は小数点以下 2 桁であるため、価格 2.1234 は 2.12 に丸められます。
ranges object 価格の粒度範囲を記述するコンテナー オブジェクト。
ranges.max integer 範囲の最大長。
ranges.increment 浮動小数点数 範囲内でインクリメントする量。

プロファイル

profile オブジェクトには、入札要求を PSP 構成に照合するために使用されるインベントリ ターゲティング属性が含まれます。

プロフィールは次のとおりです。

  • PSP UI を使用すると自動的に生成される、または
  • psp-campaign-objects API を介してユーザー入力から作成されます。

プロファイルを更新するには、 psp-campaign-objects API を使用します。 構成サービスは、GET応答でのみ psp_profile オブジェクトを返します。

プロパティ 説明
psp_profile object PSP 構成をトリガーするパブリッシャーの入札要求を決定します。 構造と詳細については、 プロファイルサービスの ドキュメントを参照してください。 このオブジェクトは、PSP UI または psp-campaign-objects サービスを介して作成および更新されます。

改ページ

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

プロパティ 説明
num_elements int 返す要素の数。 たとえば、オブジェクト #4 から開始して 3 つのオブジェクト、つまり #4、5、6 を返します。
start_element int カウントを開始する数。

結果を 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": 4,
      "targeting_id": 25172737,
      "enabled": 1,
      "targeting_metadata": {
        "priority": 10
      },
      "deleted": 0,
      "last_modified_by": "user123",
      "last_modified": "2024-07-17T18:17:56.000Z",
      "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"
        }
      ],
      "psp_profile": {
        "id": 147870841,
        "description": "",
        "country_action": "include",
        "supply_type_action": "include",
        "advertiser_id": 11125655,
        "created_on": "2025-10-23 18:02:50",
        "country_targets": [
          {
            "id": 59,
            "name": "Germany",
            "code": "DE",
            "active": true
          },
          {
            "id": 233,
            "name": "United States",
            "code": "US",
            "active": true
          }
        ],
        "supply_type_targets": [
          "mobile_app",
          "mobile_web",
          "web"
        ],
        "ad_type_targets": [
          {
            "id": 2,
            "name": "video"
          }
        ],
        "placement_targets": [
          {
            "id": 36707024,
            "action": "include",
            "name": "Placement Name 1",
            "deleted": 0,
            "site_id": 7908985,
            "site_name": "Placement Group 1",
            "publisher_id": 2545613,
            "publisher_name": "Publisher 1"
          }
        ]
      }
    },
    {
      "id": 87784,
      "member_id": 13859,
      "name": "ConfigName2",
      "targeting_level_code": 4,
      "targeting_id": 25175861,
      "enabled": 1,
      "targeting_metadata": {
        "priority": 10
      },
      "deleted": 0,
      "last_modified_by": "user123",
      "last_modified": "2024-07-31T21:34:34.000Z",
      "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"
        }
      ],
      "psp_profile": {
        "id": 147870841,
        "description": "",
        "country_action": "include",
        "supply_type_action": "include",
        "advertiser_id": 11125655,
        "created_on": "2025-10-23 18:02:50",
        "country_targets": [
          {
            "id": 59,
            "name": "Germany",
            "code": "DE",
            "active": true
          },
          {
            "id": 233,
            "name": "United States",
            "code": "US",
            "active": true
          }
        ],
        "supply_type_targets": [
          "mobile_app",
          "mobile_web",
          "web"
        ],
        "ad_type_targets": [
          {
            "id": 2,
            "name": "video"
          }
        ],
        "placement_targets": [
          {
            "id": 36707024,
            "action": "include",
            "name": "Placement Name 2",
            "deleted": 0,
            "site_id": 7908985,
            "site_name": "Placement Group 2",
            "publisher_id": 2545613,
            "publisher_name": "Publisher 2"
          }
        ]
      }
    }
  ]
}
       

POST

新しい構成オブジェクトの作成を有効にします。 このサービスへの要求には、 demand_partner_config_params.enabled フィールドを含めてはなりません。 この値は、 デマンド パートナー サービスのパートナーの状態から継承されます。

注:

メディアの種類の選択は、構成サービスで定義されなくなりました。 これらの値を定義するには、 PSP キャンペーン オブジェクト サービスのad_type_targets 配列を使用します。

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

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

POST: パラメーター

プロパティ 範囲 説明
demand_partner_config_params 配列 必須 デマンド パートナーのアダプター パラメーターと、PSP からの入札要求で受け取る値を含むコンテナー。 demand_partner_config_params オブジェクトに含まれるアイテムについては、以下のデマンド パートナー構成プロパティ テーブルを参照してください。
enabled integer 必須 構成が有効か無効かを示します。 指定できる値は次のとおりです。
1= 有効,
0= 無効
name string 必須 構成の名前。
targeting_id integer 必須 構成が関連付けられているオブジェクト (明細行品目など) の識別子。 要求は、入札要求がライン アイテムまたはプロファイルのターゲティングと一致する場合に、デマンド パートナーに送信されます。 ライン アイテムは、 PSP キャンペーン オブジェクト サービスによって作成された 'psp' サブタイプである必要があります。これにより、ライン アイテムが自動的に作成され、プロファイルにリンクされます。
targeting_metadata object 省略可能 ターゲット オブジェクトの修飾子が含まれます。 targeting_metadata オブジェクトに含まれるアイテムについては、ターゲティング メタデータ プロパティ テーブルを参照してください。 targeting_metadata.priority 必要ありません。

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

プロパティ 範囲 説明
name string 必須 デマンド パートナーの 事前入札者名
params object 必須 パートナー固有のパラメーターとマップされた値。 詳細については、 デマンド パートナー パラメーター サービスを参照してください。

POST: ターゲティングのメタデータ プロパティ

プロパティ 範囲 説明
priority integer 必須 各オークションでは、1 つの PSP 構成とそのデマンド パートナー パラメーターのセットが使用されます。
複数の構成がオークションに一致する場合:
  - ユーザー定義の 優先度 が最も高い構成が選択されます。
  - 複数の構成が同じ 優先度を共有する場合は、ID が高い (より新しい) ものが使用されます。

JSON 要求の例


{
    "name": "ConfigName1",
    "targeting_id": 22378872,
    "enabled": 0,
    "targeting_metadata": {
        "priority": 20
    },
    "demand_partner_config_params": [
        {
            "id": 1718542,
            "member_id": 13859,
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            }
        }
    ]
}
            

応答

正常な応答は、新しい構成オブジェクトを返します。

POST: JSON 応答の例

{
    "id": 196038,
    "member_id": 13859,
    "name": "ConfigName1",
    "targeting_level_code": 4,
    "targeting_id": 22378872,
    "enabled": 1,
    "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 として渡します。

このサービスへの要求には、 demand_partner_config_params.enabled フィールドを含めてはなりません。 この値は、 デマンド パートナー サービスのパートナーの状態から継承されます。

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_id": 22378872,
    "enabled": 0,
    "targeting_metadata": {
        "priority": 20
    },
    "demand_partner_config_params": [
        {
            "id": 1718542,
            "member_id": 13859,
            "prebid_settings_id": 196038,
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            }
        }
    ]
}

PUT: 応答

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

PATCH

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

このサービスへの要求には、 demand_partner_config_params.enabled フィールドを含めてはなりません。 この値は、 デマンド パートナー サービスのパートナーの状態から継承されます。

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
    }
}

PATCH: 応答

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

DELETE

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

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

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

DELETE: 応答

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