デマンド パートナー サービス

Demand Partner Service は、呼び出し元のメンバーのすべての需要パートナーを返します。 これにより、ユーザーは新しい需要パートナーを作成し、既存の需要パートナーを更新または削除できます。

PSP のコンテキストでは、デマンド パートナー (通常はサプライサイド プラットフォーム (SSP) など) が、ヘッダー入札広告要求を受信して解釈する Prebid Server のアダプターを作成します。 デマンド パートナーは、デマンド ソース (通常はデマンド サイド プラットフォーム (DSP)) の間でオークションを開催し、それらの広告要求に対する入札を収集し、入札を PSP に送り返します。PSP は別のオークションを開催します。

デマンド パートナーを構成に追加する前に、このサービスまたは UI を使用してデマンド パートナーを有効にする必要があります。 デマンド パートナーを enabled: 0 に設定すると、設定が 1に復元されるまで、そのパートナーへのすべての入札要求がすべての構成にわたって一時停止されます。 PSP と互換性のある需要パートナーの一覧は 、こちらにあります。

REST API

HTTP メソッド エンドポイント 説明
GET https://api.appnexus.com/prebid/demand-partner すべての需要パートナーを取得します。
POST https://api.appnexus.com/prebid/demand-partner 新しい需要パートナーを作成します。
PUT https://api.appnexus.com/prebid/demand-partner/{id} 既存の需要パートナーを更新します。
PATCH https://api.appnexus.com/prebid/demand-partner/{id} 既存のデマンド パートナーの一部を更新します。
DELETE https://api.appnexus.com/prebid/demand-partner/{id} デマンド パートナーを削除します。

GET

すべてまたは特定のデマンド パートナーを取得します。 特定の需要パートナーを取得するには、URL パスの最後のコンポーネントとして需要パートナー ID を追加します。 デマンド パートナー オブジェクトの JSON 配列を返します。

応答

プロパティ 型 説明
bid_cpm_adjustment integer オークションでの入札競争方法を調整するために、デマンド パートナーの CPM 入札価格に適用される乗数値。 実際の入札や収益の支払いは変更されず、オークションでの入札の順位のみが変更されます。 既定値は 1.00 です。 この場合、すべてのパートナーの入札は調整なしで同等に競争します。 調整は、パートナー料金または最適化の会計処理に使用できます。 デマンド パートナーよりも詳細なレベルで CPM 調整が必要な場合は、「 バイアス ルールの作成」を参照してください。
deleted integer これは、デマンド パートナー オブジェクトがシステムから削除されたことを示します。 指定できる値は次のとおりです。
0 = active,
1 = 削除済み
enabled integer デマンド パートナーが有効か無効かを示します。 指定できる値は次のとおりです。
0 = disabled,
1 = 有効
id integer 呼び出し元のメンバーに固有のデマンド パートナー ID。
last_modified string デマンド パートナー オブジェクトが変更された日付。
last_modified_by string デマンド パートナー オブジェクトを最後に変更したユーザー。
member_id integer メンバー ID。
name string デマンド パートナーの名前。
pub_id_settings object パブリッシャーが指定したユーザー ID に関連するオプション。 以下の パブリッシャー提供の ID 設定 表を参照してください。

パブリッシャー提供の ID 設定

プロパティ 型 説明
id integer ソースを表す一意識別子。
source string ソースを表す一意の文字列。
member_owner_id integer ソースを所有するメンバーの一意識別子。
status string ソースがアクティブかどうかを示します。 "active" または "inactive" の文字列入力が必要です。

応答の例

