明細レポート サービス
注:
このサービスは現在、限られた一連のクライアントと Microsoft の従業員のみが利用できます。
このフィールドまたは機能は、現在アルファフェーズまたはベータフェーズの機能の一部です。 そのため、変更される可能性があります。
Xandr 管理者は、このサービスを使用して、 standard_v2
行項目を作成できます。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
POST |
https://sor-api.adnxs.net/standard_v2 (standard_v2 JSON) |
新しい拡張ターゲット広告申込情報と関連付けられたプロファイルを追加します。 |
PUT |
https://sor-api.adnxs.net/standard_v2 (standard_v2 JSON) |
拡張ターゲット広告申込情報と関連付けられているプロファイルを変更します。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
line_item |
配列 | 「 行項目配列」を参照してください。 |
campaigns |
配列 | 「 キャンペーン配列」を参照してください。 |
行項目配列
行項目 サービスのような行項目配列関数。
フィールド | 種類 | 説明 |
---|---|---|
id |
int | 明細の ID。 クエリ文字列で必要な On: PUT 。 |
name |
string | 行項目の名前。 必須: POST |
line_item_type |
列挙 | 明細レポート サービスが正しく機能するには、[ standard_v2 ] を選択します。デフォルト: standard_v1 必須: POST |
revenue_type |
列挙 | 広告主があなたに支払うことに同意した方法。
line_item_type
=
standard_v2 に使用できる値を次に示します。- "cpm" : 1,000 インプレッションあたりのフラットな支払い。
revenue_value が必要です。- "vcpm" : 各インプレッションの期待値。収益の種類が "cpm" または "vcpm" の場合は、次のいずれかが必要です。- goal_type :- cpa : ゴール ピクセル配列を使用します。 - cpc : 評価配列を使用します。それぞれを含めることもできます。 - max_avg_cpm
評価配列の 。必須: POST |
revenue_value |
double | 広告主がネットワークに支払った金額。 必須: POST |
budget_intervals |
配列 | 「 予算間隔」を参照してください。 注: - enable_pacing を true に設定します。および - lifetime_budget または lifetime_budget_imp と lifetime_pacing を設定します。または - lifetime_budget または lifetime_budget_imps と daily_budget または daily_budget_imps を設定します。必須: POST |
creative |
配列 | 広告申込情報に関連付けられているクリエイティブ。 クリエイティブをまだ使用していない場合は、まず クリエイティブ サービス を通じてクリエイティブを追加する必要があります。 「Creative Array」を参照してください。 |
profile |
配列 | 「プロファイル サービス」を参照してください。 |
クリエイティブ配列
フィールド | 種類 | 説明 |
---|---|---|
id |
int | クリエイティブの ID。 クリエイティブの関連付けを更新する場合は、 id または code が必要です。 |
code |
string | クリエイティブのカスタム コード。 クリエイティブの関連付けを更新する場合は、 id または code が必要です。 |
評価配列
フィールド | 種類 | 説明 |
---|---|---|
goal_threshold |
decimal |
goal_type
"cpc" を含む広告申込情報の場合、パフォーマンス目標のしきい値。最適化されたキャンペーンの入札/入札の上限を決定します。デフォルト: null |
goal_target |
decimal |
goal_type
"cpc" を含む広告申込情報の場合、目的のクリック数またはクリックスルー率を表すパフォーマンス目標ターゲット。デフォルト: null |
performance_mkt_managed |
ブール値 |
デフォルト: [ false ] に設定します。 |
min_margin_pct |
decimal | 最小余白 PCT を revenue_type "cpm" 、 "cpa" 、または "cpc" する行項目の場合。デフォルト: null |
min_avg_cpm |
decimal | 明細収益は、この最小平均 eCPM を下回ることはできません。 デフォルト: null |
max_avg_cpm |
decimal | 明細収益は、この最大平均 eCPM を超えることはできません。 デフォルト: null |
Campaigns 配列
新しい広告申込情報を作成するときに、広告申込情報レポート サービスにフィードする必要がある既定のキャンペーンを次に示します。 常に次のフィールドと値を含むキャンペーンを作成する必要があります。広告申込情報レポート サービスは、実際のキャンペーンを作成して関連付けます。 広告申込情報レポート サービスは、1 つのキャンペーンのみを配置する場合でも、リスト内のキャンペーンを想定しています。
フィールド | 種類 | 値 |
---|---|---|
name |
string | 行項目の名前。 |
state |
列挙 | 行項目の状態。 |
inventory_type |
列挙 | "both" |
cpm_bid_type |
列挙 | "bpp" |
require_cookie_for_tracking |
列挙 | "false" |
例
新しい拡張取引項目を作成する
$ cat standard_v2.json
{
"standard_v2": {
"line_item": {
"line_item_type": "standard_v2",
"payout_margin": null,
"require_cookie_for_tracking": true,
"name": "Tst",
"code": null,
"state": "active",
"start_date": null,
"end_date": null,
"click_url": null,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"lifetime_pacing": null,
"enable_pacing": null,
"daily_budget": null,
"daily_budget_imps": null,
"budget_intervals": [
{
"start_date": "2016-01-08 00:00:00",
"end_date": "2016-01-09 00:00:00",
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"parent_interval_id": 7103,
"lifetime_pacing": false,
"enable_pacing": true,
"daily_budget": 1,
"daily_budget_imps": null
}
],
"insertion_orders": [
{
"id": 269592,
"name": "First Test",
"code": null,
"state": "active",
"advertiser_id": 764141,
"start_date": null,
"end_date": null,
"remaining_days": null,
"total_days": null,
"last_modified": "2016-01-08 21:57:18",
"timezone": "EST5EDT",
"currency": "JPY",
"comments": null,
"billing_code": null,
"line_items": [
{
"id": 2621282,
"name": "First LI",
"code": null,
"state": "active",
"start_date": null,
"end_date": null,
"timezone": "EST5EDT"
},
{
"id": 2621320,
"name": "TEst 2",
"code": null,
"state": "active",
"start_date": null,
"end_date": null,
"timezone": "EST5EDT"
},
{
"id": 2621351,
"name": "Test",
"code": null,
"state": "active",
"start_date": null,
"end_date": null,
"timezone": "EST5EDT"
}
],
"spend_protection_pixels": null,
"labels": null,
"broker_fees": null,
"budget_intervals": [
{
"id": 7103,
"object_id": 269592,
"object_type": "insertion_order",
"start_date": "2016-01-08 00:00:00",
"end_date": "2016-01-09 00:00:00",
"timezone": "EST5EDT",
"lifetime_budget": 1,
"lifetime_budget_imps": null,
"lifetime_pacing": false,
"enable_pacing": false,
"daily_budget_imps": null,
"daily_budget": null
}
],
"tpas_details": null,
"lifetime_pacing": null,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"enable_pacing": null,
"lifetime_pacing_span": null,
"allow_safety_pacing": null,
"daily_budget": null,
"daily_budget_imps": null,
"lifetime_pacing_pct": null
}
],
"currency": "JPY",
"broker_fees": [],
"manage_creative": true,
"creative_distribution_type": "even",
"creatives": [],
"labels": [],
"revenue_type": "vcpm",
"revenue_value": null,
"track_revenue": "track",
"pixels": [],
"valuation": {
"goal_target": 1,
"goal_threshold": 1,
"performance_mkt_managed": false,
"min_margin_pct": 1,
"min_avg_cpm": 1,
"max_avg_cpm": 1
},
"goal_type": "cpc",
"goal_value": null,
"goal_pixels": null,
"comments": null,
"profile": {
"require_cookie_for_freq_cap": true,
"max_day_imps": null,
"max_lifetime_imps": null,
"min_minutes_per_imp": null,
"max_page_imps": null,
"device_type_action": "exclude",
"device_type_targets": null,
"supply_type_action": "exclude",
"supply_type_targets": null,
"city_targets": null,
"city_action": "exclude",
"country_action": "exclude",
"country_targets": null,
"region_targets": null,
"region_action": "exclude",
"dma_targets": null,
"dma_action": "exclude",
"location_target_latitude": null,
"location_target_longitude": null,
"location_target_radius": null,
"zip_targets": null,
"postal_code_targets": null,
"content_category_targets": null,
"domain_action": "exclude",
"domain_targets": null,
"domain_list_action": "exclude",
"domain_list_targets": null,
"inventory_action": "exclude",
"placement_targets": null,
"publisher_targets": null,
"site_targets": null,
"mobile_app_instance_action_include": false,
"mobile_app_instance_targets": null,
"mobile_app_instance_list_action_include": false,
"mobile_app_instance_list_targets": null,
"member_targets": null,
"platform_content_category_targets": null,
"platform_placement_targets": null,
"platform_publisher_targets": null,
"segment_boolean_operator": "or",
"segment_group_targets": [],
"daypart_targets": null,
"daypart_timezone": null,
"querystring_action": "exclude",
"querystring_boolean_operator": "and",
"querystring_targets": null,
"position_targets": {
"allow_unknown": true,
"positions": null
},
"gender_targets": null,
"age_targets": null,
"certified_supply": false,
"allow_unaudited": false,
"trust": "appnexus",
"video_targets": {
"contexts": null,
"playback_methods": null,
"player_sizes": null,
"allow_unknown_playback_method": false,
"allow_unknown_context": false,
"allow_unknown_player_size": false
},
"inventory_attribute_targets": [
{
"id": "2"
},
{
"id": "4"
},
{
"id": "6"
},
{
"id": "8"
},
{
"id": "10"
},
{
"id": "14"
},
{
"id": "16"
},
{
"id": "18"
}
],
"intended_audience_targets": [
"general",
"children",
"young_adult"
],
"use_inventory_attribute_targets": true,
"use_operating_system_extended_targeting": true,
"operating_system_extended_targets": null,
"operating_system_family_action": "exclude",
"operating_system_family_targets": null,
"operating_system_action": "exclude",
"operating_system_targets": null,
"language_action": "exclude",
"language_targets": null,
"browser_action": "exclude",
"browser_targets": null,
"carrier_action": "exclude",
"carrier_targets": null,
"device_model_action": "exclude",
"device_model_targets": null
},
"id": 0
},
"campaigns": [
{
"name": "Tst",
"state": "active",
"inventory_type": "both",
"cpm_bid_type": "bpp",
"require_cookie_for_tracking": false
}
]
}
}
$ curl -b cookies -c cookies -X POST -d @standard_v2.json "http://sor-api.adnxs.net/standard_v2"