キャンペーン オブジェクト サービス

Prebid Server Premium (PSP) UI を使用すると、1 つのワークフローでターゲット (地理的な場所、デバイス、キー値など) や需要パートナー マッピングなどの構成を作成できます。 コンテキストと UI のガイダンスについては 、「新しい PSP 構成の作成 」を参照してください。

API を使用してこのような構成を作成するには、目的のターゲット設定を設定するために、以下で詳しく説明する PSP キャンペーン オブジェクト サービスが必要です。 このサービスからの応答には、構成サービスでtargeting_idとして設定されるlineItem.idが含まれています。

新しい PSP キャンペーン オブジェクト サービス:

• 広告主を作成 します (PSP 広告主が存在しない場合)。
• 挿入順序を作成します (PSP 挿入順序が存在しない場合)。
• 呼び出しごとに、 新しいプロファイルと行項目のペアを作成します。

これらは PSP 固有のシェル オブジェクトであり、配信されませんが、ターゲット プロファイルを 収益化プラットフォームによって評価するために必要です。 この PSP サービスへの POST/PUT 呼び出しに関しては、プロファイル部分のみがパブリッシャーに関連します。

これらの構成とそのターゲット設定は PSP UI で管理することをお勧めしますが、大規模なパブリッシャーや自動化を使用するパブリッシャーの場合は、 API の操作 が必要であるか、少なくとも優先されます。

高度なワークフロー

1. 目的のターゲットを使用してhttps://api.appnexus.com/prebid/psp-campaign-objectsするPOST要求を行います。
2. lineItem.id値を記録します。
3. PSP キャンペーンオブジェクトのサービス応答からtargeting_idがlineItem.idである場所をhttps://api.appnexus.com/prebid/configするPOST/PUT要求を行います。

REST API

POST

POST: パラメーター

POST 応答

オブジェクトの作成

1. https://api.appnexus.com/prebid/psp-campaign-objectsにPOST要求を行います。

   1. 最上位レベルの プロファイル オブジェクトを含めます。

   2. profile オブジェクトには、オブジェクトのad_type_targets配列name文字列を含める必要があります。

   3. プロファイル オブジェクトには、 プロファイル サービスに記載されている目的のターゲット設定が含まれている必要があります。

      注:

      プロファイル サービスドキュメントでは、country_targetsなどの特定のフィールドに、country_actionなどの対応する_actionフィールドが含まれます。 [_action] フィールドは、 include または exclude のいずれかに設定できます。 include に設定した場合、ターゲット設定が適切に機能するためには、対応するオブジェクトまたは配列 (たとえば、country_targets) を設定する必要があります。

   4. プロファイル内に設定する値は、国サービスなどの読み取り専用サービスにあります。 これらは 、プロファイル サービスのドキュメントでリンクされています。

プロファイル要求の例

   
{
    "profile": {
        "name": "Test Profile",
        "ad_type_targets": [
            {
                "id": 1
            },
            {
                "id": 2
            }
        ],
        "country_action": "include",
        "country_targets": [
            {
                "id": 233,
                "name": "United States",
                "code": "US",
                "active": true
            },
            {
                "id": 41,
                "name": "Canada",
                "code": "CA",
                "active": true
            },
            {
                "id": 80,
                "name": "United Kingdom",
                "code": "UK",
                "active": true
            }
        ]
    }
}

2. PSP キャンペーン オブジェクト サービスは、作成されたオブジェクトの詳細で応答します。

   1. 広告主: PSP にまだ存在しない場合に作成されます。
   2. insertionOrder: PSP にまだ存在しない場合に作成されます。
   3. profile: すべてのターゲット設定が含まれます。
   4. lineItem: PSP 構成サービスのtargeting_idとして使用されるid値が含まれます。

3. POST要求またはPUT要求をhttps://api.appnexus.com/prebid/configします。

   1. targeting_id は、PSP キャンペーン オブジェクトのサービス応答からの lineItem.id です。
   2. targeting_metadata.priority は 1 ~ 20 の整数です。
      1. 各オークションでは、1 つの構成が使用されます。
      2. 複数の構成のターゲットが重複する場合は、 targeting_metadata.priority によって選択される構成が決定され、 20 が最も優先度が高くなります。

構成要求の例

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

{
    "name": "Test Configuration",
    "targeting_id": 26831593,
    "enabled": true,
    "targeting_metadata": {
        "priority": 18
    },
    "demand_partner_config_params": [
        {
            "name": "appnexus",
            "params": {
                "placement_id": 123456
            }
        }
    ]
}
    

4. 構成サービスは、作成されたオブジェクト (構成、および必要に応じて要求パートナー構成パラメーター) の詳細を確認して応答します。

PUT

オブジェクトの編集

1. 先ほど PSP キャンペーン オブジェクト サービスによって作成されたプロファイルの詳細を取得します。 プロファイル サービスのドキュメントを参照してください。

   1. PSP キャンペーン オブジェクト サービスへの前回の呼び出しからの advertiser.id が不明な場合は、 広告主サービスのドキュメントを参照してください。 https://api.appnexus.com/advertiserする GET 要求を行います。
   2. 広告主のすべてのプロファイルを取得するためにhttps://api.appnexus.com/profile?advertiser_id=ADVERTISERIDするGET要求を行うか、またはhttps://api.appnexus.com/profile?code=PROFILEID&します。特定のプロファイルを取得するには、advertiser_code=ADVERTISERID を指定します。
   3. Profile サービスは、可能なすべてのターゲット フィールドを含む完全なプロファイル オブジェクトで応答します。 PSP キャンペーン オブジェクトに対する PATCH 要求はサポートされていませんが、 PUT 要求には、更新するプロファイル ターゲット要素のみを含める必要があります。
   4. lineItem.idが不明な場合は、明細サービスのドキュメントを参照してください。 https://api.appnexus.com/line-itemする GET 要求を行います。

2. https://api.appnexus.com/prebid/psp-campaign-objects?profileId=PROFILEID&にPUT要求を行います。lineItemId=LINEITEMID

   1. 最上位レベルの プロファイル オブジェクトを含めます。
   2. プロファイル オブジェクトには、 プロファイル サービスに記載されている目的のターゲット設定の変更が含まれている必要があります。

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

    
{
    "profile": {
        "ad_type_targets": [
            {
                "id": 1
            }
        ],
        "country_action": "include",
        "country_targets": [
            {
                "id": 233,
                "name": "United States",
                "code": "US",
                "active": true
            },
            {
                "id": 41,
                "name": "Canada",
                "code": "CA",
                "active": true
            },
            {
                "id": 80,
                "name": "United Kingdom",
                "code": "UK",
                "active": true
            },
            {
                "id": 34,
                "name": "Brazil",
                "code": "BR",
                "active": true
            }
        ]
    }
}

3. PSP キャンペーン オブジェクト サービスは、更新されたオブジェクトの詳細に応答します。

DELETE

キャンペーン オブジェクト エンドポイントによって作成された広告申込情報を削除するには、クエリ文字列に lineItemId を含めます。

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

curl -X DELETE https://api.appnexus.com/prebid/psp-campaign-objects?lineItemId=12345

DELETE: 応答

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

関連項目

• Configuration Service
• クロスパートナー設定サービス
• デマンド パートナー サービス
• Demand Partner Schema Service
• Prebid Demand Partner Params Service
• 新しい PSP 構成を作成する
• Prebid Server Premium Demand パートナー統合
• 一般的な問題とベスト プラクティス