Campaign Objects Service

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

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

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

広告主を作成します (PSP 広告主が存在しない場合)。
広告掲載オーダーを作成します (PSP 広告掲載オーダーが存在しない場合)。
呼び出しごとに、 新しいプロファイルとブレージアイテムのペアを作成します。

これらは配信されない PSP 固有のシェルオブジェクトですが、 Monetize プラットフォームによってターゲットプロファイルが評価されるために必要なものです。プロファイル部分のみが、この PSP サービスへの POST/PUT 呼び出しの発行元に関連する関係があります。

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

大まかなワークフロー

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

注:

PSP 構成に関連付けられている行項目またはプロファイルは削除しないでください。これにより、構成が破損し、入札要求がデマンドパートナーに送信されなくなり、影響を受けるインベントリが PSP を通じて収益化されなくなります。 PSP 広告主と広告掲載オーダーの削除はプラットフォームレベルでブロックされます。

REST API

HTTP メソッド	エンドポイント	説明
`POST`	https://api.appnexus.com/prebid/psp-campaign-objects	PSP ターゲティングとすべての前提条件オブジェクト (広告主、広告掲載オーダー、ラインアイテム、プロファイル) を作成します。
`PUT`	https://api.appnexus.com/prebid/psp-campaign-objects?profileId={ProfileID}&lineItemId={LineItemID}}	PSP のターゲット設定を上書きします。

POST

POST: パラメーター

プロパティ	型	説明
`profile`	object	PSP 構成を開始するパブリッシャーの入札要求を決定します。構造と詳細については、プロファイルサービスのドキュメントを参照してください。
`profile.name`	string	このプロファイルに含まれるターゲットのユーザー向け説明。 PSP 構成で使用される他のターゲティングセットとは異なります。
`profile.ad_type_targets`	オブジェクトの配列	このサービスへのすべての POST および PUT に必須です。 PSP 構成がデマンドパートナーに送信する各メディアの種類を表す ID を含むオブジェクトの配列。以下の POST の例の構造を参照してください。 1 = バナー 2 = ビデオ 3 = ネイティブ

POST 応答

プロパティ	型	説明
`advertiser`	object	すべての PSP オブジェクトを格納するために自動的に作成される広告主。詳しくは、広告主サービスのドキュメントをご覧ください。削除はプラットフォームレベルでブロックされます。
`insertionOrder`	object	すべての PSP 広告申込情報を格納するために自動的に作成される広告掲載オーダー。詳しくは、広告掲載オーダーサービスのドキュメントをご覧ください。削除はプラットフォームレベルでブロックされます。
`lineItem`	object	評価用のターゲティングプロファイルを運ぶために自動的に作成される品目。 DO NOT DELETE THIS OBJECT OR ANY ASSOCIATED CONFIGURATION. 詳しくは、品目サービスのドキュメントをご覧ください。
`profile`	object	最初の POST 呼び出しからの入力に基づいて作成されるプロファイル。 PSP 構成を開始するパブリッシャーの入札要求を決定します。 DO NOT DELETE THIS OBJECT OR ANY ASSOCIATED CONFIGURATION. 構造と詳細については、プロファイルサービスのドキュメントを参照してください。

オブジェクトの作成

https://api.appnexus.com/prebid/psp-campaign-objects にPOST要求を送信します。
1. 最上位のプロフィールオブジェクトを含めます。
2. プロファイルオブジェクトには、 name 文字列とオブジェクトの ad_type_targets 配列が含まれている必要があります。
3. プロファイルオブジェクトには、プロファイルサービスに記載されている目的のターゲット設定が含まれている必要があります。
  
  注:
  
  プロファイルサービスドキュメントでは、country_targets などの特定のフィールドには、country_action などの対応する_actionフィールドが含まれています。 [_action] フィールドは、[ 含める ] または [除外] に設定できます。 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
            }
        ]
    }
}

PSP キャンペーンオブジェクトサービスは、作成されたオブジェクトの詳細を返します。
1. 広告主: PSP 用にまだ存在しない場合に作成されます。
2. insertionOrder: PSP 用にまだ存在しない場合に作成されます。
3. profile: すべてのターゲティングが含まれます。
4. lineItem: PSP 構成サービスでtargeting_idとして使用されるid値を含みます。
https://api.appnexus.com/prebid/config ドキュメントにPOSTまたはPUT要求を行います。
1. targeting_id は、PSP キャンペーンオブジェクトサービス応答からの lineItem.id です。
2. targeting_metadata.priority は、 1 から 20 までの整数です。
  1. 各オークションでは 1 つの構成を使用します。
  2. 複数の構成のターゲットが重複する場合は、 targeting_metadata.priority によって選択される構成が決定され、 20 が最も優先されます。

構成要求の例

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

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

構成サービスは、作成されたオブジェクト (構成、およびオプションで要求パートナー構成パラメーター) の詳細を確認する応答を返します。

PUT

オブジェクトの編集

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

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

DELETE

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

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

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

DELETE: 応答

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

Last updated on 2026-08-18