Configuration Service

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

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

需要パートナーの要件

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

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

以下のドキュメントでは、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 引数を渡し、値を 有効 または無効に設定 します

状態フィルター引数を使用した 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 を含めると、その構成のみを含む応答が発生します。

プロパティ 説明
bidder_timeout_ms integer これは、 パートナー間設定サービスで定義されます。
configs 配列 メンバーまたは特定の構成オブジェクトの 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 価格バケットを定義します。 以下の 価格粒度 の表を参照してください。 オブジェクトは、 クロスパートナー設定サービスを介して管理されます。
total_configs integer 返される構成の数。

需要パートナーの設定

プロパティ 説明
bid_cpm_adjustment 浮動小数点数 需要パートナーの CPM 入札価格に適用される乗数の値で、入札がオークションで競い合う方法を調整します。 詳細については、 デマンド パートナー サービス に関するページを参照してください。
enabled integer 需要パートナーが有効または無効になっているかどうかを示します。 許可される値は次のとおりです。
1= 有効、
0= 無効
id integer 需要パートナー設定の ID。
name string 需要パートナーの名前。 詳細については、 デマンド パートナー サービス に関するページを参照してください。

構成プロパティ

プロパティ 説明
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 Properties」の表を参照してください。 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 構成とその需要パートナー パラメーターのセットが使用されます。
複数の構成がオークションと一致する場合:
  - ユーザー定義の 優先度 が最も高い構成が選択されています。
  - 複数の構成が同じ Priority を共有している場合は、より高い (より新しい) 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 パートナー固有のパラメーターとマップされた値。 詳細については、「 Demand Partner Params Service」を参照してください。
prebid_settings_id integer 複数のデマンド パートナー パラメーター マッピングを含めることができる構成の ID。

価格の細分性

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

プロパティ 説明
currency_code string 価格バケットの計算に必要な通貨コードを含む文字列。 これは、 Microsoft が承認した通貨の一覧の一部である必要があります。
label string Prebid ドキュメントで定義されているスケールの種類 (低、中、高、自動、高密度、カスタム)。 クロスパートナー設定サービスを参照してください。
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 Properties」テーブルを参照してください。 targeting_metadata.priority が必要です。

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

プロパティ 範囲 説明
name string 必須 需要パートナーの 事前入札者名
params object 必須 パートナー固有のパラメーターとマップされた値。 詳細については、「 Demand Partner Params Service」を参照してください。

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

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

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