明細サービス - ALI

広告申込情報は、予算、収益の種類、パフォーマンス目標、入札戦略、在庫ターゲティングなど、広告主との財務関係を定義します。 拡張明細は、シームレス挿入順序と共に使用する必要があります。 広告掲載注文に予算間隔を追加することで、長年の広告主関係の設定を効率化することをお勧めします。

REST API

HTTP メソッド	エンドポイント	説明
POST	https://api.appnexus.com/line-item?advertiser_id=ADVERTISER_ID (行項目 JSON)	新しい行項目を追加します。
PUT	- https://api.appnexus.com/line-item?id=LINEITEM_ID&advertiser_id=ADVERTISER_ID - https://api.appnexus.com/line-item?code=LINE-ITEM_CODE&advertiser_code=ADVERTISER_CODE (行項目 JSON)	既存の行項目を変更します。
GET	- https://api.appnexus.com/line-item?advertiser_id=ADVERTISER_ID - https://api.appnexus.com/line-item?code=LINE-ITEM_CODE&advertiser_code=ADVERTISER_CODE	広告主のすべての広告申込情報を表示します。
GET	https://api.appnexus.com/line-item?id=1,2,3 注: 役立つクエリ文字列フィルター - 最初と最後に配信されたタイミングに基づいて、行項目をフィルター処理できます。 これは、オブジェクトの制限に近づき、システムから削除できる明細を特定する必要がある場合に特に便利です。 詳細については、「最初の 実行/最後の実行」を参照してください。 - さまざまな条件が原因で提供されていない行をフィルター処理できます。 詳細については、以下 の「アラート 」を参照してください。	コンマ区切りのリストを使用して、ID で複数の行項目を表示します。
GET	https://api.appnexus.com/line-item?search=SEARCH_TERM	ID または特定の文字を含む名前を持つ行項目を検索します。
DELETE	- https://api.appnexus.com/line-item?id=LINEITEM_ID&advertiser_id=ADVERTISER_ID - https://api.appnexus.com/line-item?code=LINE-ITEM_CODE&advertiser_code=ADVERTISER_CODE 警告: 削除は再帰的で永続的です また、広告申込情報を削除すると、インプレッション トラッカー、クリック トラッカー、関連する予算間隔、分割もすべて削除されます。 削除は永続的であり、元に戻すことはできません。 削除されたオブジェクトは引き続きレポートで使用できますが、特定の設定 (収益予算、追跡、コスト予算、ターゲット設定など) は表示されなくなります。	行項目を削除します。

JSON フィールド

全般

