ライン アイテム サービス

広告掲載オーダーの下の広告申込情報は、広告主に対して実行するであろう合意された戦略を表します。 広告申込情報を設定し、オプションで (広告主が広告掲載オーダーを使用するかどうかに応じて) 広告申込情報を 1 つ以上の広告掲載オーダーに関連付けた後、キャンペーンを作成して、契約を履行するための費用の使い道を指定できます。 広告申込情報では、[ revenue_type ] フィールドと [ revenue_value ] フィールドを使用して "予約収益" を記録します。これらのフィールドには、収益の種類 (CPM、CPA など) と広告主から支払われる金額が記載されています。

Xandr では、広告申込情報を広告掲載オーダーに関連付けて、単一の広告掲載オーダーで広告申込情報全体で過去のペースとパフォーマンス データを維持し、広告掲載オーダーに予算間隔を追加することで、長期にわたる広告主関係の設定を効率化することを提案しています。 広告申込情報は 1 つ以上の広告掲載オーダーに関連付けることができますが、同じ種類の広告掲載オーダー (予算間隔を使用する広告掲載オーダーまたは予算間隔を使用しない広告掲載オーダー) にのみ関連付けることができます。 各広告申込情報は 1 つ以上の子キャンペーンに関連付けられます。その後、キャンペーン レベルで入札戦略と在庫ターゲティングが設定されます。

REST API

JSON フィールド

広告主

ラベル

読み取り専用 のラベル サービス を使用して、広告申込情報、広告主、広告掲載オーダー、キャンペーン、パブリッシャーに使用可能なすべてのラベルを表示できます。 このサービスでは、オブジェクトにすでに適用されているラベルを表示することもできます。

ブローカー手数料

ネットワークがブローカーを使用してインプレッションを提供する場合、そのサービスの料金をブローカーに支払います。 この値は、ネットワーク、ブローカー、キャンペーンによって異なります。 したがって、ネットワークは、使用するブローカーごとに支払う金額を指定する必要があります。 これは、キャンペーン レベル (キャンペーン サービス) または広告掲載オーダー レベル (広告掲載オーダー サービス) でも実行できます。

ブローカーを作成または編集するには、 ブローカー サービスを参照してください。

ブローカー手数料の作成

$ cat add-LI-broker-fees.json
{
    "line-item":
        {
    "broker_fees":[
        {
            "broker_id": 145,
                "payment_type": "cpm",
                "value": "1.00",
                "description": "Smart JMS fee"
            }]
    }
}

$ curl -b cookies -c cookies -X PUT -d @add-LI-broker-fees.json 'https://api.appnexus.com/line-item?id=152083&advertiser_id=11'

{
    "response":{
        "status":"OK",
        "id":"152083",
        "count":1,
        "start_element":0,
        "num_elements":100,

        }
}

ブローカー手数料を変更する

$ cat modify-LI-broker-fee.json
{
"line-item" :
{ "broker_fees": [
    {
    "broker_id": 145,
        "payment_type": "cpm",
    "value": "2.00",
        "description": "Extra JMS fee"
        }]
    }
}

$ curl -b cookies -c cookies -X PUT -d @modify-broker-fee.json $ curl -b cookies -c cookies -X PUT -d @modify-LI-broker-fee.json 'https://api.appnexus.com/line-item?id=152083&advertiser_id=11' | json-pp

{
    "response":{
        "status":"OK",
        "id":"152083",
        "count":1,
        "start_element":0,
        "num_elements":100,
     }
}

Pixels

pixels 配列の各オブジェクトには、以下のフィールドが含まれます。

広告掲載オーダー

キャンペーン

campaigns 配列の各オブジェクトには、次のフィールドが含まれます。

評価

評価オブジェクトは、 goal_type"cpc" または "ctr"の明細行品目のパフォーマンス目標を設定するために使用されます。 これには、最適化されたキャンペーンの入札/入札なしのカットオフを決定するパフォーマンス目標のしきい値と、希望するクリックまたはクリックスルー率を表すパフォーマンス目標が含まれています。

valuation オブジェクトには以下のフィールドがあります。

クリエイティブ

creatives 配列の各オブジェクトには、次のフィールドが含まれます。 "id" または "code" フィールドの情報を取得するには、Creative Service を使用できます。

予算間隔

