次の方法で共有

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

  • [アーティクル]

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

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

需要パートナーを構成に追加する前に、このサービスまたは UI を介して有効にする必要があります。 需要パートナーを enabled: false に設定すると、設定が trueに復元されるまで、すべての構成にわたってそのパートナーに対するすべての入札要求が一時停止されます。 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

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

応答

プロパティ 型 説明
bid_cpm_adjustment integer 需要パートナーの CPM 入札価格に適用される乗数の値で、入札がオークションで競い合う方法を調整します。 これにより、実際の入札や収益の支払いは変更されず、オークションでの入札の順位のみが変更されます。 既定値は 1.00 です。 この場合、すべてのパートナーの入札は調整なしで均等に競合します。 調整は、パートナーの料金または最適化を考慮するために使用できます。 需要パートナーよりもきめ細かいレベルで CPM 調整が必要な場合は、「 バイアスルールを作成する」を参照してください。
deleted ブール値 これは、需要パートナー オブジェクトがシステムから削除されたことを示します。
enabled ブール値 需要パートナーが有効または無効になっているかどうかを示します。
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 文字列 ソースを表す一意の文字列。
member_owner_id integer ソースを所有するメンバーの一意識別子。
status string ソースがアクティブかどうかを示します。 "active"または"inactive"の文字列入力が必要です。

応答の例

[
    {
        "bid_cpm_adjustment": 2,
        "deleted": false,
        "enabled": true,
        "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": false,
        "enabled": true,
        "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": false,
        "enabled": true,
        "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": false,
        "enabled": true,
        "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 ブール値 必須 需要パートナーが有効または無効になっているかどうかを示します。
name string 必須 需要パートナーの名前。
pub_id_settings object 必須 発行元が指定したユーザー ID に関連するオプション。 上記 の発行元が指定した ID 設定の表を 参照してください。

JSON の例

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

応答

応答が成功すると、新しい需要パートナーが JSON オブジェクトとして返されます。

{
    "bid_cpm_adjustment": 1,
    "deleted": false,
    "enabled": true,
    "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 demand パートナー オブジェクトを返します。

PATCH

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

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

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

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

応答

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

DELETE

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

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

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

応答

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

ID ソースの管理

注:

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