フィールド	種類	説明
id	int	明細の ID。 クエリ文字列で必要な On:PUT。
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": 標準明細 (非 ALI)。 - "standard_v2": 拡張行項目 (ALI)。 - "guaranteed_delivery": 保証された行項目 (GDLI)。 - "curated": キュレーションされた行項目。 注: このフィールドが ALI の "standard_v2" に設定されていることを確認します。 デフォルト："standard_v2"
start_date	timestamp	このフィールドは使用しないでください。 代わりに、budget_intervals配列内の start_date フィールドと end_date フィールドを使用して、行項目を実行するタイミングを指定します。 Default:null (すぐに)
end_date	timestamp	このフィールドは使用しないでください。 代わりに、budget_intervals配列内の start_date フィールドと end_date フィールドを使用して、行項目を実行するタイミングを指定します。 Default:null (無期限)
timezone	列挙	予算と支出をカウントするタイムゾーン。 詳細と受け入れられる値については、「 API タイムゾーン」を参照してください。 注: ALI の場合は、このフィールド ( budget_intervals 配列内のフィールドではなく) を使用して、行項目のタイム ゾーンを設定してください。 Default:"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"]、["click"] に"revenue_auction_event_type_code"、"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に設定します。 IAB 定義を使用して、Xandr の視認性の測定に従って、測定された表示可能なインプレッションのみがカウントされます。   - CPCV の場合は、これを "cpm" に設定し、[ad_types] フィールドを ["video"]、["revenue_auction_event_type"] を ["video"]、["video_completion"] に"revenue_auction_event_type_code"、"revenue_auction_type_id"を [10] に設定します。 - "vcpm": 動的な CPM (予約収益は、入札減額前のインプレッションのコストと等しくなります)。 ここで "vcpm" 選択した場合、 goal_type が 'none'に設定されており、 'expected_value' モデルがアタッチされていない場合は、 'max_avg_cpm' 値を設定する必要があります。 注: (supply_strategiesの) programmatic_guaranteedが true に設定されている場合は、revenue_typeを cost_plus_margin または cost_plus_cpm に設定する必要があります。 - "cost_plus_margin": メディア コスト (インベントリに費やすもの) に加えて、支出した金額の割合。 選択した場合は、 revenue_value を受け取る割合 (20%) の .2 に設定する必要もあります。 サード パーティのデータ消去 (セグメントなど) に参加すると、データ コストも追加されます。 Cost Plus の最適化を無効にした場合 ([ goal_type ] フィールドを使用)、 max_avg_cpm フィールド ( valuation オブジェクト) を使用して Cost Plus のフラット CPM を設定する必要があります。 - "cost_plus_cpm": メディア コスト (広告枠に費やしたもの) と、CPM 収益に基づいて広告主に請求するサービス料金。 選択した場合は、 revenue_value を受け取るフラットな CPM マージン (たとえば、$1 CPM の 1 ) に設定する必要もあります。 サード パーティのデータ消去 (セグメントなど) に参加すると、データ コストも追加されます。 Cost Plus の最適化を無効にした場合 ([ goal_type ] フィールドを使用)、 max_avg_cpm フィールド ( valuation オブジェクト) を使用して Cost Plus のフラット CPM を設定する必要があります。 注: lifetime_budget_impsフィールドまたはdaily_budget_impsフィールドが設定されている場合、または明細の親挿入順序のbudget_typeがimpressionに設定されている場合、revenue_typeは"CPC"に設定されない可能性があります。 デフォルト："none"
goal_type	列挙	パフォーマンス目標を利用する行項目の場合。 使用可能な値: null、 "cpc"、 "cpa"、 "ctr"、または "custom"。 - クリック後コンバージョンとポストビューコンバージョンの両方でコンバージョン単価のパフォーマンス目標に最適化する場合は、このフィールドを "cpa"に設定します。 また、(オブジェクトのgoal_pixels配列内の) post_click_goal_thresholdフィールドとpost_videw_goal_thresholdフィールドを CPA 目標に設定する必要があります。 Xandr は 1 つの値に最適化するため、これらの値は同じである必要があります。 さらに、 campaign_group_valuation_strategy を "retargeting" または "prospecting"" に設定する必要があります。 詳細については、以下の評価のcampaign_valuation_strategyを参照してください。 - クリック後のコンバージョンに対してのみコンバージョン単価のパフォーマンス目標に最適化する場合は、このフィールドを "cpa" に設定します。 また、(オブジェクトのgoal_pixels配列内の) post_click_goal_targetフィールドとpost_click_goal_thresholdフィールドを CPA 目標に設定する必要があります。 - CPC 目標に最適化する場合は、このフィールドを "cpc" に設定します。 また、(valuation オブジェクト内の) goal_targetフィールドとgoal_thresholdフィールドを 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 呼び出しの場合、行項目が以前に Viewable 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	文字列	行項目に関するコメント。
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"です。 詳細については、以下の 「ラベル 」を参照してください。 注: Network Analytics レポートと Network Advertiser Analytics レポートを使用して、広告申込情報のラベルに関するレポートを作成できます。 たとえば、 "Trafficker" ラベルを使用して、各広告申込情報の責任者の名前を指定する場合は、 "trafficker_for_line_item" でフィルター処理された Network Analytics レポートを実行して、特定の密売人が担当する広告申込情報に焦点を当てたり、 "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	オブジェクトの配列	予算間隔を使用すると、複数の日付間隔を、それぞれ対応する予算値を持つ明細にアタッチできます。 詳細については、以下の 「予算間隔 」を参照してください。 注: 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 配列内の予算フィールドを使用します。 Default:null (無制限)
lifetime_budget_imps	int	このフィールドは使用しないでください。 代わりに、 budget_intervals 配列内の予算フィールドを使用します。 Default:null (無制限)
daily_budget	double	このフィールドは使用しないでください。 代わりに、 budget_intervals 配列内の予算フィールドを使用します。 Default:null (無制限)
daily_budget_imps	double	このフィールドは使用しないでください。 代わりに、 budget_intervals 配列内の予算フィールドを使用します。 Default: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	手記： このフィールドの値を使用または編集しないでください。 Default:null (3 日間)
lifetime_pacing_pct	double	予算間隔全体でペーシングを設定するために使用される、50 から 150 までの 2 倍の整数。 使用可能な値は、次のスケールで 50 と 150 の間の任意の倍精度です。 - 50: スケジュールの遅れをとります。 - 100: 均等にペースを合わせる。 - 150: スケジュールより早くペースを取ります。 デフォルト：100
payout_margin	double	パフォーマンス オファーのアイテムの支払いマージン。
insertion_order_id	int	現在アクティブな挿入順序の ID (該当する場合)。 GET呼び出しでこのフィールドを返すには、include_insertion_order_id=trueを追加する必要があります。 詳細については、 挿入注文サービスを参照してください。
stats	object	stats オブジェクトは 非推奨 になりました (2016 年 10 月 17 日現在)。 代わりに Report Service を使用して統計情報を取得します。
all_stats	配列	使用可能なすべての間隔 (今日、昨日、過去 7 日間、有効期間) の Rapid Reports を表示するには、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 Advertising Exchange や Google アド マネージャーなどの外部供給パートナーを含む) が含まれます。 "Direct" には、ネットワークによって管理されるインベントリのみが含まれます。 手記： このフィールドは引き続き使用できますが、 supply_strategies オブジェクト内のフィールドは、在庫供給元を指定するための推奨メカニズムです。 ただし、 supply_strategies オブジェクト内のブール型フィールドのいずれかを trueに設定すると、 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: 次のいずれかの操作を行うには、このオプションを選択します。   - パフォーマンスに優先順位を付けます (クリック数など)。 これにより、インプレッションの量と利益よりも広告主の目標が優先されます。 このオプションを選択する場合は、(valuation オブジェクト内の) min_margin_pctも null に設定する必要があります。   - 余白に優先順位を付ける。 これにより、目的の利益率で最適化された入札が減ります。 収益の種類が CPM、動的 CPM、表示可能 CPM、または CPC の場合、アダプティブ ペーシングによって追加のマージンが獲得される可能性があります。 このオプションを選択する場合は、(valuation オブジェクト内の) min_margin_pct フィールドを目的の余白 (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 フィールドを変更することはできません。 投資購入者の場合、サポートされる値は次のとおりです。 - 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
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オブジェクトは、在庫の購入時にターゲットとする供給元を指定するために使用されます。 各フィールドを true または false に設定することで、rtb (Open Exchange)、managed、または deals フィールドの任意の組み合わせを対象にすることができます。 プログラムによる保証取引を対象とする場合は、 programmatic_guaranteed フィールドを true に設定し、 rtb、 managed、 deals フィールドを falseに設定します。 これらの supply_strategies オブジェクト フィールドの少なくとも 1 つを trueに設定する必要があります。

フィールド	種類	説明
rtb	ブール値	Open Exchange でインベントリをターゲットにするかどうかを指定します。 これには、再販売が有効になっているネットワークで管理されていないすべてのサードパーティインベントリ (Microsoft Advertising 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
    }
}