シームレス広告申込情報の予算間隔は、親広告掲載オーダーで定義された予算間隔のコピーである必要があります。 広告申込情報の予算間隔は、対応する広告掲載オーダーの予算間隔と同じ start_date と end_date が自動的に設定されますが、個別の予算が必要です。 これらは、対応する広告掲載オーダーの予算間隔における予算の品目固有の "サブ予算" として機能します。

ライン アイテムの予算間隔は、[ parent_interval_id ] フィールドによって作成 (および広告掲載オーダーの予算間隔にリンク) されます。 新しいシームレス広告申込情報を作成する場合は、その広告申込情報に関連付けるすべての広告掲載オーダーのすべての予算間隔への参照を budget_intervals 配列に入力する必要があります (広告掲載オーダーは、広告申込情報サービスの insertion_orders 配列を介して広告申込情報に関連付けられます)。 これを行うには、1 つのフィールド ( parent_interval_id) を含むオブジェクトを配列に追加します。このフィールドの値は広告掲載オーダーの予算間隔であり、その品目は広告掲載オーダーの予算間隔です。 以下の例セクションの「予算間隔を含むシームレスな明細行品目の追加」を参照してください。

budget_interval 配列を使用する場合は、次の点も考慮してください。

• 同じ品目の異なる予算間隔の日付範囲 (例: start_date、 end_date) が重ならないようにします。
• 品目の予算間隔は、有効期間予算に制限を無制限に設定できます (つまり、予算フィールドが null に設定されたままの場合)。
• insertion_orderオブジェクト自体の最上位レベルにある予算フィールドが設定されている場合、予算間隔を使用できません。
• 広告掲載オーダー レベルの予算間隔に対して行われた編集は、対応する広告申込情報レベルの予算間隔に伝達されます (たとえば、広告掲載オーダーの予算間隔を削除すると、その予算間隔を使用しているすべての広告申込情報の予算間隔も削除されます)。
• 品目の予算間隔の予算を増やす場合、最初に親広告掲載オーダーの予算間隔の予算を増やす必要があります (そうしないと、予算が十分でない可能性があります)。 詳細については、「 広告掲載オーダー サービス」を参照してください。

budget_intervals 配列の各オブジェクトには、次のフィールドが含まれています。

ゴール ピクセル

goal_pixels 配列は、goal_type"cpa" を操作するときに使用され、パフォーマンス目標の目標としきい値に関する情報を含みます。

goal_pixels 配列の各オブジェクトには、以下のフィールドが含まれます。

配信目標

このセクションは、パブリッシャー広告サーバー クライアントにのみ適用されます。

統計情報

stats オブジェクトは非推奨になりました (2016 年 10 月 17 日現在)。 代わりに、統計情報を取得するためにレポート サービス を使用します。

初回実行と前回実行

GET応答に first_run フィールドと last_run フィールドを含めるには、クエリ文字列に flight_info=true を渡します。 次のように、最初と最後に配信された日時に基づいて広告申込情報を絞り込むこともできます。

配信されたことがない広告申込情報のみを取得する

never_run=true をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=100&flight_info=true&never_run=true'

特定の日付以降に最初に配信された広告申込情報のみを取得する

min_first_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00'

特定の日付以前に最初に配信された広告申込情報のみを取得する

max_first_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=100&flight_info=true&max_first_run=2012-08-01 00:00:00'

特定の日付範囲内に最初に配信された広告申込情報のみを取得する

min_first_run=YYYY-MM-DD HH:MM:SS&max_first_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=100&flight_info=true&min_first_run=2012-01-01 00:00:00&max_first_run=2012-08-01 00:00:00'

特定の日付以降に最後に配信された広告申込情報のみを取得する

min_last_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00'

特定の日付以前に最後に配信された広告申込情報のみを取得する

max_last_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=100&flight_info=true&max_last_run=2012-08-01 00:00:00'

特定の日付範囲内に最後に配信された広告申込情報のみを取得する

min_last_run=YYYY-MM-DD HH:MM:SS&max_last_run=YYYY-MM-DD HH:MM:SS をクエリ文字列に渡します。

curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=100&flight_info=true&min_last_run=2012-01-01 00:00:00&max_last_run=2012-08-01 00:00:00'

日付型のフィールドは、 nmin と nmax でフィルター処理することもできます。 nmin フィルターを使用すると、null または指定した日付より後の日付を検索でき、nmax フィルターを使用すると、null または指定した日付より前の日付を検索できます。

