注:
このページでは、拡張品目のライン アイテム サービスについて説明します。 従来の広告申込情報用に設計された他の API ドキュメントへのリンクがあり、拡張広告申込情報では使用されないフィールドやオブジェクトがメンションされている場合があります。 最も重要な点として、拡張広告申込情報はシームレス広告掲載オーダーでのみ使用でき、予算間隔をサポートしていない (つまり、 budget_intervals 配列を使用しない) 従来の広告掲載オーダーでは使用できません。
拡張広告申込情報を作成するには、 line_item_type フィールドを 'standard_v2' に設定し、 insertion_orders 配列を介して広告申込情報をシームレスな広告掲載オーダーに関連付ける必要があります。
広告申込情報は、予算、収益タイプ、パフォーマンス目標、入札戦略、在庫ターゲティングなど、広告主との財務関係を定義します。 拡張広告申込情報は、シームレス広告掲載オーダーと共に使用する必要があります。 広告掲載オーダーに予算間隔を追加することで、広告主との関係が長く続くように設定を合理化することをお勧めします。
REST API
注:
パフォーマンス目標について
ゴール ピクセルは、 revenue_type と goal_type の測定方法が同じでない場合に、パフォーマンスを追跡および測定するために使用されます。 たとえば、広告主がコンバージョンの観点から目標達成度を測定しつつも、CPM で支払いたいため、"cpm" のrevenue_typeと "cpa" のgoal_typeが一致することがあります。
-
CPA:
goal_type"cpa"で広告申込情報のパフォーマンス目標を設定するには、オブジェクトの Goal Pixels 配列とその下の Valuation オブジェクトの両方を使用します。goal_pixels配列には、CPA 目標としきい値に関する情報が含まれています。valuationオブジェクトの基本的な説明については、以下の CPC を参照してください。 -
CPC:
goal_type"cpc"で広告申込情報のパフォーマンス目標を設定するには、valuationオブジェクトを使用します。valuationオブジェクトには、最適化された広告申込情報の入札単価/入札単価なしの締め切りを決定する成果目標のしきい値と、希望するクリック数またはクリック率を表す成果目標目標目標が含まれています。 設定するフィールドの詳細については、以下のvaluationオブジェクトの説明を参照してください。
地理的なターゲット設定について
拡張ライン アイテムの場合、少なくとも 1 つの国/地域を地域ターゲティングとして設定する必要があります。 地域のターゲット設定を追加するには、プロファイルサービスページの「ターゲット設定」セクションの「国ターゲット」を参照してください。
JSON フィールド
全般
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 品目の ID。 Required On: PUT, in query string. |
code |
string (100) | 品目のカスタム コード。 コードには、英数字、ピリオド、アンダースコア、またはダッシュのみを含めることができます。 入力したコードで大文字と小文字は区別されません (大文字と小文字は同じように扱われます)。 広告主ごとに同じコードを同じレベルの 2 つのオブジェクト (広告掲載オーダーまたは広告申込情報など) で使用することはできません。 たとえば、2 つの広告申込情報の両方でコード "XYZ" を使用することはできませんが、1 つの広告掲載オーダーとその子広告申込情報では使用できます。 既定値: null |
name |
string (255) | 明細行品目の名前。 必須: POST |
advertiser_id |
int | 広告申込情報が属する広告主の ID。 |
state |
列挙 | 品目の状態。 使用可能な値: "active" または "inactive"。既定値: "active" |
line_item_type |
列挙 | 品目のタイプ。 使用可能な値は次のとおりです。 - "standard_v1": Standard ライン品目 (ALI 以外)。- "standard_v2": 拡張品目 (ALI)。- "guaranteed_delivery": 保証されたライン項目 (GDLI)。- "curated": キュレーションされた品目。注: このフィールドが ALI の "standard_v2" に設定されていることを確認します。既定値: "standard_v2" |
start_date |
timestamp | このフィールドは使用しないでください。 代わりに、budget_intervals 配列内の start_date フィールドと end_date フィールドを使用して、品目を実行するタイミングを指定します。既定値: null (即時) |
end_date |
timestamp | このフィールドは使用しないでください。 代わりに、budget_intervals 配列内の start_date フィールドと end_date フィールドを使用して、品目を実行するタイミングを指定します。既定値: null (無期限) |
timezone |
列挙 | 予算と支出がカウントされるタイムゾーン。 詳細と使用できる値については、「 API タイムゾーン」を参照してください。 注: ALI の場合は、必ずこのフィールド ( budget_intervals 配列内のフィールドではない) を使用して品目のタイム ゾーンを設定してください。既定値: "UTC" または広告主のタイムゾーン。 |
ad_types |
文字列の配列 | この品目に使用されているクリエイティブのタイプ。 使用可能な値: - "banner"- "video"- "native"- "audio"配列の値は 1 つのみにする必要があります。 この値により、オークション項目の購入戦略、支払い戦略、最適化オプション、クリエイティブの関連付け、ターゲティング オプションでどのようにオークション項目を追跡するかが決まります。 注: 広告申込情報に関連付けられているすべてのクリエイティブには、同じ広告タイプを設定し、ここで選択した ad_types と一致する必要があります。既定値: "banner"必須: POST/PUT |
discrepancy_pct |
double | 非推奨です。 |
publishers_allowed |
string | 非推奨。
supply_strategies 配列の値を使用して、供給の種類 (例: RTB/Open Exchange、Deals、Managed) を設定します。 |
revenue_value |
double | 広告主がネットワークに支払った金額。 メモ: [ revenue_type ] フィールドの設定内容に応じて、このフィールドにはその収益タイプの実際の値 (目的の CPC など) を設定する必要があります。
revenue_typeが"cost_plus_margin"の場合は、このフィールドをクライアントが支払うマージンの割合に設定します (例: .20 は 20%)。必須: POST/PUT |
revenue_type |
列挙 | 広告主が支払いに同意した方法 (予約収益とも呼ばれます)。 使用可能な値を以下に示します。 - "cpm": 1,000 インプレッション (CPM)、クリック (CPC)、ビュー (ビュー CPM) に対して一額支払われる場合は、この値を選択します。- CPM の場合は、これを "cpm" に設定し、 revenue_value フィールドを CPM 値に設定し、[ max_avg_cpm ] フィールドと [ min_avg_cpm ] フィールドを null に設定します。- CPC の場合は、これを "cpm" に設定し、 revenue_value フィールドを CPC 値に設定し、 "revenue_auction_event_type" を "click"、 "revenue_auction_event_type_code" を "click"、 "revenue_auction_type_id" を 3 に設定します。- 表示可能なCPMの場合は、 "cpm"に設定し、 revenue_value フィールドを表示可能なCPM値に、 revenue_auction_event_type フィールドを "view"に、 revenue_auction_event_type_code フィールドを "view_display_50pv1s_an"に、 "revenue_auction_type_id" を 2に設定します。 Xandr 視認性測定に従って、IAB 定義を使用して、測定されたビューアブル インプレッションのみがカウントされます。- CPCV の場合は、 "cpm"、 ad_types フィールドを "video"、 "revenue_auction_event_type" を "video"、 "revenue_auction_event_type_code" を "video_completion"、 "revenue_auction_type_id" を 10 に設定します。- "vcpm": 動的 CPM (予約収益は、入札単価を引き下げる前のインプレッションのコストと等しくなります)。 ここで "vcpm" を選択し、 goal_type が 'none' に設定されていて、 'expected_value' モデルが添付されていない場合は、 'max_avg_cpm' 値を設定する必要があります。注: programmatic_guaranteed (supply_strategies) が true に設定されている場合は、revenue_type を cost_plus_margin または cost_plus_cpm に設定する必要があります。- "cost_plus_margin": メディア コスト (在庫に消費する金額) に支出額に対する割合を加えたもの。 このオプションをオンにした場合は、 revenue_value マージンをパーセンテージに設定する必要もあります (例: 20% の場合は .2 )。 サード パーティのデータ消去 (セグメントなど) に参加すると、データコストも追加されます。 コスト プラス ( goal_type フィールド経由) の最適化を無効にする場合は、 max_avg_cpm フィールド ( valuation オブジェクト内) を使用してコスト プラスのフラット CPM を設定する必要があります。- "cost_plus_cpm": メディア コスト (在庫に費やす金額) と、CPM 収益に基づいて広告主に請求するサービス料を加えます。 また、選択した場合は、 revenue_value を、受け取る一定の CPM マージン (たとえば、1 ドルの CPM で 1 ) に設定する必要があります。 サード パーティのデータ消去 (セグメントなど) に参加すると、データコストも追加されます。 コスト プラス ( goal_type フィールド経由) の最適化を無効にする場合は、 max_avg_cpm フィールド ( valuation オブジェクト内) を使用してコスト プラスのフラット CPM を設定する必要があります。注: lifetime_budget_imps フィールドまたは daily_budget_imps フィールドが設定されている場合、またはライン アイテムの親広告掲載オーダーのbudget_typeが impression に設定されている場合は、revenue_type が "CPC" に設定されていない可能性があります。既定値: "none" |
goal_type |
列挙 | 掲載結果目標を活用する広告申込情報の場合。 使用可能な値: null、 "cpc"、 "cpa"、 "ctr"、または "custom"。- クリック後と表示後のコンバージョンの両方で CPA パフォーマンス目標に合わせて最適化したい場合は、このフィールドを [ "cpa"] に設定します。 また、 post_click_goal_threshold フィールドと post_videw_goal_threshold フィールド (オブジェクトの goal_pixels 配列) を CPA 目標に設定する必要があります。 Xandr は 1 つの値に最適化されるため、これらの値は同じである必要があります。 さらに、 campaign_group_valuation_strategy を "retargeting" または "prospecting" に設定する必要があります。 詳細については、後述の評価のcampaign_valuation_strategyを参照してください。- クリック後のコンバージョンのみに対して CPA パフォーマンス目標に合わせて最適化する場合は、このフィールドを "cpa" に設定します。 また、 post_click_goal_target フィールドと post_click_goal_threshold フィールド (オブジェクトの goal_pixels 配列) を CPA 目標に設定する必要があります。- CPC 目標に合わせて最適化する場合は、このフィールドを "cpc" に設定します。 また、 goal_target フィールドと goal_threshold フィールド ( valuation オブジェクト内) を CPC 目標に設定し、 goal_pixel を null に設定する必要があります。- 視認可能なCPM目標に合わせて最適化する場合は、このフィールドを nullに設定します。 また、(評価オブジェクトの) goal_target フィールドと goal_threshold フィールドと goal_pixels を null に設定する必要があります。 さらに、 auction_event オブジェクトで kpi_auction_event_type、 kpi_auction_event_type_code、 kpi_auction_type_id、 kpi_value のフィールドも設定する必要があります。- CTR 目標に合わせて最適化する場合は、このフィールドを [ "ctr"] に設定します。 さらに、valuation オブジェクトのgoal_targetとgoal_thresholdも、希望するクリック率 (0 から 1 の間の 10 進数値) に設定する必要があります。- click_imp モデルや ev_click モデルではなく、独自のカスタムEVモデル(予想評価)をアップロードする場合は、このフィールドを "custom"に設定します。 詳細については、 カスタム モデルを参照してください。- 最適化を無効にする場合は、このフィールドを nullに設定します。 さらに、 PUT 呼び出しで、広告申込情報が以前に表示可能な CPM に最適化するように設定されている場合は、次のフィールド ( auction_event オブジェクト内) も次のように設定する必要があります。- "kpi_auction_event_type": "impression"- "kpi_auction_event_type_code": "impression"- "kpi_auction_type_id": 1- "kpi_value": null既定値: "none" |
goal_value |
double | 非推奨。 代わりに valuation オブジェクトを使用してください。 詳細については、以下の 「評価 」を参照してください。 |
last_modified |
timestamp | この明細行品目に対する最終変更時刻。 読み取り専用。 |
click_url |
string (1000) | ライン アイテム レベルで適用するクリック URL。 |
currency |
string (3) | この明細行品目に使用される通貨。 サポートされている通貨の一覧については、「 通貨サービス」を参照してください。 注: ライン アイテムが作成されると、通貨は変更できません。 ヒント: ベスト プラクティスとしては、可能な限り最適な現地通貨エクスペリエンスを実現するために、通貨を請求通貨に合わせます。 既定値: 広告主のデフォルト通貨。 |
require_cookie_for_tracking |
ブール値 | コンバージョン トラッキング目的で、識別されたユーザーのみにサービスを提供するかどうかを示します。
true に設定すると、匿名ユーザーはコンバージョン属性の可能性が低いため、サービスは提供されません。
false に設定すると、匿名ユーザーにサービスを提供し、それらのユーザーについて IP ベースのコンバージョン属性のみを受け入れることを示します (オンになっている場合)。 このフィールドの設定は、コンバージョン ピクセルが適用された場合にのみ関係があるため、 true に設定しても、コンバージョン ピクセルのないライン アイテムの識別子は必要ありません。 - trueの場合は、コンバージョン トラッキングに識別子が必要です。 - programmatic_guaranteed ( supply_strategies) が true に設定されている場合は、 require_cookie_for_tracking を false に設定する必要があります。 既定値: true |
profile_id |
int | オプションの profile_id をこの明細行品目に関連付けることができます。 プロファイルは、在庫をターゲット設定するための一般的なルール セットです。 詳細については、 プロファイル サービスを参照してください。 |
member_id |
int | 明細行品目を所有するメンバーの ID。 |
comments |
string | 品目に関するコメント。 |
remaining_days |
int | 今日から明細行品目の end_date までの日数。 メモ:これは、 start_dateが将来のものであるか、start_dateまたはend_dateが設定されていない場合にnullされます。読み取り専用。 |
total_days |
int | 品目の start_date と end_date の間の日数。 メモ:これは、 start_dateまたはend_dateのいずれかが設定されていない場合にnullされます。読み取り専用。 |
advertiser |
object | この広告申込情報が関連付けられている広告主を示すオブジェクト。 詳細については、以下の 「広告主」 を参照してください。 読み取り専用。 |
labels |
配列 | 品目に適用されるオプションのラベル。 現在、使用可能なラベルは "Trafficker" と "Sales Rep" です。 詳細については、下の ラベル を参照してください。注: ライン アイテム ラベルに関するレポートは、 ネットワーク分析 レポートと ネットワーク広告主分析 レポートで行うことができます。 たとえば、 "Trafficker" ラベルを使用して各ライン アイテムを担当するトラッカーの名前を指定する場合、 "trafficker_for_line_item" でフィルタリングして特定のトラッカーが担当するライン アイテムに焦点を当てるネットワーク分析レポートを実行したり、 "trafficker_for_line_item" でグループ化してトラッカーのパフォーマンスをランク付けしたりできます。 |
broker_fees |
配列 | 非推奨。 代わりに partner_fees を使用してください。 |
pixels |
オブジェクトの配列 | CPA 収益の追跡に使用されるコンバージョン ピクセル。 クリック後の収益と表示後の収益の両方を指定できます。 1 つの品目に添付できるピクセル数は 20 ピクセルまでです。 さらに添付する必要がある場合は、Xandr 実装コンサルタントまたはサポートにご相談ください。 詳細については、「 ピクセル 」およびフォーマットのサンプルについて以下の例を参照してください。 既定値: null |
broker_fees |
配列 | 非推奨。 代わりに partner_fees を使用してください。 |
pixels |
オブジェクトの配列 | CPA 収益の追跡に使用されるコンバージョン ピクセル。 クリック後の収益と表示後の収益の両方を指定できます。 1 つの品目に添付できるピクセル数は 20 ピクセルまでです。 さらに添付する必要がある場合は、Xandr 実装コンサルタントまたはサポートにご相談ください。 詳細については、「 ピクセル 」およびフォーマットのサンプルについて以下の例を参照してください。 既定値: null |
insertion_orders |
オブジェクトの配列 | この広告申込情報が関連付けられている広告掲載オーダーのメタデータを含むオブジェクト。 詳細については、下の 「広告掲載オーダー 」を参照してください。 注: 一度シームレス広告掲載オーダーに関連付けられた広告申込情報は、従来の広告掲載オーダーに関連付けることはできません。 |
goal_pixels |
オブジェクトの配列 |
goal_type
"cpa" のある広告申込情報の場合、コンバージョン トラッキングに使用されるピクセル数と、表示後およびクリック後の収益。 詳細については、「 ゴール ピクセル 」とフォーマットのサンプルに関する以下の例を参照してください。 |
imptrackers |
オブジェクトの配列 | 広告申込情報に関連付けられているサードパーティのインプレッション トラッカー。 詳細は、 インプレッショントラッカーサービスをご覧ください。 読み取り専用。 |
clicktrackers |
オブジェクトの配列 | 広告申込情報に関連付けられている第三者のクリック トラッカー。 詳細については、 クリックトラッカーサービスを参照してください。 読み取り専用。 |
valuation |
object |
goal_type
"cpc"または"cpa"のある広告申込情報の場合、最適化された広告申込情報の入札単価/入札単価なしの締め切りを決定する成果目標のしきい値と、希望するクリック数を表す成果目標目標目標 ("cpa"のコンバージョンはオブジェクトの目標ピクセル配列で設定されます)。 詳細については、下記 の評価 を参照してください。 |
creatives |
オブジェクトの配列 | 品目に関連付けられているクリエイティブ。 詳細については、以下の 「クリエイティブ」 を参照してください。 |
budget_intervals |
オブジェクトの配列 | 予算間隔を使用すると、複数の日付間隔を 1 つの品目に関連付け、それぞれに対応する予算値を持つことができます。 詳細については、以下の 予算間隔 を参照してください。 注: budget_intervals を使用する場合は、次のフィールドを品目オブジェクトで使用しないでください。- lifetime_pacing- lifetime_budget- lifetime_budget_imps- enable_pacing- lifetime_pacing_span- allow_safety_pacing- daily_budget- daily_budget_imps- lifetime_pacing_pct- subflights |
lifetime_budget |
double | このフィールドは使用しないでください。 代わりに、 budget_intervals 配列内の予算フィールドを使用してください。既定値: null (無制限) |
lifetime_budget_imps |
int | このフィールドは使用しないでください。 代わりに、 budget_intervals 配列内の予算フィールドを使用してください。既定値: null (無制限) |
daily_budget |
double | このフィールドは使用しないでください。 代わりに、 budget_intervals 配列内の予算フィールドを使用してください。既定値: null (無制限) |
daily_budget_imps |
double | このフィールドは使用しないでください。 代わりに、 budget_intervals 配列内の予算フィールドを使用してください。既定値: null (無制限) |
enable_pacing |
ブール値 |
true場合、1 日の予算支出は 1 日全体に均等に分散されます。 1 日あたりの予算がある場合にのみ適用されます。 そのため、1 日の予算が設定されている場合は既定で true 、それ以外の場合は既定で null になります。既定値: null |
allow_safety_pacing |
ブール値 | 非推奨。 このフィールドは設定されていない可能性があります。 |
lifetime_pacing |
ブール値 |
trueの場合、ライン アイテムは、製品ライン アイテムのフライト日に全体の有効期間予算を均等に費やそうとします。
trueの場合、daily_budgetを設定できず、enable_pacingを false に設定することはできません。最初に品目のlifetime_budget、start_date、およびend_dateを設定する必要があります。既定値: null |
lifetime_pacing_span |
int |
メモ: このフィールドの値を使用または編集しないでください。 既定値: null (3 日間) |
lifetime_pacing_pct |
double | 50 から 150 までの倍精度浮動小数点の整数で、予算期間全体のペースを設定するために使用されます。 指定できる値は、次のスケールで 50 から 150 の間の任意の double にすることができます。- 50: 予定よりペース遅れています。- 100: ペースを均等にします。- 150: 予定より前のペースで進めます。既定値: 100 |
payout_margin |
double | パフォーマンス オファー品目の支払いマージン。 |
insertion_order_id |
int | 現在有効な広告掲載オーダーの ID (該当する場合)。
GET呼び出しでこのフィールドを返すには、include_insertion_order_id=trueを追加する必要があります。 詳しくは、 広告掲載オーダー サービスをご覧ください。 |
stats |
object | stats オブジェクトは非 推奨 になりました (2016 年 10 月 17 日現在)。 代わりに、統計情報を取得するためにレポート サービス を使用します。 |
all_stats |
配列 | 利用可能なすべての間隔 (今日、昨日、過去 7 日間、有効期間) のラピッド レポートを表示するには、GET リクエストのクエリ文字列に all_status=true を渡します。読み取り専用。 |
first_run |
timestamp | 広告申込情報が第一印象を受けた日時 (1 時間単位で更新)。 この値は UTC タイム ゾーンを反映しています。
GET応答にこの情報を含めるには、クエリ文字列に flight_info=true を渡します。 最初の配信日時に基づいてライン アイテムをフィルター処理する方法の詳細については、以下の 「最初の実行/最後の実行 」を参照してください。読み取り専用。 |
last_run |
timestamp | 広告申込情報が最後のインプレッションを受けた日時。1 時間単位で更新されます。 この値は UTC タイム ゾーンを反映しています。
GET応答にこの情報を含めるには、クエリ文字列に flight_info=true を渡します。 最終配信日時に基づいて広告申込項目をフィルター処理する方法の詳細については、下の 「初回実行/前回実行 」を参照してください。読み取り専用。 |
expected_pacing |
double |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
total_pacing |
double |
非推奨です。 注: stats と Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
has_pacing_dollars |
列挙 |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
has_pacing_imps |
列挙 |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
imps_pacing_percent |
int |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
rev_pacing_percent |
int |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
alerts |
object | 品目の配信を妨げている条件。 アラートには、一時停止と警告の 2 種類があります。 一時停止は意図的でユーザー主導的と見なされますが、警告は意図的ではないと見なされます。 ポーズに基づいて行項目を取得するには、 GET 要求で特定のクエリ文字列パラメーターを渡す必要があります。 考えられる一時停止の完全な一覧など詳細については、以下の 「アラート」 を参照してください。読み取り専用。 |
inventory_type |
列挙 |
非推奨です。 この品目の対象となるインベントリのタイプ。 指定可能な値: "real_time"、 "direct"、または "both"。
"Real-time" には、お客様のネットワークで管理されておらず、再販が有効になっているすべてのサードパーティの在庫が含まれます (Microsoft 広告 Exchange や Google 広告マネージャーなどの外部供給パートナーを含む)。
"Direct" ネットワークで管理されているインベントリのみが含まれます。メモ: このフィールドは引き続き使用できますが、在庫供給ソースを指定するには、オブジェクト内のフィールド supply_strategies 推奨されます。 ただし、オブジェクト内のブール値フィールドのいずれか supply_strategiestrue に設定すると、 inventory_type フィールドの値は完全に無視され、その拡張品目に対して設定できなくなります。既定値: "real_time" |
supply_strategies |
object | ターゲットにする在庫供給ソースを指定するために使用されるいくつかのブール型フィールドを含むオブジェクト。 このオブジェクトのブール値フィールドの値は、 inventory_type フィールドの設定よりも優先され、一度設定すると、 inventory_type フィールドは完全にロックされ無視されます。 詳細については、以下の 供給戦略 を参照してください。 |
creative_distribution_type |
列挙 | 同じサイズの複数のクリエイティブが 1 つの品目を介してトラフィッキングされる場合、このフィールドの設定を使用して、使用するクリエイティブ ローテーション戦略が決定されます。 有効な値は次のとおりです。 - even: 回転も自動的に処理されます。 また、クリエイティブの回転をスプリット レベルで処理する場合は、これを選択します。- weighted: クリエイティブのローテーションは、ユーザーが指定した重み付けに基づきます。- ctr-optimized: サイズ バケット内の CTR が最も高いクリエイティブが最も多く配信されます。既定値: nullメモ: 特定の creative_distribution_type が API 経由で渡されない場合 (null 値が渡される)、 creative_distribution_type の値は even に設定されます。 |
prefer_delivery_over_performance |
ブール値 | このフィールドは、目標の優先度 (デリバリー、パフォーマンス、利益のいずれを優先するか) を示すために使用されます。 オプションは、次のとおりです。 - true: このオプション (配信) は、配信に応じて入札単価を最大 2 倍にすることにより、インプレッション数を優先します。 クリック数に最適化すると、広告申込情報で目標の最大 10 倍まで CPC の過去の在庫を検出できるようになります。警告: これにより、利益率とパフォーマンスの優先度が下がり、利益率がマイナスになる可能性があります。 - false: このオプションを選択すると、次のいずれかの操作が実行されます。- パフォーマンスに優先順位を付けます (クリックなど)。 これにより、インプレッション数と利益よりも広告主の目標が優先されます。 このオプションを選択した場合は、 min_margin_pct ( valuation オブジェクトで) を null に設定する必要もあります。- マージンを優先します。 これにより、最適化された入札単価が希望する利益率だけ減ります。 収益の種類が CPM、動的 CPM、表示可能な CPM、または CPC の場合、アダプティブ ペーシングを通じて追加の利益を獲得できる可能性があります。 このオプションを選択した場合は、 min_margin_pct フィールド ( valuation オブジェクト内) も希望の余白 (例: 10% の場合は 10 ) に設定する必要があります既定値: false |
use_ip_tracking |
ブール値 | 特定の明細行品目に対して IP 属性が有効になっているかどうかを決定します。 |
viewability_vendor |
string | このフィールドでは、広告ユニットの視認性を測定するプロバイダーが決定します。 現在有効な値は "appnexus" のみです。既定値: "appnexus" |
is_archived |
ブール値 | 読み取り専用です。 品目が使用されていないために自動的にアーカイブされたかどうかを示します。
true に設定すると、値を変更することはできず、品目オブジェクトで実行できる呼び出しは GET と DELETE のみです。注: 品目が自動的にアーカイブされた場合、そのプロファイルもアーカイブされ、これらのオブジェクトのいずれかに対して実行できる呼び出しは GET と DELETE のみです。 また、アーカイブされた広告申込情報は広告掲載オーダーに関連付けられなくなる可能性があります。既定値: false |
archived_on |
timestamp | 品目がアーカイブされた日時 (つまり、 is_archived フィールドが true に設定された日時)。既定値: null読み取り専用。 |
partner_fees |
配列 | この明細行品目に適用されるパートナー料金の配列。 パートナー料金サービスでは、サード パーティのパートナー料金を作成または表示できます。 詳細については、以下の パートナー料金 を参照してください。 |
line_item_subtype |
列挙 | 品目のサブタイプ。
line_item_subtype フィールドは、明細行品目の作成後は変更できません。 Invest 購入者の場合、サポートされている値は以下のとおりです。- standard_buying: マネージド、RTB、または取引でサービスを提供できる拡張品目。
POST 要求のline_item_subtypeを省略すると、このサブタイプの動作が既定で使用されます。- pg_buying: PG 取引でのみ取引できます。 サブタイプが POSTで渡される場合、 line_item_type、 bid_object_type、 delivery_model_type、および supply_strategies フィールドは必須ではありません。- standard_curated: キュレーションされた取引品目の場合。 詳細については、「キュレーションされた取引ライン アイテム API セットアップ ガイド」の「line_item_subtype」を参照してください。既定値: standard_buying |
予算/価格設定
| フィールド | 種類 | 説明 |
|---|---|---|
lifetime_budget |
double | ライフタイム予算 (ドル) (メディア コスト)。
Null
"unlimited"に対応します。警告: lifetime_budget が null (無制限) に設定され、広告申込情報と広告掲載オーダーの有効期間の予算も null に設定されている場合、重大な超過支出が発生する可能性があります。既定値: null |
lifetime_budget_imps |
int | ライフサイクル予算 (インプレッション数単位)。
Null
"unlimited"に対応します。既定値: null |
daily_budget |
double | 1 日の予算 (ドル (収益) 単位)。
Null
"unlimited"に対応します。既定値: null |
daily_budget_imps |
int | 1 日あたりの予算 (インプレッション数)。
Null
"unlimited"に対応します。既定値: null |
learn_budget |
double |
非推奨です。 既定値: null |
learn_budget_imps |
int |
非推奨です。 既定値: null |
learn_budget_daily_cap |
double |
非推奨です。 既定値: null |
learn_budget_daily_imps |
int |
非推奨です。 既定値: null |
enable_pacing |
ブール値 |
trueの場合、ライン アイテムの 1 日あたりの予算支出は、毎日均等に分散されます。 これは、 daily_budget が設定されている場合にのみ適用されます。既定値: false |
lifetime_pacing |
ブール値 |
trueの場合、ライン アイテムは、製品ライン アイテムのフライト日に全体の有効期間予算を均等に費やそうとします。
trueの場合、daily_budgetを設定できず、enable_pacingを false に設定することはできません。最初に品目のlifetime_budget、start_date、およびend_dateを設定する必要があります。既定値: false |
lifetime_pacing_span |
int | 過少使用イベントが発生した場合、これは過少使用金額が分配される日数を示します。 既定値の null は 3 日の値を示します。既定値: null |
priority |
int | 管理されたインベントリ (inventory_type は "direct") をターゲットとする広告申込情報の場合、既にインベントリの支払い済みであるため、購入戦略を入力する必要はありません。 ただし、広告申込情報の優先度を設定して、アカウント内の他の直接広告申込情報に対して広告申込情報の重み付けを行うことができます。 優先度の低い広告申込情報の入札単価が高くても、常に優先度が最も高い広告申込情報が優先されます。既定値: 5警告: キュレーションされた取引品目の場合、優先度を設定しないでください。 優先度を設定する必要がある場合は、デフォルトの 5 に設定します。 |
expected_pacing |
double |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
total_pacing |
double |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
has_pacing_dollars |
列挙 |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
has_pacing_imps |
列挙 |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
imps_pacing_percent |
int |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
media_cost_pacing_percent |
int |
非推奨です。 注: stats オブジェクトと Quickstats は非推奨になりました (2016 年 10 月 17 日現在)。 |
供給戦略
supply_strategies オブジェクトは、在庫を購入するときにターゲットにする供給元を指定するために使用されます。
rtb (Open Exchange)、managed、または deals フィールドの任意の組み合わせをターゲットにするには、それぞれを true または false に設定します。 プログラマティック保証取引をターゲットとする場合は、[ programmatic_guaranteed ] フィールドを [ true ] に設定し、[ rtb]、[ managed]、[ deals ] フィールドを [ false] に設定します。 これらの supply_strategies オブジェクト フィールドの少なくとも 1 つを true に設定する必要があります。
注:
取引については、deals フィールドをこのオブジェクト内でtrueに設定するだけでなく、deal_targets配列でターゲットまたは除外する取引のリストを提供し、プロファイルサービスで deal_action_include フィールドを true または false (包含または除外に応じて) に設定することも必要です。
警告
このオブジェクトのブール値フィールドの値は、 inventory_type フィールドの設定より優先されます。 これらのフィールドのいずれかが ALI で true に設定されると、 inventory_type フィールドは無視され、その品目では設定できなくなります。 これらのフィールドの 1 つ以上が true に設定された後で、inventory_typeフィールドの値に対してPUT呼び出しを実行しようとすると、次のエラー メッセージが生成されます: "inventory_type cannot be updated once supply_strategies has been set"。
注:
Line Item API サービスは、 supply_strategy が managedの場合にのみ障害をサポートします。
| フィールド | 種類 | 説明 |
|---|---|---|
rtb |
ブール値 | Open Exchange のインベントリを対象とするかどうかを指定します。 これには、お客様のネットワークで管理されておらず、再販が有効になっているすべての第三者の在庫が含まれます (Microsoft 広告 Exchange や Google 広告マネージャーなどの外部供給パートナーを含む)。 |
managed |
ブール値 | 管理されたインベントリをターゲットにするかどうかを指定します。 これには、ネットワークで管理されているインベントリのみが含まれます。 |
deals |
ブール値 | 取引インベントリをターゲットにするかどうかを指定します。 これには、入札資格のあるすべての取引が含まれます。 |
programmatic_guaranteed |
ブール値 | この品目をプログラマティック保証取引をターゲットにするかどうかを指定します。 この設定が true に設定されている場合は、[ rtb]、[ managed]、および [ deals ] フィールドを false に設定する必要があります。 |
オープンな交換と 2 つの取引をターゲットとするが、管理されたインベントリではない
{code} $ cat LI-supply-strategies.json
{
"line-item": {
...
"supply_strategies": {
"managed": false,
"rtb": true,
"deals": true
}
...
}
}
$ cat profile-supply-strategies.json
{
"profile": {
"deal_action_include": true,
"deal_targets": [
{
"id": 44,
"name": "Deal with external supply partner",
"code": "APN-1234-2200f"
},
{
"id": 45,
"name": "Deal with Console seller",
"code": null
}
]
}
}
{code}
広告主
広告主サービスを使用して、広告主を作成または表示できます。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | この広告主の一意の識別子。 |
name |
string | 上記の一意の ID に関連付けられている広告主の名前。 |
ラベル
読み取り専用の ラベル サービス を使用して、広告申込情報、広告主、広告掲載オーダー、パブリッシャーに使用可能なすべてのラベルを表示できます。 このサービスでは、オブジェクトにすでに適用されているラベルを表示することもできます。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | ラベルの ID。 指定可能な値: 7、 8、 11。 |
name |
列挙 | 読み取り専用です。 ラベルの名前。 使用可能な値: "Trafficker" または "Sales Rep"。 |
value |
string (100) | ラベルに割り当てられている値。 たとえば、 "Sales Rep" ラベルの場合、これは "Michael Sellers" などの名前にすることができます。 |
ブローカー手数料
拡張品目については、ブローカー手数料は廃止されます。 パートナー料金を作成し、 パートナー料金サービスを使用して品目に適用します。
パートナー料金
第三者の費用 (発行元以外の当事者に支払うべき費用) のために予算の一部を予約する必要がある場合は、 パートナー料金サービスでこの情報を定義できます。 手数料は、CPM、コストシェア、または収益シェア ベースで追跡でき、必要に応じて複数の広告主と広告申込情報に適用できます。 1 つの広告主または品目に対して複数の手数料が発生する場合があります。
partner fee 配列には次のフィールドが含まれています。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | この明細行品目に適用されるパートナー料金の ID。 |
広告申込情報に手数料を適用する
$cat LI-update.json
{
"line-item": {
"partner_fees": [
{"id": 4401
},
{ "id": 4402
}
]
}
$curl -b cookie -X PUT -d @LI-update.json "https://api.appnexus.com/line-item?id=2345432"
{
"response": {
"status" : "OK",
"id": 2345432
}
}
品目から手数料を削除する
注:
パートナー料金のrequiredがtrueの場合、品目から料金を削除することはできません。 最初に required を false に設定してから、品目から料金を削除する必要があります。
$curl -b cookie -x GET "https://api.appnexus.com/line-item?id=2345432"
{
"line-item": {
...,
"partner_fees": [
{
"id": 1
},
{"id": 2
},
{"id": 3
}
],
...
}
}
$cat LI-update.json
{
"line-item": {
"partner_fees": [
{
"id": 1
},
{
"id": 3
},
]
}
}
$curl -b cookie -X PUT -d @LI-update.json "https://api.appnexus.com/line-item?id=2345432"
{
"line-item": {
...,
"partner_fees": [
{
"id": 1
},
{
"id": 3
}
],
...
}
}
Pixels
pixels 配列の各オブジェクトには、以下のフィールドが含まれます。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | コンバージョン ピクセルの ID。 |
state |
列挙 | ピクセルの状態。 使用可能な値: "active" または "inactive"。 |
post_click_revenue |
double | ピクセルのクリック後の収益の値。 このフィールドは、品目の revenue_type フィールドが cpa に設定されている場合にのみ設定できます (その結果、このフィールドは拡張品目で使用できません)。 |
post_view_revenue |
double | ピクセルの投稿ビュー収益値。 このフィールド CAB は、品目の revenue_type フィールドが cpa に設定されている場合にのみ設定されます (その結果、このフィールドは拡張品目では使用できません)。 |
name |
string | コンバージョン ピクセルの名前。 読み取り専用。 |
trigger_type |
列挙 | 属性付きコンバージョンに必要なイベントのタイプ。 指定可能な値: "view"、 "click"、または "hybrid"。読み取り専用。 |
広告掲載オーダー
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | 広告掲載オーダーの一意の ID。 メモ: 一度シームレス広告掲載オーダーに関連付けられた広告申込情報は、従来の広告掲載オーダーに関連付けることはできません。 |
state |
列挙 | 広告掲載オーダーの状態 ( "active" または "inactive")。 |
code |
string | この広告掲載オーダーを識別するために使用されるオプションのカスタム コード。 |
name |
string | 広告掲載オーダーの名前。 |
advertiser_id |
int | この広告掲載オーダーに関連付けられている広告主の一意の識別子。 |
start_date |
date | この広告掲載オーダーの開始日。 |
end_date |
date | この広告掲載オーダーの終了日。 |
timezone |
列挙 | この広告掲載オーダーが関連付けられているタイムゾーン。 有効な値の一覧については、「 API タイムゾーン」を参照してください。 |
last_modified |
date | この広告掲載オーダー オブジェクトが最後に更新された日付。 |
currency |
列挙 | この広告掲載オーダーに関連付けられている通貨タイプ。 サポートされている通貨の一覧については、「 通貨サービス」を参照してください。 メモ: 最良の結果を得るには、親の広告掲載オーダーで通貨を設定します。 詳細については、「 広告掲載オーダー サービス」を参照してください。 |
budget_intervals |
オブジェクトの配列 | 関連付けられている広告掲載オーダーの予算間隔のメタデータ。 予算間隔を使用すると、複数の日付間隔を広告掲載オーダーに関連付け、それぞれ対応する予算値を持つことができます。 詳細については、「 広告掲載オーダー サービス」を参照してください。 |
評価
評価オブジェクトは、 goal_type が "cpc" または "cpa" の明細行品目のパフォーマンス目標を設定するために使用されます。 これには、最適化された広告申込情報の入札単価/入札なしの締め切りを決定する成果目標のしきい値と、希望するクリックまたはコンバージョンを表す成果目標が含まれています。
valuation オブジェクトには以下のフィールドがあります。
| フィールド | 種類 | 説明 |
|---|---|---|
min_margin_pct |
decimal | このフィールドは、[ prefer_delivery_over_performance ] を [ false ] に設定しており、[ revenue_type ] を [ cost_plus_margin] に設定していない場合にのみ設定します。 これを希望の最小マージン (例: 10% の 10 ) に設定します。 これにより、配信とパフォーマンスの優先度が下がる可能性があります。既定値: null |
goal_threshold |
decimal | 成果目標のしきい値によって、入札、在庫の検出、および最適化された広告申込情報に対する入札単価/入札単価なしのチェックが決まります。 クリック後のコンバージョンのみについて CTR または CPC 目標、または CPA 目標にのみ最適化する場合、ここに値は必要です。 - CTR に最適化する場合は、希望するクリック率 (0 から 1 までの値) を入力します。 CPC 目標に合わせて最適化する場合は、CPC 目標を入力します。 - クリック後のコンバージョンのみに対してCPA目標に最適化する場合は、CPC目標(CPA目標ではない)を入力し、オブジェクトの goal_pixels配列にpost_click_goal_taskとpost_click_goal_thresholdフィールドを設定します。注: - クリック後のコンバージョンと表示後のコンバージョンの両方でCPA目標に合わせて最適化する場合は、以下の目標 ピクセル で必要な設定を確認してください。 既定値: null |
goal_target |
decimal | パフォーマンス目標目標は、CTR、CPC 目標、CPA 目標 (クリック後のコンバージョンのみ)、ビューアブル CPM 目標に最適化する場合に必要な値です。 - CTR に最適化する場合は、希望するクリック率 ( 0 から 1 の間の値) を入力します。- CPC 目標に合わせて最適化する場合は、CPC 目標を入力します。 - クリック後のコンバージョンのみに対してCPA目標に最適化する場合は、CPC目標(CPA目標ではない)を入力し、オブジェクトの goal_pixels配列にpost_click_goal_targetとpost_click_goal_thresholdフィールドを設定します。- 表示可能なCPMに最適化する場合は、このフィールドを nullに設定します。 |
campaign_group_valuation_strategy |
列挙 | クリック後コンバージョンとビュー後コンバージョンの両方に CPA 目標がある広告申込品目が、リターゲティングと見込み客の発掘に最適化されているかどうかを決定します。 - リターゲティング広告申込情報 (すでにブランドに関心を示しているユーザーをコンバージョン ファネルのさらに下部に誘導することを目的とした広告申込情報) の場合は "retargeting" に設定します。 ライン アイテム プロファイルは、データ マーケットプレースにない少なくとも 1 つのセグメントをターゲットとする必要があります。
プロファイルサービスを使用して、セグメントターゲティングを設定します。- 見込み客の広告申込情報(新規ユーザーをコンバージョン目標到達プロセスに誘導することを目的とした広告申込情報)の "prospecting" に設定します。 |
min_avg_cpm |
double | 平均 CPM を下回らない値。
max_avg_cpm フィールドも設定されている場合、min_avg_cpm は範囲の下限として機能します。
revenue_type を "vcpm" (動的 CPM) または "cost_plus_margin" に設定する場合は、このフィールドを設定する必要があります。
revenue_type を "cpm" に設定する場合は、このフィールドを null に設定する必要があります。 |
max_avg_cpm |
double | 平均 CPM を上回らない値。
min_avg_cpm フィールドも設定されている場合、max_avg_cpm は範囲の上限として機能します。
revenue_type を "vcpm" または "cost_plus_margin" に設定する場合は、このフィールドを設定する必要があります revenue_type を "cpm" に設定する場合は、このフィールドを null に設定する必要があります。コスト プラス ( goal_type フィールド経由) の最適化を無効にした場合は、コスト プラスのフラット CPM を設定する必要があります。 このフィールドを使用して、一律 CPM 値を設定します。 |
min_margin_cpm |
double | マージンの種類が CPM の場合のマージン値。 メモ: min_margin_cpm フィールドと min_margin_pct フィールドの両方を同時に設定することはできません。 一方を設定している場合は、もう一方を nullする必要があります。 Xandr は、クライアントがこれらのフィールドを使用する場合に、顧客の資格を検証します。既定値: null |
min_margin_pct |
double | [余白の種類] が [パーセンテージ] の場合の余白値。 メモ: min_margin_cpm フィールドと min_margin_pct フィールドの両方を同時に設定することはできません。 一方を設定している場合は、もう一方を nullする必要があります。 Xandr は、クライアントがこれらのフィールドを使用する場合に、顧客の資格を検証します。既定値: null |
オークション イベント
auction_event オブジェクト内には、次のフィールドが含まれます。
注:
このオブジェクト内のフィールドが _code または _id で終わる場合は、値を指定しないでください。
_type で終わる auction_event オブジェクトのフィールドの値のみを指定します。 このオブジェクトは、 _code と _id で終わるフィールドを返しますが、 POST および PUT 呼び出しでは無視されます。
| フィールド | 種類 | 説明 |
|---|---|---|
revenue_auction_event_type |
string | このフィールドは、[ revenue_type ] フィールドの設定と組み合わせて使用します。 オプションは、次のとおりです。- "impression": 収益の種類が CPM、動的 CPM、またはコスト プラス マージンの場合は、この値を使用します。- "view": 収益の種類が [視認可能な CPM] の場合は、この値を使用します。 Xandr 視認性測定に従って、IAB 定義を使用して、測定されたビューアブル インプレッションのみがカウントされます。- "click": 収益の種類が CPC の場合は、この値を使用します。- "video": 収益の種類が CPCV の場合は、この値を使用します。 |
revenue_auction_event_type_code |
string | このフィールドは、[ revenue_type ] フィールドの設定と組み合わせて使用します。 オプションは、次のとおりです。- "impression": 収益の種類が CPM、動的 CPM、またはコスト プラス マージンの場合は、この値を使用します。- "view_display_50pv1s_an": 収益の種類が [視認可能な CPM] の場合は、この値を使用します。- "click": 収益の種類が CPC の場合は、この値を使用します。- "video_completion": 収益の種類が CPCV の場合は、この値を使用します。 |
revenue_auction_type_id |
int | このフィールドは、[ revenue_type ] フィールドの設定と組み合わせて使用します。 オプションは、次のとおりです。- 1: 収益の種類が CPM、動的 CPM、またはコスト プラス マージンの場合は、この値を使用します。- 2: 収益の種類が [視認可能な CPM] の場合は、この値を使用します。- 3: 収益の種類が CPC の場合は、この値を使用します。- 10: 収益の種類が CPCV の場合は、この値を使用します。 |
kpi_auction_event_type |
string | このフィールドは、[ goal_type ] フィールドの設定と組み合わせて使用します。 オプションは、次のとおりです。- "impression": この値は、CPC、CPA、CTR に合わせて最適化している場合、または最適化を使用しない場合は、使用します。- "view": この値は、視認可能な CPM に最適化するときに使用します。- "click": 収益の種類が CPC の場合は、この値を使用します。- "video": この値は、CPCV または VCR に最適化する場合に使用します。 |
kpi_auction_event_type_code |
string | このフィールドは、[goal_type] フィールドの設定と組み合わせて使用します。 オプションは、次のとおりです。 - "impression": この値は、CPC、CPA、CTR に合わせて最適化している場合、または最適化を使用しない場合は、使用します。- "view_display_50pv1s_an": この値は、視認可能な CPM に最適化するときに使用します。- "video_completion": この値は、CPCV または VCR に最適化する場合に使用します。 |
kpi_auction_type_id |
int | このフィールドは、[goal_type] フィールドの設定と組み合わせて使用します。 オプションは、次のとおりです。 - 1: この値は、CPC、CPA、CTR に最適化する場合、または最適化を使用しない場合は使用します。- 2: この値は、視認可能な CPM に最適化するときに使用します。- 10: 収益の種類が CPCV または VCR の場合は、この値を使用します。 |
kpi_value |
double | このフィールドは、[ goal_type ] フィールドの設定と組み合わせて使用します。 これを次のいずれかに設定します。- null: CPC、CPA、CTR に最適化している場合、または最適化を使用していない場合。- your goal: ビューアブル CPM 目標 (例: 5) に最適化している場合は、CPCV または VCR。 ビデオ録画の目標は 0 から 1 の間である必要があります。 |
kpi_value_type |
string | このフィールドは、[ kpi_code ] フィールドの設定と組み合わせて使用します。 これを次のいずれかに設定します。- none: CPC、CPA、CTR に最適化している場合、または最適化を使用していない場合。- goal_value: 上記以外のコストベースの目標 (CPCV) に最適化する場合。- rate_threshold: 上記でカバーされていないレートベースの目標 (VCR) に最適化する場合。 |
payment_auction_event_type |
string | このフィールドは、 inventory_type を "real_time" (RTB) に設定した場合、または supply_strategies オブジェクトの rtb フィールドを true に設定した場合にのみ関連します。 オプションは、次のとおりです。- "impression": インプレッション単価を希望する場合。- "view": ビューごとの支払いを希望する場合。 このオプションは、表示可能な CPM またはコスト プラスを使用するように revenue_type フィールドを設定している (最適化を無効にした) 場合にのみ許可されます。- "click": 収益の種類が CPC の場合は、この値を使用します。- "video": 完了した動画ごとに支払う場合。 |
payment_auction_event_type_code |
string | このフィールドは、 inventory_type を "real_time" (RTB) に設定した場合、または supply_strategies オブジェクトの rtb フィールドを true に設定した場合にのみ関連します。 オプションは、次のとおりです。- "impression": インプレッション単価を希望する場合。- "view_display_50pv1s_an": ビューごとの支払いを希望する場合。 このオプションは、表示可能な CPM またはコスト プラスを使用するように revenue_type フィールドを設定している (最適化を無効にした) 場合にのみ許可されます。- "video_completion": 完了した動画ごとに支払う場合。 |
payment_auction_type_id |
int | このフィールドは、 inventory_type を "real_time" (RTB) に設定した場合、または supply_strategies オブジェクトの rtb フィールドを true に設定した場合にのみ関連します。 オプションは、次のとおりです。- 1: インプレッション単価を希望する場合。- 2: ビューごとの支払いを希望する場合。 このオプションは、表示可能な CPM またはコスト プラスを使用するように revenue_type フィールドを設定している (最適化を無効にした) 場合にのみ許可されます。- 10: 完了した動画ごとに支払う場合。 |
予算スケジューリングの設定
budget_scheduling_settings オブジェクト内には、次のフィールドが含まれます。
| フィールド | タイプ (長さ) | 説明 |
|---|---|---|
underspend_catchup_type |
列挙 | Xandr のシステムが、過小な 1 日の予算を処理する方法を示します。 予算の未使用部分を残りのフライトで均等に使いたい場合は "evenly" 値を使用します。未使用予算をできるだけ早く使いたい場合は "ASAP" 値を使用します。使用可能な値: "evenly" または "ASAP"。 |
人口統計測定
in_demo_measurement オブジェクトにより、人口統計測定と、品目に関連する仕様が有効になります。
in_demo_measurement オブジェクトは Nielsen Digital Ad Ratings (DAR) 機能の一部で、使用コストは 0.25 ドル CPM。
注:
コネクテッド テレビ (CTV) の人口統計測定を利用するには、広告申込情報に米国内のみをターゲットとするターゲティング構成が必要です。
JSON 応答内の in_demo_measurement オブジェクトの例
"in_demo_measurement": {
"campaign_group_id": 12795878,
"provider": "nielsen-dar",
"status": "active",
"pixel": null,
"attributes": [{
"key": "on_target_goal_pct",
"value": "50"
},
{
"key": "target_gender",
"value": "all"
},
{
"key": "target_age_lower",
"value": "13"
},
{
"key": "target_age_upper",
"value": "99"
}
]
},
...
| フィールド | タイプ (長さ) | 説明 |
|---|---|---|
campaign_group_id |
int | このフィールドは、 in_demo_measurement オブジェクトをこの明細行品目に関連付けるために使用されます。このフィールドの値は品目の ID です。 読み取り専用。 |
provider |
string | このフィールドは、どのサードパーティ プロバイダーが人口統計測定サービスを提供しているかを示します。 現在、このフィールドで使用できる値は "nielsen-dar" のみです。必須です。 |
status |
ブール値 | このフィールドには、選択した provider がライン アイテムの人口統計測定を確認し、開始したかどうかが示されます。 人口統計測定をアクティブにするには、このフィールドを [ "active"] に設定します。 サードパーティの測定プロバイダーがライン アイテムのインプレッションのトラッキングを開始するまでに最大で 24 時間かかる場合があります。この間、このフィールドの値は "active-pending" に設定されます。使用可能な値: - "active": この品目に対して測定がアクティブ化されており、Xandr はサード パーティ測定プロバイダーの API から確認を受け取りました。 インプレッションは測定中です。- "active-pending": この広告申込情報に対して測定が有効化されていますが、サード パーティ測定プロバイダーの API からの確認を待っているためインプレッション数は測定されていません。- "inactive": この品目では、現在測定が有効になっていません。- "inactive-pending": この値は "inactive" と似ていますが、選択したサードパーティ測定プロバイダーの API が、お客様の広告申込情報の無効化要求をまだ処理していないことを示します。 サード パーティ測定プロバイダーがラインアイテムの測定無効を確認すると、この値は "inactive" に変わります。必須です。 |
pixel |
オブジェクトの配列 | このフィールドの既定値は null です。読み取り専用。 |
attributes |
オブジェクトの配列 | オブジェクトの attributes 配列は、4 つの キーと値のオブジェクト で構成され、品目がターゲティング パフォーマンスを測定しているユーザー層を指定するための値が含まれます。キー値オブジェクトの attributes 配列の詳細については、以下の 人口統計属性 表を参照してください。必須です。 |
attributes オブジェクト
"attributes":[
{
"key":"on_target_goal_pct",
"value":"50"
},
{
"key":"target_gender",
"value":"all"
},
{
"key":"target_age_lower",
"value":"13"
},
{
"key":"target_age_upper",
"value":"99"
}
]
人口統計属性
| キー | タイプ (長さ) | 説明 |
|---|---|---|
on_target_goal_pct |
double | 指定したユーザー層に広告申込情報を配信する頻度を示します (このような指定は、以下のキーの値を挿入することによって行われます)。 この参照目標の割合はレポートに使用され、広告申込情報のパフォーマンスには影響しません。 使用可能な値: 1 から 100。 |
target_gender |
string | ターゲットとする人口統計の性別を指定します。 指定可能な値: "all"、 "male"、または "female"。 |
target_age_lower |
int | ターゲットとする人口統計年齢範囲の年齢しきい値を指定します。 可能な値: 13、 18、 21、 25、 30、 35、 40、 45、 50、 55、 60、または 65。 |
target_age_upper |
int | ターゲットとする人口統計年齢層の年齢制限を指定します。 可能な値: 17、 20、 24、 29、 34、 39、 44、 49、 54、 59、 64、または 99 (年齢 65+ を表します)。 |
オフライン アトリビューション
offline_attribution オブジェクトにより、品目のオフライン売上の属性が有効になります。 オフライン セールス アトリビューションは、Nielsen Catalina Solutions (NCS) が提供する ベータ 版機能であるため、この機能を使用する前に ベータ テストにアクセスする必要があります。 アクセスするには、Xandr アカウント担当者にお問い合わせください。
注:
オフライン販売アトリビューションを利用するには、ライン アイテムに、米国内のみをターゲットとするターゲティング構成が必要です。
JSON PUT要求内の offline_attribution オブジェクトの例
$ cat line-item.json
{
"line-item": {
"id": 1,
...
"offline_attribution": {
"product_group_id": 123,
"report_level_type": "line_item",
"frequency_type": "weekly",
"lookback_type": "flight_lifetime"
}
}
}
$ curl -b cookies -c cookies -X PUT -d @line-item.json "https://api.appnexus.com/line-item?id=ID_INTEGER&advertiser_id=ID_INTEGER"
JSON 応答内の offline_attribution オブジェクトの例
{
"line-item": {
"id": 1,
...
"offline_attribution": {
"product_group_id": 123,
"product_group": {
"provider_member_name": "ncs",
"category_name": "CATEGORY NAME",
"brand_name": "BRAND NAME",
"product_high_name": "PRODUCT HIGH NAME",
"product_low_name": "PRODUCT LOW NAME",
}
"report_level_type": "line_item",
"frequency_type": "weekly",
"lookback_type": "flight_lifetime"
}
}
}
...
JSON PUT要求内で削除される offline_attribution オブジェクトの例
$ cat line-item.json
{
"line-item": {
"id": 1,
...
"offline_attribution": null
}
}
$ curl -b cookies -c cookies -X PUT -d @line-item.json "https://api.appnexus.com/line-item?id=ID_INTEGER&advertiser_id=ID_INTEGER"
| フィールド | 種類 | 説明 |
|---|---|---|
product_group_id |
int | レポートする製品グループのエントリ。 商品グループ ID は、 オフライン属性商品グループ サービスを使用して確認できます。 必須です。 |
offline_attribution_product_group |
object | ( product_group_id の選択に基づいて) 追跡している製品グループに関する情報を返すオブジェクト- provider_member_name- category_name- brand_name- product_high_name- product_low_name読み取り専用。 |
report_level_type |
string | 生成されたレポートに売上属性データを表示する対象。 可能性のある値: - "line_item"- "split"必須です。 |
frequency_type |
string | 品目のオフライン販売属性データ レポートの受信を開始する時期と、新しいレポートが作成される頻度に関連しています。 可能性のある値: - "weekly"- "per_flight"必須です。 |
lookback_type |
string | 生成される各レポートに表示される品目のデータの量に依存します (このフィールドも frequency_type の選択に基づいています)。可能性のある値: - "flight_lifetime"- "last_week"必須です。 |
クリエイティブ
creatives 配列の各オブジェクトには、次のフィールドが含まれます。
"id" または "code" フィールドの情報を取得するには、Creative Service を使用できます。
| フィールド | タイプ (長さ) | 説明 |
|---|---|---|
is_expired |
ブール値 |
true場合、クリエイティブの有効期限が切れています。
falseの場合、クリエイティブはアクティブです。読み取り専用。 |
is_prohibited |
ブール値 |
true場合、クリエイティブは Xandr プラットフォームで禁止されているカテゴリに分類されます。読み取り専用。 |
width |
int | クリエイティブの幅。 読み取り専用。 |
audit_status |
列挙 | クリエイティブの監査ステータス。 使用可能な値: "no_audit"、 "pending"、 "rejected"、 "audited"、または "unauditable"。読み取り専用。 |
name |
string | クリエイティブの名前。 読み取り専用。 |
pop_window_maximize |
ブール値 |
trueの場合、パブリッシャーのタグによってウィンドウが最大化されます。 フォーマット "url-html" と "url-js" を持つクリエイティブにのみ関連します。
pop_window_maximize が true に設定されている場合は、クリエイティブに height も width も設定しないでください。読み取り専用。 |
height |
int | クリエイティブの高さ。 読み取り専用。 |
state |
列挙 | クリエイティブの状態。 使用可能な値: "active" または "inactive"。読み取り専用。 |
format |
列挙 | クリエイティブ ファイルの形式。 可能な値: "url-html"、 "url-js"、 "flash"、 "image"、 "raw-js"、 "raw-html"、 "iframe-html"、または "text"。読み取り専用。 |
is_self_audited |
ブール値 |
true場合、クリエイティブは自己監査対象となります。読み取り専用。 |
id |
int | クリエイティブの ID。 クリエイティブの関連付けを更新する場合は、 id または code が必要です。 |
code |
string | クリエイティブのカスタム コード。 クリエイティブの関連付けを更新する場合は、 id または code が必要です。 |
weight |
int | 広告申込情報レベルで管理される同じサイズのクリエイティブのクリエイティブ ローテーション戦略を決定する、ユーザーが指定した重み付け。 このフィールドを使用するには、 creative_distribution_type の値を "weighted" にする必要があります。 有効な値: 0 より大きく、 1000 以下の整数。 |
ad_type |
string | クリエイティブ広告タイプ。 指定可能な値: "banner"、 "video"、 "native"、 "audio"。メモ: 広告申込情報に関連付けられているすべてのクリエイティブは、同じ広告タイプを設定し、その広告申込情報に選択されている ad_types と一致する必要があります。読み取り専用。 |
all_budget_intervals |
ブール値 | 将来のすべての予算期間を含む、すべての予算期間中にクリエイティブを配信するかどうかを示します。 使用可能な値は次のとおりです。 - True (既定値)- Falsetrue、creatives 配列の custom_date_ranges と budget_intervals 配列の creatives を null に設定する必要があります。 逆に、カスタムの日付範囲やクリエイティブを使用する場合は、 all_budget_intervals を false に設定する必要があります。 |
custom_date_ranges |
オブジェクトの配列 | クリエイティブが配信される期間を設定する日付範囲。 指定した場合: all_budget_intervals
false に設定する必要があります。詳細については、以下の「 ユーザー設定の日付範囲 」を参照してください。 |
ユーザー設定の日付範囲
custom_date_ranges 配列は、クリエイティブが配信される期間を設定します。
日付は、 YYYY-MM-DD hh:mm:ss の形式にする必要があります。
日付範囲はすべて、次の仕様を満たしている必要があります。
- この明細行項目に定義されている予算間隔の開始前または終了後の日付を含めることはできません。
- 日付範囲は少なくとも 1 時間以上にする必要があります。
- 終了日は
2038-01-19 00:00:00より後にすることはできません。
| フィールド | タイプ (長さ) | 説明 |
|---|---|---|
start_date |
timestamp | ユーザー設定の日付範囲の開始日。 形式は YYYY-MM-DD hh:mm:ss にする必要があります (hh:mm:ss は hh:00:00)。 |
end_date |
timestamp | 予算区間の終了日。 形式は YYYY-MM-DD hh:mm:ss にする必要があります (hh:mm:ss は hh:59:59 に設定する必要があります)。 |
カスタム予算間隔でクリエイティブを配信するようにスケジュールする
$cat line-item-with-custom-budget-intervals
{
line_item: {
budget_intervals: [
{
start_date: 1/1/2020,
end_date: 2/1/2020,
lifetime_budget: 1000,
id: 7777,
creatives: [12345]
},
{
start_date: 2/1/2020,
end_date: 3/1/2020,
lifetime_budget: 2000,
id: 8888,
creatives: null
}
],
creatives: [
{
id: 12345,
weight: 1,
all_budget_intervals: false,
custom_date_ranges: [
{
start_date: 2/5/2020 00:00:00,
end_date: 2/10/2020 00:00:00
}
]
},
{
id: 56789,
weight: 2,
all_budget_intervals: true,
custom_date_ranges: null
}
],
creative_distribution_type: weighted
}
}
予算間隔
拡張広告申込情報の予算間隔は、広告申込情報の親広告掲載オーダーで定義されている予算間隔内に収まっている必要があります。 広告申込情報の予算間隔には、親広告掲載オーダーとは異なる予算が必要です。 これらは、対応する広告掲載オーダーの予算間隔における予算の品目固有の "サブ予算" として機能します。
新しい拡張広告申込情報を作成するときは、その各budget_intervals配列オブジェクトのstart_dateとend_dateが、親広告掲載オーダーで定義されている予算間隔のいずれか内にあることを確認します (広告掲載オーダーは、広告掲載オーダーは広告申込情報サービスのinsertion_orders配列を介して広告申込情報に関連付けられます)。
注:
(budget_intervals 配列内の) parent_interval_idは非推奨となり、その値は無視されます。
budget_interval 配列を使用する場合は、次の点も考慮してください。
- 同じ品目の予算間隔が重複することはできません。
- 品目の予算間隔には、有効期間予算を無制限に設定できます (つまり、すべての予算フィールドが
nullに設定されている場合)。 -
line_itemオブジェクトの最上位レベル(このページの「一般」セクションで説明)自体の予算フィールドが設定されている場合、予算間隔を使用できません。 - 品目の予算間隔の予算を増やす場合、最初に親広告掲載オーダーの予算間隔の予算を増やす必要があります (そうしないと、予算が十分でない可能性があります)。 詳細については、「 広告掲載オーダー サービス」を参照してください。
- 最適化が最適に機能するためには、予算間隔を少なくとも 4 時間にする必要があります。
注:
広告申込情報の親広告掲載オーダーの
budget_typeフィールドがimpressionに設定されている場合:- この配列の
lifetime_budgetフィールドとdaily_budgetフィールドは、次の値に設定する必要がありますnull. - この配列の
lifetime_budget_impsまたはdaily_budget_impsフィールドを使用して、品目の予算を設定します。
- この配列の
品目の親広告掲載オーダーの
budget_typeフィールドがrevenueに設定されている場合:- この配列の
lifetime_budget_impsフィールドとdaily_budget_impsフィールドは、次の値に設定する必要がありますnull. - この配列の
lifetime_budgetまたはdaily_budgetフィールドを使用して、品目の予算を設定します。
- この配列の
budget_intervals 配列の各オブジェクトには、次のフィールドが含まれています。
| フィールド | タイプ (長さ) | 説明 |
|---|---|---|
id |
int | 予算間隔の ID。 |
start_date |
timestamp | 予算区間の開始日。 形式は YYYY-MM-DD hh:mm:ss にする必要があります (hh:mm:ss は hh:00:00)。 |
end_date |
timestamp | 予算区間の終了日。 形式は YYYY-MM-DD hh:mm:ss にする必要があります (hh:mm:ss は hh:59:59 に設定する必要があります)。 最適化が最適に機能するためには、予算間隔を少なくとも 4 時間にする必要があります。 このフィールドが null に設定されている場合、明細行品目の予算間隔は無期限に実行されます。 このフィールドを 'null' に設定した場合:- budget_intervals 配列には複数のオブジェクトを含めることはできません (つまり、最大 1 つのバジェット間隔)。- lifetime_pacing フィールドを "false" に設定する必要があります。- "lifetime_budget" は null に設定し、 "daily_budget" フィールドは null 以外または 0 以外の値に設定する必要があります。 |
timezone |
string | 予算と支出がカウントされるタイムゾーン。 受け入れ可能なタイムゾーン値の一覧については、「 API タイムゾーン」を参照してください。 |
parent_interval_id |
int | 非推奨。 このフィールドの値は無視されます。 代わりに、この配列の start_date フィールドと end_date フィールドを使用して、品目が実行されるタイミングを定義します。 |
lifetime_budget |
double | 予算期間の有効期間予算 (収益)。 収益通貨は、insertion_order オブジェクトの currency フィールドによって定義されます。注: この配列の lifetime_budget_imps フィールドも設定した場合、先に予算が使い果たされた方で支出が停止します。 ベスト プラクティスは、これらのフィールドの 1 つのみを設定することです。 |
lifetime_budget_imps |
double | 予算期間の有効期間予算 (インプレッション数)。 メモ: この広告掲載オーダーに広告申込情報を追加する場合、広告掲載オーダーに追加される前にこれらの広告申込情報に関連付けられている費用は、広告掲載オーダーの有効期間予算にはカウントされません。 広告申込情報が広告掲載オーダーの子である間に発生した支出のみカウントされます。 注: この配列の lifetime_budget フィールドも設定した場合、先に予算が使い果たされた方で支出が停止します。 ベスト プラクティスは、これらのフィールドの 1 つのみを設定することです。 |
lifetime_pacing |
ブール値 |
true場合、品目は予算間隔にわたって有効期間予算を均等に配慮します。
true場合は、lifetime_budget または lifetime_budget_imps を設定する必要があります。 |
daily_budget |
double | 予算期間の 1 日あたりの予算 (収益)。 収益通貨は、insertion_order オブジェクトの currency フィールドによって定義されます。 メモ: この広告掲載オーダーに広告申込情報を追加する場合、広告掲載オーダーに追加されたときにそれらの広告申込情報に関連付けられたインプレッションは、広告掲載オーダーの有効期間予算にカウントされません。 広告申込情報が広告掲載オーダーの子である間に発生したインプレッションのみがカウントされます。 注: daily_budget_imps フィールドも設定した場合、先に使い果たされた予算があれば支出が停止します。 ベスト プラクティスは、これらのフィールドの 1 つのみを設定することです。 |
daily_budget_imps |
double | 1 日あたりの予算 (インプレッション数)。 注: 親広告掲載オーダーの budget_type フィールドが "impression"、広告申込情報のrevenue_typeフィールドが視認可能な CPM に設定されている場合は、視認可能なインプレッションのみ広告申込情報と広告掲載オーダーの両方の予算にカウントされます。daily_budget フィールドも設定した場合、先に使い果たされた予算があれば支出が停止します。 ベスト プラクティスは、これらのフィールドの 1 つのみを設定することです。 |
enable_pacing |
ブール値 |
true場合、支出は 1 日のペースで調整されます。
daily_budgetがある場合にのみ適用されます。 |
creatives |
配列 | この予算間隔に関連付けられているクリエイティブを指定します。 配信するには、広告の [ライン アイテム creatives ] フィールドにもクリエイティブを指定し、 all_budget_intervals を falseする必要があります。 |
予算間隔の削除
注:
拡張された品目から予算間隔を削除できます。 ただし、親広告掲載オーダーから予算間隔を削除する場合、まず、広告掲載オーダーに関連付けられているすべての拡張広告申込情報から (親広告掲載オーダーの予算間隔内にある) 予算間隔を削除する必要があります。 広告掲載オーダーから予算間隔を削除できるのは、そのときだけです。 詳しくは、 広告掲載オーダー サービスをご覧ください。
$ cat delete-budget-interval
{
"line-item": {
"budget_intervals": [
{
"id": 79970,
"start_date": null,
"end_date": null
}
]
}
}
サブフライトの作成
$ cat create-subflight
{
"line-item": {
...,
"budget_intervals": [
{
"id": 342856,
"lifetime_pacing_percent": 150,
"lifetime_budget": 10000,
"lifetime_budget_imps": null,
"start_date": "2022-04-01 00:00:00",
"end_date": "2022-04-30 11:59:59",
...,
"subflights": [
{
"id": 1, // ID generated on LI creation or update
"name": "spend 200 every weekend for entire flight",
"is_recurring": true,
"use_flight_date_range": true,
"recurring_day_of_week": [0,1,6],
"start_date": null,
"end_date": null,
"daily_budget": 80,
"daily_budget_imps": null,
"subflight_pacing_percent": null,
}
]
}
],
...
}
}
サブフライトを削除する
$ cat delete-subflight
{
"line-item": {
...,
"budget_intervals": [
{
"id": 342856,
"subflights": [
{
"id": 1,
"use_flight_date_range": false,
"start_date": null,
"end_date": null,
}
]
}
],
...
}
}
| フィールド | タイプ (長さ) | 説明 |
|---|---|---|
id |
int | 新しいサブフライトの作成時に生成されるサブフライト ID。 読み取り専用。 |
name |
string | サブフライトに指定された名前。 必須です。 |
is_recurring |
ブール値 | サブフライトが繰り返されるかどうかを決定します。 サブフライトが繰り返し実行されるということは、サブフライトが有効になる曜日を選択できるのに対し、標準サブフライトは開始日と終了日で常に稼働するということです。 使用可能な値は次のとおりです。 - true: 定期的なサブフライト。- false: (既定値) Standard サブフライト。必須です。 |
recurring_day_of_week |
整数の配列 | 定期的なサブフライトを有効にする曜日を決定します。 1 日または連続する最大 6 日間を選択します。 使用可能な値は次のとおりです。 - 0 (日曜日)- 1 (月曜日)- 2 (Tuesday)- 3 (Wednesday)- 4 (木曜日)- 5 (金曜日)- 6 (土曜日)土曜日から月曜日 例: "recurring_day_of_week": [0, 1, 6]。以下の場合に必須 is_recurringが true と等しい。 |
use_flight_date_range |
ブール値 | サブフライトが親フライトの日付範囲を使用するか、サブフライトの start_date と end_date の選択によって決定される独自の日付範囲を使用するかを決定します。使用可能な値は次のとおりです。 - true: サブフライトは親フライトの日付範囲を使用します。- false: サブフライトでは、独自の開始日と終了日が使用されます。注: is_recurring を false に設定した場合は、use_flight_date_range も false に設定する必要があります。必須です。 |
start_date |
日付 (yyyy-mm-dd) | サブフライトの開始日 (お客様の品目で指定されたタイム ゾーンに関連します)。 開始日の選択は、サブフライトの予算間隔で選択した開始日と一致するか、それより後に開始する必要があります。 注: use_flight_date_range が true に設定されている場合は、このフィールドの値を null に設定する必要があります。以下の場合に必須 is_recurringが false と等しい。 |
end_date |
日付 (yyyy-mm-dd) | サブフライトの終了日 (お客様の品目の指定タイム ゾーンに関連します)。 終了日の選択は、サブフライトの予算間隔で選択した終了日と一致するか、それより早く終了する必要があります。 注: use_flight_date_range が true に設定されている場合は、このフィールドの値を null に設定する必要があります。以下の場合に必須 is_recurringが false と等しい。 |
daily_budget |
int | サブフライトが 1 日に費やせるようにする金額を決定します。 このフィールドを選択するには、親フライトの lifetime_pacing_percent フィールドの選択を null に設定する必要があります。注: 1 日あたりの予算でサブフライトを利用しているときに品目が支出不足している場合は、サブフライトではない次の日付に過小支出のキャッチアップ設定が有効になります。 以下の場合に必須 daily_budgetは、親フライトには提供されません。 |
daily_budget_imps |
double | サブフライトの獲得が許可されている 1 日のインプレッション数。 注: 1 日あたりの予算でサブフライトを利用しているときに品目が支出不足している場合は、サブフライトではない次の日付に過小支出のキャッチアップ設定が有効になります。 以下の場合に必須: - 親フライトの daily_budget等しいtrueサブフライトのサブフライトdaily_budgetequalsnull.- 親フライトの lifetime_pacing_percentequalsnull. |
subflight_pacing_percent |
double | サブフライトの予算が開始日と終了日の間でどの程度均等に配分されるかを決定します。100 に設定すると、サブフライトの予算ペースは変更されず、サブフライトに適用されるすべての日に分散され、毎日ほぼ同様の予算額が費やされます。
100 よりも高く設定すると、サブフライトの日付範囲の開始時には 1 日あたりの消費額が多くなり、終了時の消費額は少なくなります。 ペーシングが 100 より小さい場合は逆になります。使用可能な値は次のとおりです。 50-150以下の場合に必須 daily_budgetは提供されません。 |
ゴール ピクセル
オブジェクトの goal_pixels 配列は、 goal_type"cpa" を操作するために使用され、パフォーマンス目標、しきい値に関する情報が含まれます。 オブジェクトの goal_pixels 配列に含まれる各オブジェクトには、以下のフィールドが含まれます。
| フィールド | 種類 | 説明 |
|---|---|---|
id |
int | コンバージョン ピクセルの ID。 |
state |
列挙 | ピクセルの状態。 使用可能な値: "active" または "inactive"。 |
post_click_goal |
double | 非推奨。 代わりに post_click_goal_target と post_click_goal_threshold を使用してください。 |
post_view_goal |
double | 非推奨。 代わりに post_view_goal_target と post_view_goal_threshold を使用してください。 |
trigger_type |
列挙 | 属性付きコンバージョンに必要なイベントのタイプ。 指定可能な値: "view"、 "click"、または "hybrid"。読み取り専用。 |
post_click_goal_target |
double | ピクセルのクリック後のコンバージョンに対する広告主の目標値。 CPA 目標を設定して、クリック後のコンバージョンのみに最適化する場合は、このフィールドを CPA 目標値に設定します。 |
post_view_goal_target |
double | ピクセルの表示後のコンバージョンに対する広告主の目標値 (goal_type"cpc" の goal_value と同等)。 CPA 目標を設定し、ビュー後のコンバージョンにのみ最適化する場合は、このフィールドが null に設定されていることを確認します。 |
post_click_goal_threshold |
double | ピクセルのクリック後コンバージョンの広告主の目標しきい値。 これにより、最適化された広告申込情報の入札/入札カットオフなしが決まります。 CPA 目標を設定し、クリック後と表示後のコンバージョンの両方に最適化するには、このフィールドに post_view_goal_thresholdと同じ値を入れる必要があります。 |
post_view_goal_threshold |
double | ピクセルの表示後のコンバージョンに関する広告主の目標しきい値。 これにより、最適化された広告申込情報の入札/入札カットオフなしが決まります。 CPA 目標を設定し、クリック後と表示後のコンバージョンの両方に最適化するには、このフィールドに post_click_goal_thresholdと同じ値を入れる必要があります。 |
統計情報
注:
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'
注:
never_run=true を他のフィルターと組み合わせて使用できますが、常に OR 関係になることに注意してください。 たとえば、クエリ文字列に never_run=true と min_first_run=2012-01-01 00:00:00 の両方を渡す場合、配信したことがない明細行品目、または 2012-01-01 以降に最初に配信された明細行品目を探します。
特定の日付以降に最初に配信された広告申込情報のみを取得する
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 オブジェクトを追加します。
注:
以下の各ユース ケースで、alerts オブジェクトを応答に表示する場合は、show_alerts=true を渡す必要があります。
$ 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."
}
],
"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/line-item?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"
}
},
...
],
...
}
}
}
一時停止
| ID | 説明 |
|---|---|
1 |
状態は非アクティブに設定されます。 |
2 |
フライト開始は将来です。 |
4 |
フライトの終了は過去です。 |
例
CPC パフォーマンス目標を使用するように品目を更新する
この例では、CPC パフォーマンス目標を使用するように品目を更新します。 クリックあたりのコスト目標のしきい値は 3 ドルに設定されています。
$ 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":3,
"goal_threshold":3
}
"lifetime_budget": null,
"end_date": null,
"enable_pacing": null,
"allow_safety_pacing": null,
"publishers_allowed": "all"
}
}
curl -b cookies -c cookies -X PUT -d @line-item "https://api.appnexus.com/line-item?id=152083&advertiser_id=51"
CPC と CPA の両方のパフォーマンス目標を使用するように広告申込情報を更新する
この例では、CPC と CPA パフォーマンス目標の両方を使用するように品目を更新します。 CPC 目標を 5 ドル、CPA 目標を 10 ドルに設定しています。
$ 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"
}
],
"goal_pixels":[
{
"id":"123456",
"post_click_goal_threshold":10,
"post_click_goal_target":10
}
],
“valuation”: {
“goal_target”: 5,
“goal_threshold”: 5
}
}
}
curl -b cookies -X PUT -d @line-item "https://api.appnexus.com/line-item?id=152083&advertiser_id=51"
品目の表示
特定の広告申込情報を表示するには、クエリ文字列を介して広告申込情報と広告主 ID を渡す必要があります。
$ curl -b cookies -c cookies 'https://api.appnexus.com/line-item?id=4979347&advertiser_id=1887392'
{
"response": {
"count": 1,
"dbg_info": {
"output_term": "line-item",
"version": "1.18.227",
"warnings": []
},
"line-item": {
"ad_types": [
"banner"
],
"advertiser": {
"id": 1887392,
"name": "ALI Closed Beta Demo Advertiser"
},
"advertiser_id": 1887392,
"allow_safety_pacing": null,
"auction_event": null,
"bid_object_type": "creative",
"broker_fees": null,
"budget_intervals": [
{
"code": null,
"enable_pacing": true,
"end_date": "2017-12-02 23:59:59",
"id": 2509919,
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"lifetime_pacing": true,
"lifetime_pacing_pct": 100,
"object_id": 4979347,
"object_type": "campaign_group",
"parent_interval_id": null,
"start_date": "2017-11-30 00:00:00",
"timezone": "US/Eastern"
}
],
"budget_set_per_flight": true,
"campaigns": null,
"click_url": null,
"clicktrackers": null,
"code": null,
"comments": null,
"creative_distribution_type": null,
"creatives": null,
"currency": "USD",
"custom_models": [
{
"active": "1",
"id": 477441,
"name": "cadence 2017-11-07 18:03:37.738",
"type": "cadence"
}
],
"custom_optimization_note": null,
"daily_budget": null,
"daily_budget_imps": null,
"deals": null,
"delivery_goal": null,
"discrepancy_pct": 0,
"enable_pacing": null,
"enable_v8": false,
"end_date": null,
"goal_pixels": [
{
"id": 932952,
"name": "Test Pixel",
"post_click_goal": null,
"post_click_goal_confidence_threshold": null,
"post_click_goal_target": 10,
"post_click_goal_threshold": 10,
"post_click_model_id": null,
"post_view_goal": null,
"post_view_goal_confidence_threshold": null,
"post_view_goal_target": null,
"post_view_goal_threshold": null,
"post_view_model_id": null,
"state": "active",
"trigger_type": "hybrid"
}
],
"goal_type": "cpc",
"goal_value": null,
"id": 4979347,
"imptrackers": null,
"incrementality": null,
"insertion_orders": [
{
"advertiser_id": 1887392,
"budget_intervals": [
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": null,
"id": 2509856,
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 676605,
"object_type": "insertion_order",
"start_date": "2017-11-30 00:00:00",
"timezone": "US/Eastern"
}
],
"code": null,
"currency": "USD",
"end_date": null,
"id": 676605,
"last_modified": "2017-12-01 02:44:34",
"name": "Swetha_Seamless_IO",
"start_date": null,
"state": "active",
"timezone": "US/Eastern"
}
],
"inventory_discovery": {
"fail_criteria_amount": 9.486486,
"fail_criteria_type": "booked_revenue",
"use_ranked_discovery": true
},
"inventory_discovery_budget": null,
"inventory_type": "real_time",
"labels": null,
"last_modified": "2017-12-02 05:30:29",
"lifetime_budget": null,
"lifetime_budget_imps": null,
"lifetime_pacing": null,
"lifetime_pacing_pct": null,
"lifetime_pacing_span": null,
"line_item_type": "standard_v2",
"manage_creative": true,
"member_id": 1370,
"name": "Swetha_ALI_Basic_API1",
"pixels": [
{
"id": 932952,
"name": "Test Pixel",
"post_click_revenue": null,
"post_view_revenue": null,
"state": "active",
"trigger_type": "hybrid"
}
],
"prefer_delivery_over_performance": false,
"priority": "5",
"profile_id": 96266622,
"publishers_allowed": "all",
"remaining_days": null,
"require_cookie_for_tracking": true,
"revenue_type": "vcpm",
"revenue_value": null,
"roadblock": null,
"start_date": null,
"state": "active",
"timezone": "US/Eastern",
"total_days": null,
"valuation": {
"bid_price_pacing_enabled": false,
"bid_price_pacing_lever": 0,
"goal_confidence_threshold": null,
"goal_target": 5,
"goal_threshold": 5,
"max_avg_cpm": 3,
"max_revenue_value": null,
"min_avg_cpm": 2,
"min_margin_pct": null,
"min_revenue_value": null,
"no_revenue_log": false
}
},
"num_elements": 100,
"start_element": 0,
"status": "OK"
}
}
広告主のすべての広告申込情報を表示する
上記の例とは異なり、この品目にはオブジェクトの goal_pixels 配列がアタッチされています。 この広告主の品目は 1 つだけですが、 line-items JSON 配列を介して返されることに注意してください。
$ curl -b cookies 'https://api.appnexus.com/line-item?advertiser_id=51'
{
"response": {
"count": 3,
"line-items": [
{ ..."id": 4274691,...},
{ ..."id": 4983291,...},
{ ..."id": 4983258,...}
]
}
}
CPA 目標 (クリック後と表示後のコンバージョン) に最適化された CPM 収益タイプで広告申込情報を作成する
cat li_cpa.json
{
"line-item": {
"name": "LI CPA Test",
"state": "inactive",
"daily_budget": null,
"revenue_type": "cpm",
"goal_type": "cpa",
"goal_pixels": [
{
"id": 987654321,
"name": "Confirmation Page",
"post_click_goal": null,
"post_click_goal_confidence_threshold": null,
"post_click_goal_target": 1,
"post_click_goal_threshold": 1,
"post_click_model_id": null,
"post_view_goal": null,
"post_view_goal_confidence_threshold": null,
"post_view_goal_target": 1,
"post_view_goal_threshold": 1,
"post_view_model_id": null,
"state": "active",
"trigger_type": "hybrid"
}
],
"valuation": {
"bid_price_pacing_enabled": false,
"bid_price_pacing_lever": 0,
"campaign_group_valuation_strategy": "retargeting",
"goal_confidence_threshold": null,
"goal_target": null,
"goal_threshold": null,
"max_avg_cpm": null,
"max_revenue_value": null,
"min_avg_cpm": null,
"min_margin_pct": null,
"min_revenue_value": null,
"no_revenue_log": false
},
}
$curl -b cookies -X POST -d @li_cpa.json 'https://api.appnexus.com/line-item?advertiser_id=12345'
{
"response": {
"count": 1,
"dbg_info": {
"output_term": "line-item",
"version": "1.18.1023",
"warnings": []
},
"line-item": {
"ad_types": [
"banner"
],
"advertiser": {
"id": 12345,
"name": "Console Challenge (Please Do Not Modify)"
},
"advertiser_id": 12345,
"allow_safety_pacing": null,
"archived_on": null,
"auction_event": {
"kpi_auction_event_type": "impression",
"kpi_auction_event_type_code": "impression",
"kpi_auction_type_id": 1,
"kpi_value": null,
"payment_auction_event_type": "impression",
"payment_auction_event_type_code": "impression",
"payment_auction_type_id": 1,
"revenue_auction_event_type": "impression",
"revenue_auction_event_type_code": "impression",
"revenue_auction_type_id": 1
},
"bid_object_type": "creative",
"broker_fees": null,
"budget_intervals": [
{
"code": null,
"enable_pacing": true,
"end_date": "2019-02-11 23:59:59",
"id": 3886503,
"lifetime_budget": 0.01,
"lifetime_budget_imps": null,
"lifetime_pacing": true,
"lifetime_pacing_pct": 100,
"object_id": 7358523,
"object_type": "campaign_group",
"parent_interval_id": null,
"start_date": "2019-02-10 00:00:00",
"timezone": "US/Eastern"
}
],
"budget_set_per_flight": false,
"campaigns": null,
"click_url": null,
"clicktrackers": null,
"code": null,
"comments": null,
"creative_distribution_type": "ctr-optimized",
"creatives": null,
"currency": "USD",
"custom_models": [
{
"active": "1",
"experiment": "control",
"id": 222333,
"name": "Test 001",
"origin": "optimization",
"type": "conv_imp"
},
{
"active": "1",
"experiment": "control",
"id": 222334,
"name": "Test 002",
"origin": "optimization",
"type": "cadence"
},
{
"active": "1",
"experiment": "control",
"id": 222335,
"name": "Budget Splitter - 7358523 - Mon Feb 11 2019 04:08:49 GMT+0000",
"origin": "splitters",
"type": "budget_splitter"
}
],
"custom_optimization_note": null,
"daily_budget": null,
"daily_budget_imps": null,
"deals": null,
"delivery_goal": null,
"discrepancy_pct": 0,
"enable_pacing": null,
"enable_v8": false,
"end_date": null,
"flat_fee": null,
"flat_fee_type": null,
"goal_pixels": [
{
"id": 987654321,
"name": "Confirmation Page",
"post_click_goal": null,
"post_click_goal_confidence_threshold": null,
"post_click_goal_target": 1,
"post_click_goal_threshold": 1,
"post_click_model_id": null,
"post_view_goal": null,
"post_view_goal_confidence_threshold": null,
"post_view_goal_target": 1,
"post_view_goal_threshold": 1,
"post_view_model_id": null,
"state": "active",
"trigger_type": "hybrid"
}
],
"goal_type": "cpa",
"goal_value": null,
"id": 87654321,
"imptrackers": null,
"incrementality": null,
"insertion_orders": [
{
"advertiser_id": 12345,
"budget_intervals": [
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": "2018-05-31 23:59:59",
"id": 2957582,
"lifetime_budget": 100,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 811332,
"object_type": "insertion_order",
"start_date": "2018-05-23 00:00:00",
"timezone": "US/Eastern"
},
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": "2018-09-24 23:59:59",
"id": 3331427,
"lifetime_budget": 100,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 811332,
"object_type": "insertion_order",
"start_date": "2018-09-23 00:00:00",
"timezone": "US/Eastern"
},
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": "2018-11-30 23:59:59",
"id": 3494586,
"lifetime_budget": 600,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 811332,
"object_type": "insertion_order",
"start_date": "2018-10-31 00:00:00",
"timezone": "US/Eastern"
},
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": "2018-12-12 23:59:59",
"id": 3636004,
"lifetime_budget": 300,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 811332,
"object_type": "insertion_order",
"start_date": "2018-12-07 00:00:00",
"timezone": "US/Eastern"
},
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": "2019-01-14 23:59:59",
"id": 3746556,
"lifetime_budget": 400,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 811332,
"object_type": "insertion_order",
"start_date": "2019-01-07 00:00:00",
"timezone": "US/Eastern"
},
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": "2019-01-22 23:59:59",
"id": 3773032,
"lifetime_budget": 0.01,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 811332,
"object_type": "insertion_order",
"start_date": "2019-01-15 00:00:00",
"timezone": "US/Eastern"
},
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": "2019-02-06 23:59:59",
"id": 3857762,
"lifetime_budget": 0.01,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 811332,
"object_type": "insertion_order",
"start_date": "2019-02-04 00:00:00",
"timezone": "US/Eastern"
},
{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": "2019-02-28 23:59:59",
"id": 3886493,
"lifetime_budget": 600,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 811332,
"object_type": "insertion_order",
"start_date": "2019-02-10 00:00:00",
"timezone": "US/Eastern"
}
],
"code": null,
"currency": "USD",
"end_date": null,
"id": 811332,
"last_modified": "2019-02-25 15:36:24",
"name": "Natasha Test IO",
"start_date": null,
"state": "active",
"timezone": "US/Eastern"
}
],
"inventory_discovery": null,
"inventory_type": "both",
"is_archived": false,
"labels": null,
"last_modified": "2019-03-01 21:12:45",
"lifetime_budget": null,
"lifetime_budget_imps": null,
"lifetime_pacing": null,
"lifetime_pacing_pct": null,
"lifetime_pacing_span": null,
"line_item_type": "standard_v2",
"manage_creative": true,
"member_id": 1370,
"name": "Copy test2_01_17",
"pixels": [
{
"id": 1017110,
"name": "Confirmation Page",
"post_click_revenue": null,
"post_view_revenue": null,
"state": "active",
"trigger_type": "hybrid"
}
],
"prefer_delivery_over_performance": false,
"priority": "5",
"profile_id": 109625231,
"publishers_allowed": "all",
"remaining_days": null,
"require_cookie_for_tracking": true,
"revenue_type": "cpm",
"revenue_value": 1,
"roadblock": null,
"start_date": null,
"state": "inactive",
"supply_strategies": {
"deals": false,
"managed": false,
"rtb": true
},
"timezone": "US/Eastern",
"total_days": null,
"user_info": {
"creator_id": 17707,
"owner_id": 17707
},
"valuation": {
"bid_price_pacing_enabled": false,
"bid_price_pacing_lever": 0,
"campaign_group_valuation_strategy": "retargeting",
"goal_confidence_threshold": null,
"goal_target": null,
"goal_threshold": null,
"max_avg_cpm": null,
"max_revenue_value": null,
"min_avg_cpm": null,
"min_margin_pct": null,
"min_revenue_value": null,
"no_revenue_log": false
},
"viewability_vendor": "appnexus"
},
"num_elements": 100,
"start_element": 0,
"status": "OK"
}
}
収益タイプが動的 CPM で、CPC 目標に最適化された広告申込情報を作成します
この例では、CPC 目標を $5、最小平均 CPM を $2、最大平均 CPM を $3 に設定します。
{code}$ cat line_item_dcp_cpc
{
"line-item": {
"ad_types": [
"banner"
],
"advertiser": {
"id": 1887392,
"name": "ALI Closed Beta Demo Advertiser"
},
"currency": "USD",
"insertion_orders": [{
"advertiser_id": 1887392,
"budget_intervals": [{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": null,
"id": 2509856,
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 676605,
"object_type": "insertion_order",
"start_date": "2017-11-30 00:00:00",
"timezone": "US/Eastern"
}],
"code": null,
"currency": "USD",
"end_date": null,
"id": 676605,
"last_modified": "2017-12-01 02:44:34",
"name": "Swetha_Seamless_IO",
"start_date": null,
"state": "active",
"timezone": "US/Eastern"
}],
"advertiser_id": 1887392,
"budget_intervals": [{
"code": null,
"enable_pacing": true,
"end_date": "2017-12-02 23:59:59",
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"lifetime_pacing": true,
"lifetime_pacing_pct": 100,
"parent_interval_id": null,
"start_date": "2017-11-30 00:00:00",
"timezone": "US/Eastern"
}],
"goal_pixels": null,
"goal_type": "cpc",
"goal_value": null,
"inventory_type": "real_time",
"line_item_type": "standard_v2",
"manage_creative": true,
"name": "Swetha_ALI_Basic_API1",
"profile_id": 96266482,
"revenue_type": "vcpm",
"revenue_value": null,
"state": "active",
"valuation": {
"goal_target": 5,
"goal_threshold": 5,
"min_avg_cpm": 2,
"max_avg_cpm": 3
}
}
}
{code}
{code}
curl -b cookies -X POST -d @line_item_dcp_cpc.json "https://api.appnexus.com/line-item?&advertiser_id=1887392"
{code}
収益タイプを視認可能な CPM で、CPC と CPA の両方の目標に最適化した広告申込情報を作成します
この例では、収益タイプが視認可能な CPM、CPC 目標を 5 ドル、CPA 目標を 10 ドルに設定した広告申込情報を作成します。
{code}$ cat line_item_dcp_vcpm_cpaopt
{
"line-item": {
"ad_types": [
"banner"
],
"advertiser": {
"id": 1887392,
"name": "ALI Closed Beta Demo Advertiser"
},
"currency": "USD",
"insertion_orders": [{
"advertiser_id": 1887392,
"budget_intervals": [{
"code": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": false,
"end_date": null,
"id": 2509856,
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"object_id": 676605,
"object_type": "insertion_order",
"start_date": "2017-11-30 00:00:00",
"timezone": "US/Eastern"
}],
"code": null,
"currency": "USD",
"end_date": null,
"id": 676605,
"last_modified": "2017-12-01 02:44:34",
"name": "Swetha_Seamless_IO",
"start_date": null,
"state": "active",
"timezone": "US/Eastern"
}],
"advertiser_id": 1887392,
"budget_intervals": [{
"code": null,
"enable_pacing": true,
"end_date": "2017-12-02 23:59:59",
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"lifetime_pacing": true,
"lifetime_pacing_pct": 100,
"parent_interval_id": null,
"start_date": "2017-11-30 00:00:00",
"timezone": "US/Eastern"
}],
"goal_type": "cpa",
"goal_value": null,
"inventory_type": "real_time",
"line_item_type": "standard_v2",
"manage_creative": true,
"name": "Swetha_ALI_VCPM_CPA",
"profile_id": 96293804,
"revenue_type": "cpm",
"revenue_value": 3,
"state": "active",
"goal_pixels": [{
"id": 932952,
"post_click_goal_target": 10,
"post_click_goal_threshold": 10
}],
"pixels": [{
"id": 932952
}],
"valuation": {
"goal_target": 5,
"goal_threshold": 5
},
"auction_event": {
"revenue_auction_event_type": "view",
"revenue_auction_event_type_code": "view_display_50pv1s_an",
"revenue_auction_type_id": 2}
}
}
{code}
{code}
curl -b cookies -X POST -d @line_item_dcp_vcpm_cpaopt.json “https://api.appnexus.com/line-item?&advertiser_id=1887392”
{code}
VCR 目標に最適化された CPM 収益タイプの広告申込情報を作成する
この例では、VCR の目標を 50% に、CPM 収益の値を 3 ドルに設定します。
注:
品目に VCR 目標を適用するには、[マネージド サプライ戦略] を [ false ] に設定する必要があります。 VCR の最適化は、管理されたインベントリを対象とする品目ではサポートされていません。
$ cat line_item_vcr
{
"line-item": {
"ad_types": [
"video"
],
"advertiser": {
"id": 4127136,
"name": "VCR Test Advertiser"
},
"advertiser_id": 4127136,
"inventory_type": "both",
"name": "Test VCR LI",
"state": "active",
"currency": "USD",
"timezone": "US/Eastern",
"revenue_type": "cpm",
"revenue_value": 3,
"supply_strategies": {
"managed": false,
"rtb": true,
"deals": false,
"programmatic_guaranteed": false
},
"goal_type": "none",
"budget_intervals": [
{
"id": 12024043,
"object_id": 14286184,
"object_type": "campaign_group",
"start_date": "2021-03-19 00:00:00",
"end_date": "2021-04-30 23:59:59",
"timezone": "US/Eastern",
"code": null,
"parent_interval_id": null,
"creatives": null,
"subflights": null,
"lifetime_budget": 2,
"lifetime_budget_imps": null,
"lifetime_pacing": true,
"enable_pacing": true,
"lifetime_pacing_pct": 100,
"daily_budget_imps_opt": null,
"daily_budget_opt": null
}
],
"insertion_orders": [
{
"id": 3205367,
"state": "inactive"
"name": "VCR Test IO",
"advertiser_id": 4127136,
"currency": "USD",
"budget_intervals": [
{
"id": 6461220,
"object_id": 3205367,
"object_type": "insertion_order",
"start_date": "2019-11-30 00:00:00",
"end_date": "2019-12-31 23:59:59",
"timezone": "US/Eastern",
"code": null,
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"enable_pacing": false,
"daily_budget_imps": null,
"daily_budget": null,
"daily_budget_imps_opt": null,
"daily_budget_opt": null
}
],
}
],
"auction_event": {
"payment_auction_event_type_code": "impression",
"payment_auction_event_type": "impression",
"payment_auction_type_id": 1,
"revenue_auction_event_type_code": "impression",
"revenue_auction_event_type": "impression",
"revenue_auction_type_id": 1,
"kpi_auction_event_type_code": "video_completion",
"kpi_auction_event_type": "video",
"kpi_auction_type_id": 10,
"kpi_value_type": "rate_threshold",
"kpi_value": 0.5
},
"valuation": {
"min_margin_pct": null,
"min_margin_cpm": null,
"max_avg_cpm": null,
"min_avg_cpm": null,
"min_revenue_value": null,
"max_revenue_value": null,
"goal_target": null,
"goal_threshold": null,
"no_revenue_log": false,
"bid_price_pacing_enabled": false,
"bid_price_pacing_lever": 0,
"campaign_group_valuation_strategy": null,
"goal_confidence_threshold": null
}
}
}
広告申込情報を更新して、視認可能な CPM 目標に最適化する
この例では、最適化する品目をビューアブル CPM 目標である $5 に更新しています。
{code}$ cat line_item_vcpmopt.json
{
"line-item": {
"goal_type": "none",
"goal_value": null,
"name": "ALI_VCPMOpt",
"state": "active",
"goal_pixels": null,
"auction_event": {
"kpi_auction_event_type": "view",
"kpi_auction_event_type_code": "view_display_50pv1s_an",
"kpi_auction_type_id": 2,
"kpi_value": 5
}
}
}
{code}
{code}
curl -b cookies -X PUT -d @line_item_vcpmopt.json "https://api.appnexus.com/line-item?id=152083&advertiser_id=1887392"
{code}
表示可能な CPM の収益タイプを使用するように広告申込情報を更新する
この例では、収益タイプとして VCPM を使用するように品目を更新し、値を 3 ドルに設定しています。
{code}$ cat lineitem_vcpm.json
{
"line-item": {
"goal_type": "none",
"goal_value": null,
"inventory_type": "real_time",
"line_item_type": "standard_v2",
"revenue_type": "cpm",
"revenue_value": 3,
"state": "active",
"auction_event": {
"revenue_auction_event_type": "view",
"revenue_auction_event_type_code": "view_display_50pv1s_an",
"revenue_auction_type_id": 2}
}
}
{code}
{code}
curl -b cookies -X PUT -d @lineitem_vcpm.json "https://api.appnexus.com/line-item?id=152083&advertiser_id=1887392"
{code}
クリック単価の収益タイプを使用するように品目を更新する
この例では、収益タイプとして CPC を使用するように品目を更新し、収益の値を 3 ドルに設定します。
{code}$ cat line_item_cpc.json
{
"line-item": {
"inventory_type": "real_time",
"line_item_type": "standard_v2",
"revenue_type": "cpm",
"revenue_value": 3,
"state": "active",
"auction_event": {
"revenue_auction_event_type": "click",
"revenue_auction_event_type_code": "click",
"revenue_auction_type_id": 3
}
}
}
{code}
{code}
curl -b cookies -X PUT -d @line_item_cpc.json "https://api.appnexus.com/line-item?id=152083&advertiser_id=1887392"
{code}
Cost Plus Margin (一律 CPM を支払う) の収益タイプを使用し、最適化を無効にするように明細行項目を更新する
この例では、収益の種類を Cost Plus Margin、マージンが 20% で最適化が無効になっている、使用するように明細行品目を更新しています。 CPM は、11 の一律 CPM です。
{code}$ cat line_item_costplus_base.json
{
"line-item": {
"goal_type": "none",
"goal_value": null,
"inventory_type": "real_time",
"line_item_type": "standard_v2",
"revenue_type": "cost_plus_margin",
"revenue_value": 0.20,
"state": "active",
"goal_pixels": null,
"valuation":{"max_avg_cpm": 11}
}
}
{code}
{code}
curl -b cookies -X PUT -d @line_item_costplus_base.json "https://api.appnexus.com/line-item?id=152083&advertiser_id=1887392"
{code}
明細行品目を更新して最適化を無効にする
この例では、品目を更新して最適化を無効にしています。
{code}$ cat line_item_no_opt.json
{
"line-item": {
"auction_event": {
"kpi_auction_event_type": "impression",
"kpi_auction_event_type_code": "impression",
"kpi_auction_type_id": 1,
"kpi_value": null,
"payment_auction_event_type": "impression",
"payment_auction_event_type_code": "impression",
"payment_auction_type_id": 1,
"revenue_auction_event_type": "impression",
"revenue_auction_event_type_code": "impression",
"revenue_auction_type_id": 1
},
"goal_pixels": null,
"goal_type": "none",
"goal_value": null
}
}
{code}
{code}
$ curl -b cookies -X PUT -d @line_item_no_opt.json "https://api.appnexus.com/line-item?&id=152083&advertiser_id=1887392"
{code}
プログラマティック保証の購入品目を作成する
シナリオ: 販売者とプログラマティック保証取引 (PG 取引) を交渉し、この取引をプログラマティック保証購入ラインアイテム (PG 購入ライン アイテム) でターゲットとしたいと考えています。
PG 取引プロファイルを作成し、このプロファイルの ID をメモします (プロファイル サービスの「プログラマティック保証取引をターゲットとする」を参照)。
PG 購買ライン アイテム JSON を作成します (既存の広告掲載オーダー ID とプロファイル ID が必要です)。
$ cat pg_buying_line_item { "line-item": { "insertion_orders": [ { "id": 1234 } ], "name": "My PG Buying Line Item", "state": "active", "ad_types": [ "banner" ], "profile_id": 123456, "currency": "USD", "supply_strategies": { "rtb": false, "managed": false, "deals": false, "programmatic_guaranteed": true }, "revenue_value": 0.0, "revenue_type": "cost_plus_margin", "creatives": [], "require_cookie_for_tracking": false, "line_item_type": "standard_v2", "manage_creative": true } }この PG 購入ライン アイテム JSON と適切な
advertiser_idを使用して、https://api.appnexus.com/line-itemエンドポイントにPOST要求を行います。$ curl -b cookies -X POST -d @pg_buying_line_item 'https://api.appnexus.com/line-item?advertiser_id=123' { "response": { "status": "OK", "count": 1, "id": 8757356, "start_element": 0, "num_elements": 100, "line-item": { "id": 8757356, "code": null, "name": "My PG Buying Line Item", "advertiser_id": 123, "state": "active", "start_date": null, "end_date": null, "timezone": "CET", "discrepancy_pct": 0, "publishers_allowed": "all", "revenue_value": 0, "revenue_type": "cost_plus_margin", "goal_type": "none", "goal_value": null, "last_modified": "2019-08-07 19:49:45", "click_url": null, "currency": "USD", "require_cookie_for_tracking": false, "profile_id": 123456, "member_id": 958, "flat_fee_type": null, "comments": null, "remaining_days": null, "total_days": null, "manage_creative": true, "budget_set_per_flight": true, "creative_distribution_type": null, "line_item_type": "standard_v2", "bid_object_type": "creative", "prefer_delivery_over_performance": false, "priority": "5", "enable_v8": false, "viewability_vendor": null, "is_archived": false, "archived_on": null, "delivery_model_type": "standard", "advertiser": { "id": 123, "name": "My Advertiser" }, "flat_fee": null, "supply_strategies": { "managed": false, "rtb": false, "deals": false, "programmatic_guaranteed": true }, "deals": null, "delivery_goal": null, "labels": null, "broker_fees": null, "pixels": null, "insertion_orders": [ { "id": 1234, "state": "active", "code": null, "name": "Test IO", "advertiser_id": 123, "start_date": null, "end_date": null, "timezone": "CET", "last_modified": "2018-03-06 21:16:47", "currency": "USD", "budget_intervals": [ { "id": 2436841, "object_id": 1234, "object_type": "insertion_order", "start_date": "2017-11-08 00:00:00", "end_date": "2017-11-13 23:59:59", "timezone": "CET", "code": null, "lifetime_budget": 10, "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": null, "creatives": null, "budget_intervals": null, "custom_models": null, "inventory_discovery": null, "incrementality": null, "auction_event": null, "custom_optimization_note": null, "roadblock": null, "ad_types": null, "user_info": null, "partner_fees": null, "product": null, "in_demo_measurement": 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, "inventory_type": "both" }, "dbg_info": { "warnings": [], "version": "1.18.1247", "output_term": "line-item" } } }
品目を削除する
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"}
}
}
}
広告申込情報を更新して CPCV に最適化する
この例では、広告申込情報を更新して CPCV $0.08 に最適化しています。
{code}$ cat line_item_CPCV.json
{
"line-item": {
"goal_type": "none",
"goal_value": null,
"name": "ALI_CPCV",
"state": "active",
"goal_pixels": null,
"auction_event": {
"payment_auction_event_type_code": "impression",
"payment_auction_event_type": "impression",
"payment_auction_type_id": 1,
"revenue_auction_event_type_code": "impression",
"revenue_auction_event_type": "impression",
"revenue_auction_type_id": 1,
"kpi_auction_event_type_code": "video_completion",
"kpi_auction_event_type": "video",
"kpi_auction_type_id": 10,
"kpi_value_type": "goal_value",
"kpi_value": 0.08
}
}
}
{code}
{code}
curl -b cookies -X PUT -d @line_item_CPCV.json "https://api.appnexus.com/line-item?id=152083&advertiser_id=1887392"
{code}
CPCV に最適化されていない広告申込情報
この例では、CPCV に最適化されていない広告申込情報があります。
{code}$ cat line_item_CPCV.json
{
"line-item": {
"goal_type": "none",
"goal_value": null,
"name": "ALI_CPCV",
"state": "active",
"goal_pixels": null,
"auction_event": {
"kpi_auction_event_type": "impression",
"kpi_auction_event_type_code": "impression",
"kpi_auction_type_id": 1,
"kpi_value": null,
"kpi_value_type": "none",
"payment_auction_event_type": "impression",
"payment_auction_event_type_code": "impression",
"payment_auction_type_id": 1,
"revenue_auction_event_type": "impression",
"revenue_auction_event_type_code":
"impression", "revenue_auction_type_id": 1 }
}
}
{code}
{code}
curl -b cookies -X PUT -d @line_item_CPCV.json "https://api.appnexus.com/line-item?id=152083&advertiser_id=1887392"
{code}