明細から手数料を削除する

$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	文字列	変換ピクセルの名前。 読み取り専用。
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	オブジェクトの配列	関連付けられた挿入順序からの予算間隔のメタデータ。 予算間隔を使用すると、複数の日付間隔を挿入オーダーにアタッチし、それぞれに対応する予算値を付けることができます。 詳細については、「 挿入順序サービス」を参照してください。

評価

評価対象は、"cpc"または"cpa"のgoal_typeを持つ明細のパフォーマンス目標を設定するために使用されます。 パフォーマンス目標のしきい値が含まれています。最適化された広告申込情報の入札/入札の上限を決定し、目的のクリック数またはコンバージョン数を表すパフォーマンス目標ターゲットが決まります。

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 目標に最適化する場合は、クリック単価の目標を入力します。 - クリック後のコンバージョンに対してのみ CPA 目標に最適化する場合は、クリック単価の目標 (CPA 目標ではなく) を入力し、オブジェクトのgoal_pixels配列のpost_click_goal_taskフィールドとpost_click_goal_threshold フィールドを設定します。 注: - クリック後とポストビューの両方のコンバージョンで CPA 目標に最適化する場合は、必要な設定については、以下の 「目標ピクセル 」を参照してください。 デフォルト：null
goal_target	decimal	パフォーマンス目標目標は、CTR、CPC 目標、CPA 目標 (クリック後のコンバージョンのみ)、または表示可能な CPM 目標に最適化する場合に必要な値です。 - CTR に最適化する場合は、目的のクリックスルー 率 ( 0 と 1の間の値) を入力します。 - CPC 目標に最適化する場合は、クリック単価の目標を入力します。 - クリック後のコンバージョンに対してのみ CPA 目標に最適化する場合は、クリック単価の目標 (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 ] フィールドを使用)、Cost Plus のフラット CPM を設定する必要があります。 このフィールドを使用して、フラット CPM 値を設定します。
min_margin_cpm	double	余白の種類が CPM の場合の余白の値。 手記：min_margin_cpmフィールドとmin_margin_pctフィールドの両方を同時に設定することはできません。 1 つが設定されている場合は、もう一方を nullする必要があります。 Xandr は、クライアントがこれらのフィールドを使用する場合に、顧客の権利を検証します。 デフォルト：null
min_margin_pct	double	[余白の種類] が [パーセンテージ] の場合の余白の値。 手記：min_margin_cpmフィールドとmin_margin_pctフィールドの両方を同時に設定することはできません。 1 つが設定されている場合は、もう一方を nullする必要があります。 Xandr は、クライアントがこれらのフィールドを使用する場合に、顧客の権利を検証します。 デフォルト：null