アラート

このフィールドには、品目の配信を妨げている条件が通知されます。 アラートには、一時停止と警告の 2 種類があります。 一時停止は意図的でユーザー主導的と見なされますが、警告は意図的ではないと見なされます。

ポーズに基づいて行項目を取得するには、 GET 要求で特定のクエリ文字列パラメーターを渡す必要があります。 クエリ文字列パラメーターと例を含むユース ケースについては、以下を参照してください。 これらのクエリ文字列パラメーターは、すべてのライン アイテムまたは特定のライン アイテムを取得する場合の両方に使用できますが、以下の例ではすべてのライン アイテムの取得のみをカバーしています。この機能はそこで最も価値があります。

すべてのライン アイテムを取得し、アラートを表示する

show_alerts=true をクエリ文字列に渡します。 このパラメーターは、行項目にポーズがあるかどうかに関係なく、応答のすべての行項目に alerts オブジェクトを追加します。

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?show_alerts=true'

{
    "response": {
        "status": "OK",
        "line-items": [

            {
                "id": 45047,
                "code": null,
                "name": "Line Item 1",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-04-01 00:00:00",
                "end_date": "2012-05-01 00:00:00",
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 4,
                            "message": "Flight end date is in the past."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45048,
                "code": null,
                "name": "Line Item 2",
                "advertiser_id": 35081,
                "state": "inactive",
                "start_date": "2012-05-21 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 46308,
                "code": null,
                "name": "Test Line Item",
                "advertiser_id": 45278,
                "state": "inactive",
                "start_date": "2012-06-06 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        },
                        {
                            "id": 128,
                            "message": "All campaigns under this line item are inactive."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            ...
        ],
        ...
        }
    }
}

少なくとも 1 つのポーズがある広告申込情報のみを取得する

show_alerts=true&pauses=true をクエリ文字列に渡します。

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?show_alerts=true&pauses=true'

{
    "response": {
        "status": "OK",
        "line-items": [
            {
                "id": 45047,
                "code": null,
                "name": "Line Item 1",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-04-01 00:00:00",
                "end_date": "2012-05-01 00:00:00",
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 4,
                            "message": "Flight end date is in the past."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45048,
                "code": null,
                "name": "Line Item 2",
                "advertiser_id": 35081,
                "state": "inactive",
                "start_date": "2012-05-21 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 46308,
                "code": null,
                "name": "Line Item 6",
                "advertiser_id": 45278,
                "state": "inactive",
                "start_date": "2012-06-06 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        }   
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            ...
        ],
        ...
        }
    }
}

ポーズのない行項目のみを取得する

show_alerts=true&pauses=false をクエリ文字列に渡します。

$ curl -b cookies -c cookies 'https://api.appnexus.com/campaign?show_alerts=true&pauses=false'

{
    "response": {
        "status": "OK",
        "line-items": [
            {
                "id": 45054,
                "code": null,
                "name": "Line Item 7",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-04-01 00:00:00",
                "end_date": "2012-05-01 00:00:00",
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [

                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45057,
                "code": null,
                "name": "Line Item 9",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-05-21 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [

                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 46345,
                "code": null,
                "name": "Line Item 12",
                "advertiser_id": 45278,
                "state": "active",
                "start_date": "2012-06-06 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [

                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            ...
        ],
        ...
        }
    }
}

特定のポーズがある広告申込情報のみを取得する

show_alerts=true&pauses=PAUSE_ID をクエリ文字列に渡します。 一時停止 ID については、以下の 一時停止 の表を参照してください。

この例では、一時停止 ID 2 を使用して、フライト開始日が将来のすべての品目を取得します。

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?show_alerts=true&pauses=2'

{
    "response": {
        "status": "OK",
        "line-items": [
            {
                "id": 45047,
                "code": null,
                "name": "Line Item 5",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-11-01 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 2,
                            "message": "Flight start is in the future."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45048,
                "code": null,
                "name": "Line Item 7",
                "advertiser_id": 35081,
                "state": "active",
                "start_date": "2012-10-15 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 2,
                            "message": "Flight start is in the future."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },

            ...
        ],
        ...
        }
    }
}

2 つ以上の特定のポーズがある行項目のみを取得する

show_alerts=true&pauses=SUM_OF_PAUSE_IDS をクエリ文字列に渡します。 一時停止 ID については、以下の 一時停止 の表を参照してください。

この例では、一時停止 ID 1 と一時停止 ID 2 を加算して、非アクティブに設定され、フライト状態が将来のすべての品目を取得します。

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?show_alerts=true&pauses=3'

{
    "response": {
        "status": "OK",
        "line-items": [
            {
                "id": 45047,
                "code": null,
                "name": "Line Item 3",
                "advertiser_id": 35081,
                "state": "inactive",
                "start_date": "2012-11-01 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        },
                        {
                            "id": 2,
                            "message": "Flight start is in the future."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },
            {
                "id": 45048,
                "code": null,
                "name": "Line Item 7",
                "advertiser_id": 35081,
                "state": "inactive",
                "start_date": "2012-10-15 00:00:00",
                "end_date": null,
                ...
                "alerts": {
                    "warnings": [

                    ],
                    "pauses": [
                        {
                            "id": 1,
                            "message": "State is set to inactive."
                        },
                        {
                            "id": 2,
                            "message": "Flight start is in the future."
                        }
                    ],
                    "warnings_last_checked": null,
                    "pauses_last_checked": "2012-07-27 19:01:07"
                }
            },

            ...
        ],
        ...
        }
    }
}

一時停止

定額料金

flat_fee オブジェクトには以下のフィールドがあります。

障害

障害は、ライン アイテムまたはキャンペーンのどちらでも、1 つのレベルでのみ設定できます。 キャンペーンに障害が設定されている場合、親品目には設定できません。 障害は、管理されたインベントリにのみ適用でき、サードパーティのインベントリを使用している場合は有効にすることはできません。

マスター クリエイティブとは、障害物オブジェクトで指定された master_height と master_width に一致するサイズを持つクリエイティブです。 そのサイズに一致するクリエイティブが複数ある場合、1 つがマスターとして選択されます。

マスター クリエイティブはページ レベルの障害物に使用され、障害物に対して配信されたクリエイティブの完全なセットに対して 1 つのインプレッションが記録されます。 その記録されたインプレッションは、マスター クリエイティブに基づいています。 つまり、マスター クリエイティブが配信されない場合、インプレッションは記録されません。 配信された各クリエイティブがインプレッションとしてカウントされる、クリエイティブ レベルの障害を使用する場合は、 master_width と master_height の値は空白のままにします。

例

予算間隔でシームレスな品目を追加する

この例では、予算間隔を使用する新しい非アクティブなシームレスな明細行品目 "Lauren's Line Item" を作成します。 新しい品目を関連付ける請求期間を含む広告掲載オーダー (238174) を既に作成しています。 広告申込情報の予算間隔は、広告申込情報のbudget_intervals配列の parent_interval_id フィールドを通じて広告掲載オーダーの予算間隔に関連付けられます。

$ cat line-item
{
    "line-item": {
        "name": "Lauren's Line Item",
        "state": "inactive",
        "insertion_orders": [
            {
                "id": 238174
            }
        ],
        "budget_intervals": [
            {
                "parent_interval_id": 1377
            },
            {
                "parent_interval_id": 1378
            }
        ]
    }
}

$ curl -b cookies -X POST -d @line-item.json "https://api.appnexus.com/line-item?&advertiser_id=599314"
{
  "response": {
    "status": "OK",
    "count": 1,
    "id": 2304063,
    "start_element": 0,
    "num_elements": 100,
    "line-item": {
      "id": 2304063,
      "code": null,
      "name": "Lauren's Line Item",
      "advertiser_id": 599314,
      "state": "inactive",
      "start_date": null,
      "end_date": null,
      "timezone": "EST5EDT",
      "discrepancy_pct": 0,
      "publishers_allowed": "all",
      "revenue_value": 0,
      "revenue_type": "cpm",
      "goal_type": "none",
      "goal_value": null,
      "last_modified": "2015-09-02 14:17:50",
      "click_url": null,
      "currency": "USD",
      "require_cookie_for_tracking": true,
      "profile_id": null,
      "member_id": 958,
      "comments": null,
      "remaining_days": null,
      "total_days": null,
      "manage_creative": false,
      "advertiser": {
        "id": 599314,
        "name": "Cindy's Adv"
      },
      "flat_fee": null,
      "delivery_goal": null,
      "labels": null,
      "broker_fees": null,
      "pixels": null,
      "insertion_orders": [
        {
          "id": 238174,
          "state": "inactive",
          "code": null,
          "name": "LH Test IO",
          "advertiser_id": 599314,
          "start_date": null,
          "end_date": null,
          "timezone": "EST5EDT",
          "last_modified": "2015-09-02 13:56:56",
          "currency": "USD",
          "budget_intervals": [
            {
              "id": 1377,
              "object_id": 238174,
              "object_type": "insertion_order",
              "start_date": "2015-09-02 00:00:00",
              "end_date": "2015-09-10 00:00:00",
              "timezone": "EST5EDT",
              "lifetime_budget": 1000,
              "lifetime_budget_imps": null,
              "lifetime_pacing": false,
              "enable_pacing": false,
              "daily_budget_imps": null,
              "daily_budget": null
            },
            {
              "id": 1378,
              "object_id": 238174,
              "object_type": "insertion_order",
              "start_date": "2015-09-10 00:00:00",
              "end_date": "2015-09-18 00:00:00",
              "timezone": "EST5EDT",
              "lifetime_budget": 1000,
              "lifetime_budget_imps": null,
              "lifetime_pacing": false,
              "enable_pacing": false,
              "daily_budget_imps": null,
              "daily_budget": null
            }
          ]
        }
      ],
      "goal_pixels": null,
      "imptrackers": null,
      "clicktrackers": null,
      "campaigns": null,
      "valuation": {
        "performance_mkt_managed": false,
      },
      "creatives": null,
      "budget_intervals": [
        {
          "id": 1379,
          "object_id": 2304063,
          "object_type": "campaign_group",
          "start_date": "2015-09-02 00:00:00",
          "end_date": "2015-09-10 00:00:00",
          "timezone": "EST5EDT",
          "parent_interval_id": 1377,
          "budget_allocation": null
        },
        {
          "id": 1380,
          "object_id": 2304063,
          "object_type": "campaign_group",
          "start_date": "2015-09-10 00:00:00",
          "end_date": "2015-09-18 00:00:00",
          "timezone": "EST5EDT",
          "parent_interval_id": 1378,
          "budget_allocation": null
        }
      ],
      "lifetime_budget": null,
      "lifetime_budget_imps": null,
      "daily_budget": null,
      "daily_budget_imps": null,
      "enable_pacing": null,
      "allow_safety_pacing": null,
      "lifetime_pacing": null,
      "lifetime_pacing_span": null,
      "lifetime_pacing_pct": null,
      "payout_margin": null
    }
  }
}

シームレスでない品目を追加する

この例では、新しい広告申込情報を作成し、コンバージョン ピクセルを新しい広告申込情報に関連付けます。

$ cat line-item
{
    "line-item": {
    "name": "Weekday French Speakers Q3 2012",
    "state": "inactive",
    "comments": "The name says it all -- that's who we're trying to advertise to",
    "daily_budget": null,
    "revenue_type": "cpa",
    "code": "wfspq312",
    "pixels": [
        {
        "id": "123456",
        "state": "inactive",
        "post_view_revenue": null,
        "post_click_revenue": "30.000000"
        }
    ],
    "start_date": "2011-11-04 00:00:00",
    "lifetime_budget": null,
    "end_date": null,
    "enable_pacing": null,
    "allow_safety_pacing": null,
    "publishers_allowed": "all",
    "campaigns": null
    }
}

curl -b cookies -c cookies -X POST -d @line-item "https://api.appnexus.com/line-item?advertiser_id=51"

CPC パフォーマンス目標のラインアイテムを追加する

この例では、CPC パフォーマンス目標を含む品目を作成します。 クリック単価の目標しきい値は 2.34 ドル、目標 (レポート目的) は 2.00 ドルに設定されています。

$ cat line-item
{
    "line-item": {
    "name": "Weekday French Speakers Q3 2012",
    "state": "inactive",
    "comments": "The name says it all -- that's who we're trying to advertise to",
    "daily_budget": null,
    "revenue_type": "cpm",
    "goal_type": "cpc",
    "valuation": {
        "goal_target":2.00,
        "goal_threshold":2.34
    }
    "lifetime_budget": null,
    "end_date": null,
    "enable_pacing": null,
    "allow_safety_pacing": null,
    "publishers_allowed": "all",
    "campaigns": null
    }
}

curl -b cookies -c cookies -X POST -d @line-item "https://api.appnexus.com/line-item?advertiser_id=51"

CPA パフォーマンス目標を含む広告申込情報を追加する

この例では、CPA パフォーマンス目標を含む品目を作成します。 CPA 目標のしきい値は 4.56 ドル、目標 (レポート目的) は 4.00 ドルに設定されています。

$ cat line-item
{
    "line-item": {
    "name": "Weekday French Speakers Q3 2012",
    "state": "inactive",
    "comments": "The name says it all -- that's who we're trying to advertise to",
    "daily_budget": null,
    "revenue_type": "cpm",
    "goal_type": "cpa",
    "pixels": [
        {
        "id": "123456",
        "state": "inactive",
        "post_view_revenue": null,
        "post_click_revenue": "30.000000"
        }
    ],
    "goal_pixels":[
        {
        "id":"123456",
        "post_view_goal_threshold":4.56,
        "post_view_goal_target":4.00
        }
    ].
    "lifetime_budget": null,
    "end_date": null,
    "enable_pacing": null,
    "allow_safety_pacing": null,
    "publishers_allowed": "all",
    "campaigns": null
    }
}

curl -b cookies -c cookies -X POST -d @line-item "https://api.appnexus.com/line-item?advertiser_id=51"

パフォーマンス オファーの品目を追加する

この例では、CPC ベースで管理された在庫とクロスネット在庫の両方を購入するパフォーマンス オファーの品目を作成します。

$ cat line-item
{
    "line-item": {
        "name": "US CA",
        "state": "inactive",
        "daily_budget": null,
        "revenue_type": "cpc",
        "revenue_value": "5.00",
        "goal_type": "none",
        "valuation": {
            "performance_mkt_managed": true,
        },
        "lifetime_budget": null,
        "end_date": null,
        "enable_pacing": null,
        "allow_safety_pacing": null,
        "publishers_allowed": "all",
        "campaigns": null,
        "manage_creative": true,
        "payout_margin": 0.2
    }
}

curl -b cookies -c cookies -X POST -d @line-item "https://api.appnexus.com/line-item?advertiser_id=51"

品目の表示

特定の広告申込情報を表示するには、クエリ文字列を介して広告申込情報と広告主 ID を渡す必要があります。 この広告申込情報には、コンバージョン ピクセルが既に設定されています。

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?id=164532&advertiser_id=52049'

{
    "response": {
    "status": "OK",
    "line-item": {
        "id": 164532,
        "code": "wfspq312",
        "name": "Weekday French Speakers Q3 2012",
        "advertiser_id": 52049,
        "state": "inactive",
        "start_date": "2011-11-04 00:00:00",
        "end_date": null,
        "timezone": "EST5EDT",
        "discrepancy_pct": 0,
        "lifetime_budget": null,
        "lifetime_budget_imps": null,
        "daily_budget": null,
        "daily_budget_imps": null,
        "enable_pacing": null,
        "allow_safety_pacing": null,
        "publishers_allowed": "all",
        "revenue_value": 0,
        "revenue_type": "cpa",
        "pixels": [
        {
            "id": "39688",
            "state": "inactive",
            "post_view_revenue": null,
            "post_click_revenue": "30.000000"
        }
        ],
        "campaigns": null,
        "insertion_orders": null,
        "goal_type": "none",
        "goal_value": null,
        "goal_pixels": null,
        "last_modified": "2012-06-19 20:29:38",
        "all_stats": null,
        "click_url": null,
        "currency": "USD",
        "require_cookie_for_tracking": true,
        "labels": null,
        "advertiser": {
        "id": 52049,
        "name": "Cody's Great Advertiser"
        },
        "broker_fees": null,
        "profile_id": null,
        "member_id": 1282,
        "flat_fee": null,
        "imptrackers": null,
        "clicktrackers": null,
        "comments": "The name says it all -- that's who we're trying to advertise to",
        "is_malicious": false,
        "remaining_days": null,
        "total_days": 60
    },
    "count": 1,
    "start_element": null,
    "num_elements": null
    }
}

広告主のすべての広告申込情報を表示する

上記の例とは異なり、この広告申込情報には、2 つのキャンペーンと 1 つの goal_pixels 配列が関連付けられています。 この広告主の品目は 1 つだけですが、 line-items JSON 配列を介して返されることに注意してください。

$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?advertiser_id=51'

{
   "response":{
      "status":"OK",
      "line-items":[
         {
            "id":2,
            "code":null,
            "name":"Default Line Item",
            "advertiser_id":51,
            "state":"active",
            "start_date":null,
            "end_date":null,
            "timezone":"EST5EDT",
            "lifetime_budget":null,
            "lifetime_budget_imps":null,
            "daily_budget":null,
            "daily_budget_imps":null,
            "enable_pacing":false,
            "publishers_allowed":"all",
            "lifetime_spend":null,
            "lifetime_imps":null,
            "daily_spend":null,
            "daily_imps":null,
            "revenue_value":null,
            "revenue_type":null,
            "pixels":[
               {
                  "id":"934",
                  "state":"active",
                  "post_view_revenue":null,
                  "post_click_revenue":null
               }
            ],
            "campaigns":[
               {
                  "id":"21999",
                  "name":"My second campaign",
                  "state":"inactive"
               },
               {
                  "id":"21180",
                  "name":"My first campaign",
                  "state":"active"
               }
            ],
            "goal_type":"cpa",
            "goal_value":null,
            "goal_pixels":[
               {
                  "id":934,
                  "state":"active",
                  "post_view_goal":1,
                  "post_click_goal":2
               }
            ],
            "labels" [
               {
                  "value: "First Contact",
                  "id": 7,
                  "name": "Trafficker"
               },
               {
                  "value: "Second Contact",
                  "id": 8,
                  "name": "Sales Rep"
               },
            "last_modified":"2010-06-09 19:32:56",
            "comments": null
            "is_malicious": false,
            "remaining_days": null,
            "total_days": 30
         }
      ],
      "count":1,
      "start_element":null,
      "num_elements":null
   }
}

シームレス明細行品目の予算間隔を変更する

$ cat modify-budget-interval
{
    "line-item": {
        "budget_intervals": [
            {
                "parent_interval_id": 197186,
                "id": 219368,
                "lifetime_budget": 100
            },
            {
                "parent_interval_id": 197187,
                "id": 219369,
                "lifetime_budget": 100
            }
        ]
    }
}
curl -b cookies -X PUT -d @modify-budget-interval "https://api.appnexus.com/line-item?advertiser_id=608591&id=3319754"
{
  "response": {
    "status": "OK",
    "count": 1,
    "id": "3319754",
    "start_element": 0,
    "num_elements": 100,
    "line-item": {
      "id": 3319754,
      "code": null,
      "name": "Seamless Line Item Test",
      "advertiser_id": 608591,
      "state": "active",
      "start_date": null,
      "end_date": null,
      "timezone": "EST5EDT",
      "discrepancy_pct": 0,
      "publishers_allowed": "all",
      "revenue_value": 0,
      "revenue_type": "cpm",
      "goal_type": "none",
      "goal_value": null,
      "last_modified": "2016-09-01 17:44:32",
      "click_url": null,
      "currency": "USD",
      "require_cookie_for_tracking": true,
      "profile_id": null,
      "member_id": 958,
      "comments": null,
      "remaining_days": null,
      "total_days": null,
      "manage_creative": false,
      "creative_distribution_type": null,
      "line_item_type": "standard_v1",
      "prefer_delivery_over_performance": false,
      "advertiser": {
        "id": 608591,
        "name": "Don Test Advertiser"
      },
      "flat_fee": null,
      "delivery_goal": null,
      "labels": null,
      "broker_fees": null,
      "pixels": null,
      "insertion_orders": [
        {
          "id": 379643,
          "state": "inactive",
          "code": null,
          "name": "Seamless Insertion Order Test",
          "advertiser_id": 608591,
          "start_date": null,
          "end_date": null,
          "timezone": "EST5EDT",
          "last_modified": "2016-08-30 15:23:07",
          "currency": "USD",
          "budget_intervals": [
            {
              "id": 197186,
              "object_id": 379643,
              "object_type": "insertion_order",
              "start_date": "2016-09-01 00:00:00",
              "end_date": "2016-09-30 00:00:00",
              "timezone": "EST5EDT",
              "lifetime_budget": null,
              "lifetime_budget_imps": null,
              "daily_budget_imps": null,
              "daily_budget": null,
              "enable_pacing": false,
              "lifetime_pacing": false,
              "lifetime_pacing_pct": null
            },
            {
              "id": 197187,
              "object_id": 379643,
              "object_type": "insertion_order",
              "start_date": "2016-10-01 00:00:00",
              "end_date": "2016-10-31 00:00:00",
              "timezone": "EST5EDT",
              "lifetime_budget": null,
              "lifetime_budget_imps": null,
              "daily_budget_imps": null,
              "daily_budget": null,
              "enable_pacing": false,
              "lifetime_pacing": false,
              "lifetime_pacing_pct": null
            }
          ]
        }
      ],
      "goal_pixels": null,
      "imptrackers": null,
      "clicktrackers": null,
      "campaigns": null,
      "valuation": {
        "min_margin_pct": null,
        "max_avg_cpm": null,
        "min_avg_cpm": null,
        "goal_target": null,
        "goal_threshold": null,
        "no_revenue_log": false,
        "performance_mkt_managed": false,
        "bid_price_pacing_enabled": false,
        "bid_price_pacing_lever": 0,
        "goal_confidence_threshold": null
      },
      "creatives": null,
      "budget_intervals": [
        {
          "id": 219368,
          "object_id": 3319754,
          "object_type": "campaign_group",
          "start_date": "2016-09-01 00:00:00",
          "end_date": "2016-09-30 00:00:00",
          "timezone": "EST5EDT",
          "parent_interval_id": 197186,
          "lifetime_budget": 100,
          "lifetime_budget_imps": null,
          "lifetime_pacing": false,
          "enable_pacing": true,
          "daily_budget_imps": null,
          "daily_budget": null
        },
        {
          "id": 219369,
          "object_id": 3319754,
          "object_type": "campaign_group",
          "start_date": "2016-10-01 00:00:00",
          "end_date": "2016-10-31 00:00:00",
          "timezone": "EST5EDT",
          "parent_interval_id": 197187,
          "lifetime_budget": 100,
          "lifetime_budget_imps": null,
          "lifetime_pacing": false,
          "enable_pacing": true,
          "daily_budget_imps": null,
          "daily_budget": null
        }
      ],
      "expected_value_model": null,
      "custom_models": null,
      "inventory_discovery": null,
      "inventory_discovery_budget": null,
      "incrementality": null,
      "lifetime_budget": null,
      "lifetime_budget_imps": null,
      "daily_budget": null,
      "daily_budget_imps": null,
      "enable_pacing": null,
      "allow_safety_pacing": null,
      "lifetime_pacing": null,
      "lifetime_pacing_span": null,
      "lifetime_pacing_pct": null,
      "payout_margin": null
    },
    "dbg_info": {
      ...
    }
  }
}

$ cat guaranteed-delivery-line-item.json
     
{
    "line-item": {
        "name": "Rich's Second Guaranteed Line Item - Impressions Delivery Goal",
        "state": "inactive",
        "lifetime_budget_imps": 10000,
        "lifetime_pacing": true,
        "enable_pacing": false,
        "manage_creative": true,
        "allow_safety_pacing": false,
        "delivery_goal": {
            "type": "impressions",
            "disallow_non_guaranteed": true
        },
        "daily_budget": null,
        "revenue_type": "cpm",
        "start_date": "2015-05-15 00:00:00",
        "end_date": "2015-05-20 00:00:00",
        "lifetime_budget": null,
        "publishers_allowed": "direct",
        "campaigns": null
    }
}

$ curl -b cookies -X POST -d @guaranteed-delivery-line-item.json 'https://api.appnexus.com/line-item?advertiser_id=561703'

$ cat campaign.json


{
    "campaign": {
         "state": "inactive",
         "name": "Rich's Guaranteed Campaign",
         "advertiser_id": 41884,
         "line_item_id": 232854,
         "inventory_type": "direct"
    }
}

$ curl -b cookies -X POST -d @campaign.json 'https://api.appnexus.com/campaign?advertiser_id=561703'

品目を削除する

curl -b cookies -X DELETE "https://api.appnexus.com/line-item?id=5851054&advertiser_id=5413231"

{"response":
    {
        "status":"OK",
        "count":1,
        "start_element":null,
        "num_elements":null,
        "dbg_info":
            {
                "warnings":[],
                "version":"1.0.190",
                "output_term":"not_found"}
            }
    }
}

関連トピック

• API のベスト プラクティス
• API セマンティクス
• キャンペーン サービス
• 変換ピクセル サービス
• 広告掲載オーダー サービス