[
    {
        "bid_cpm_adjustment": 2,
        "deleted": 0,
        "enabled": 1,
        "id": 102,
        "last_modified": "2019-09-13T17:39:36Z",
        "last_modified_by":"user123",
        "member_id": 9325,
        "name": "adform",
        "pub_id_settings": {
            "sources": [
                {
                    "id": 12345,
                    "source": "sourcename",
                    "member_owner_id": 9325,
                    "status": "active"
                }
            ]
        }
    },
    {
        "bid_cpm_adjustment": 1,
        "deleted": 0,
        "enabled": 1,
        "id": 65,
        "last_modified": "2018-11-02T15:33:54Z",
        "last_modified_by":"user123",
        "member_id": 9325,
        "name": "appnexus",
        "pub_id_settings": null
    },
    {
        "bid_cpm_adjustment": 1,
        "deleted": 0,
        "enabled": 1,
        "id": 68,
        "last_modified": "2018-11-02T18:32:03Z",
        "last_modified_by":"user123",
        "member_id": 9325,
        "name": "openx",
        "pub_id_settings": null
    },
    {
        "bid_cpm_adjustment": 1,
        "deleted": 0,
        "enabled": 1,
        "id": 69,
        "last_modified": "2018-11-02T18:32:31Z",
        "last_modified_by":"user123",
        "member_id": 9325,
        "name": "ix",
        "pub_id_settings": null
    }
]

POST

新しい需要パートナーを作成します。

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

curl -d @demand-partner.json -X POST 'https://api.appnexus.com/prebid/demand-partner'
プロパティ 型 範囲 説明
bid_cpm_adjustment integer 必須 入札単価の CPM 調整。
enabled integer 必須 デマンド パートナーが有効か無効かを示します。 指定できる値は次のとおりです。
0 = disabled,
1 = 有効
name string 必須 デマンド パートナーの名前。
pub_id_settings object 必須 パブリッシャーが指定したユーザー ID に関連するオプション。 上記の パブリッシャー提供の ID 設定表 を参照してください。

JSON の例

{
    "bid_cpm_adjustment": 1,
    "enabled": 1,
    "name": "test-demand-partner",
    "pub_id_settings": {
        "sources": [
            {
                "id": 12345,
                "source": "sourcename",
                "member_owner_id": 9325,
                "status": "active"
            }
        ]
    }
}

応答

正常な応答は、新しいデマンド パートナーを JSON オブジェクトとして返します。

{
    "bid_cpm_adjustment": 1,
    "deleted": 0,
    "enabled": 1,
    "id": 999,
    "last_modified": "2020-02-25T18:32:31Z",
    "last_modified_by":"user123",
    "member_id": 9325,
    "name": "test-demand-partner",
    "pub_id_settings": {
        "sources": [
            {
                "id": 12345,
                "source": "sourcename",
                "member_owner_id": 9325,
                "status": "active"
            }
        ]
    }
}

PUT

既存の Prebid デマンド パートナーをUpdatesします。 パスの最後のコンポーネントとして id を含めます。 要求の本文で更新情報を JSON として渡します。

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

curl https://api.appnexus.com/prebid/demand-partner/1234

JSON の例

{
    "id": 1234,
    "name": "openx",
    "enabled": 0,
    "bid_cpm_adjustment": 1,
    "pub_id_settings": null
  }

応答

更新された Prebid 需要パートナー オブジェクトを返します。

PATCH

既存の Prebid デマンド パートナーを部分的に更新します。 パスの最後のコンポーネントとして ID を含めます。 要求の本文で更新情報を JSON として渡します。

{
    "enabled": 0,
    "bid_cpm_adjustment": 1
}

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

curl https://api.appnexus.com/prebid/demand-partner/1234

応答

更新された Prebid demand partner オブジェクトを返します。

DELETE

既存の Prebid デマンド パートナーを削除します。 パスの最後のコンポーネントとして ID を含めます。

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

curl https://api.appnexus.com/prebid/demand-partner/1234

応答

Prebid demand partner オブジェクトの成功応答は、deleted プロパティが true に設定された JSON オブジェクトとして返されます。 Prebid デマンド パートナーは、システムで使用できなくなります。 すべてのサブオブジェクトも削除されます。

ID ソースの管理

注:

  • 要求を需要パートナーに正常にパススルーするには、各識別子ソースに Microsoft メンバー、入札者 (Prebid Server Premium、ID 443)、および需要パートナー レベルでアクセス許可が必要です。
  • 識別子の登録プロセスと識別子の管理の詳細については、 Identity Service API を確認してください。
  • 将来的には、ID 管理 UI で識別子のアクセス許可を包括的に管理できるようになります。
  • このサービスは現在アルファ版です。 現在開発中であり、予告なく変更される場合があります。 有効にするには、Microsoft アカウント担当者にお問い合わせください。
  • Last updated on