オークションイベント

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

フィールド	種類	説明
revenue_auction_event_type	string	このフィールドは、 revenue_type フィールドの設定と組み合わせて使用されます。 オプションは、次のとおりです。 - "impression": 収益の種類が CPM、動的 CPM、または Cost Plus Margin の場合は、この値を使用します。 - "view": 収益の種類が表示可能な CPM の場合は、この値を使用します。 IAB 定義を使用して、Xandr の視認性の測定に従って、測定された表示可能なインプレッションのみがカウントされます。 - "click": 収益の種類が CPC の場合は、この値を使用します。 - "video": 収益の種類が CPCV の場合は、この値を使用します。
revenue_auction_event_type_code	string	このフィールドは、 revenue_type フィールドの設定と組み合わせて使用されます。 オプションは、次のとおりです。 - "impression": 収益の種類が CPM、動的 CPM、または Cost Plus Margin の場合は、この値を使用します。 - "view_display_50pv1s_an": 収益の種類が表示可能な CPM の場合は、この値を使用します。 - "click": 収益の種類が CPC の場合は、この値を使用します。 - "video_completion": 収益の種類が CPCV の場合は、この値を使用します。
revenue_auction_type_id	int	このフィールドは、 revenue_type フィールドの設定と組み合わせて使用されます。 オプションは、次のとおりです。 - 1: 収益の種類が CPM、動的 CPM、または Cost Plus Margin の場合は、この値を使用します。 - 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 に最適化している場合。 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 または Cost Plus (および無効な最適化) を使用するように revenue_type フィールドを設定した場合にのみ使用できます。 - "click": 収益の種類が CPC の場合は、この値を使用します。 - "video": ビデオごとに支払いを完了する場合。
payment_auction_event_type_code	文字列	このフィールドは、 inventory_type を "real_time" (RTB) に設定しているか、 supply_strategies オブジェクトの rtb フィールドを trueに設定している場合にのみ関連します。 オプションは、次のとおりです。 - "impression": インプレッションごとに支払う場合。 - "view_display_50pv1s_an": ビューごとに支払う場合。 このオプションは、表示可能な CPM または Cost Plus (および無効な最適化) を使用するように revenue_type フィールドを設定した場合にのみ使用できます。 - "video_completion": ビデオごとに支払いを完了する場合。
payment_auction_type_id	int	このフィールドは、 inventory_type を "real_time" (RTB) に設定しているか、 supply_strategies オブジェクトの rtb フィールドを trueに設定している場合にのみ関連します。 オプションは、次のとおりです。 - 1: インプレッションごとに支払う場合。 - 2: ビューごとに支払う場合。 このオプションは、表示可能な CPM または Cost Plus (および無効な最適化) を使用するように 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) 機能の一部であり、使用する CPM は 0.25 ドルです。

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	文字列	このフィールドは、人口統計測定サービスを提供しているサード パーティのプロバイダーを示します。 現在、このフィールドで使用可能な値は "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	指定した人口統計に広告申込情報を配信する頻度を示します (このような仕様は、以下のキーの値を挿入することによって行われます)。 この参照目標の割合はレポートで使用され、行項目のパフォーマンスには影響しません。 使用可能な値: 100に1。
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	文字列	広告申込情報のオフライン販売属性データ レポートの受信を開始するタイミングと、新しいレポートが作成される頻度に関係します。 考えられる値: - "weekly" - "per_flight" 必須です。
lookback_type	文字列	生成された各レポートに表示される行項目データの量に関連します (このフィールドは、 frequency_type の選択内容にも基づいています)。 考えられる値: - "flight_lifetime" - "last_week" 必須です。

クリエイティブ

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

フィールド	型 (長さ)	説明
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 (既定値) - False true場合は、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が、親挿入順序で定義されている予算間隔の 1 つに収まるようにします (挿入順序は、行項目サービスのinsertion_orders配列を介して行項目に関連付けられます)。

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

• 同じ明細の予算間隔は重複できません。
• 明細の予算間隔には、無制限の有効期間予算を設定できます (つまり、すべての予算フィールドが nullに設定されている場合)。
• 予算間隔は、(このページの「全般」セクションで説明されているように) line_item オブジェクトの最上位レベルの予算フィールド自体が設定されている場合は使用できません。
• 明細の予算間隔の予算を増やす場合は、まず親挿入指図の予算間隔の予算を増やす必要があります (それ以外の場合は、十分な予算がない可能性があります)。 詳細については、「 挿入順序サービス」を参照してください。
• 最適化が最適に機能するには、予算間隔の期間が少なくとも 4 時間である必要があります。

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	文字列	予算と支出をカウントするタイムゾーン。 許容されるタイムゾーン値の一覧については、「 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 (火曜日) - 3 (水曜日) - 4 (木曜日) - 5 (金曜日) - 6 (土曜日) 土曜日から月曜日の例:"recurring_day_of_week": [0, 1, 6]。 必要な場合is_recurringequalstrue。
use_flight_date_range	ブール値	サブフライトの start_date と end_date の選択によって、サブフライトがその親フライトの日付範囲または独自の日付範囲を使用するかどうかを決定します。 使用可能な値: - true: サブフライトは、その親フライトの日付範囲を使用します。 - false: サブフライトでは、独自の開始日と終了日が使用されます。 注: is_recurringを false に設定した場合は、use_flight_date_rangeも false に設定する必要があります。 必須です。
start_date	date (yyyy-mm-dd)	サブフライトの開始日 (広告申込情報の指定されたタイム ゾーンを基準とする)。 開始日の選択は、サブフライトの予算間隔で選択した開始日と一致するか、それより後に開始する必要があります。 注: use_flight_date_rangeが true に設定されている場合は、このフィールドの値を null に設定する必要があります。 必要な場合is_recurringequalsfalse。
end_date	date (yyyy-mm-dd)	サブフライトの終了日 (広告申込情報の指定されたタイム ゾーンを基準とする)。 終了日の選択は、サブフライトの予算間隔で選択された終了日と一致するか、それより前に終了する必要があります。 注: use_flight_date_rangeが true に設定されている場合は、このフィールドの値を null に設定する必要があります。 必要な場合is_recurringequalsfalse。
daily_budget	int	サブフライトが毎日費やすことができる金額を決定します。 このフィールドを選択するには、親フライトの lifetime_pacing_percent フィールド選択を nullに設定する必要があります。 注: 1 日の予算でサブフライトを利用しているときに広告申込情報が不足している場合、不足分のキャッチアップ設定は次のサブフライト以外の日付に有効になります。 必要な場合daily_budgetは親フライトには提供されません。
daily_budget_imps	double	サブフライトが獲得できる 1 日あたりのインプレッション数。 注: 1 日の予算でサブフライトを利用しているときに広告申込情報が不足している場合、不足分のキャッチアップ設定は次のサブフライト以外の日付に有効になります。 次の場合に必要です。 - 親フライトのdaily_budgetequalstrueとサブフライトの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 目標値に設定します。
post_view_goal_target	double	ピクセルのポストビューコンバージョンの広告主の目標値 (goal_type"cpc"のgoal_valueに相当)。 コンバージョン単価の目標を設定し、コンバージョン後にのみ最適化する場合は、このフィールドが null に設定されていることを確認します。
post_click_goal_threshold	double	ピクセルのクリック後コンバージョンの広告主の目標しきい値。 これにより、最適化された明細に対する入札/未入札のカットオフが決まります。 コンバージョン単価の目標を設定し、クリック後コンバージョンとポストビューコンバージョンの両方に最適化する場合、このフィールドには post_view_goal_thresholdと同じ値が含まれている必要があります。
post_view_goal_threshold	double	ピクセルのポストビューコンバージョンの広告主の目標しきい値。 これにより、最適化された明細に対する入札/未入札のカットオフが決まります。 コンバージョン単価の目標を設定し、クリック後コンバージョンとポストビューコンバージョンの両方に最適化する場合、このフィールドには post_click_goal_thresholdと同じ値が含まれている必要があります。

統計

最初の実行/最後の実行

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."
                        }
                    ],
                    "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,...}
        ]
    }
}

コンバージョン単価の目標に合わせて最適化された 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 に設定します。

$ 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 を使用するように明細項目を更新する

この例では、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 の支払い) を使用し、最適化を無効にするように明細項目を更新する

この例では、利益率が 20% で最適化が無効になっている Cost Plus Margin の収益の種類を使用するように、行項目を更新しています。 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 購入明細) でターゲットにしたいと考えている場合。

1. PG 取引プロファイルを作成し、このプロファイルの ID を書き留めます (「プロファイル サービスでプログラムによる保証取引の例をターゲットにする」を参照してください)。

2. 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
     }
   }
   

3. この 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}

関連項目

• API のベスト プラクティス
• API セマンティクス
• コンバージョン ピクセル サービス
• 挿入注文サービス