グローバル統計API
このセクションでは、Global Statistics API のリクエストパラメータと結果データについて説明します。
statistics API のルート名が変更されました:
/statistics/advertiser/...->/statistics/a/.../statistics/publisher/...->/statistics/p/...
Global Statistics API では、Date、Sites、Zones、Countries、Regions、Sub IDs のスキップされた RTB クエリのみが表示されます。
count
結果の合計のみを返します。
整数
任意
detailed
可能であれば、より詳細な情報を取得します。
整数
任意
timezone
'hour' フィルターと 'group_by' のタイムゾーン設定
文字列
任意
totals
応答に合計を追加するかどうかを示します。
整数
任意
filter
統計クエリの返却値を絞り込むためのフィルター
オブジェクト
任意
group_by
データに適用する group by 値の一覧。最大 4 件まで指定できます。
配列
必須
order_by
特定のフィールドによる結果の並び順。最大 2 件まで指定できます。
配列
任意
projection
応答で返却したい個々のサブ構造。
配列
任意
limit
このレスポンスで返却するレコード数。
整数
任意
offset
レコードを取得する開始位置。
整数
任意
パラメータ数
プロパティ
count
型
任意
変数の型
整数
デフォルト値
0
利用可能な値
[0, 1]
説明
結果の合計のみを返します。
例:
パラメータ detailed
プロパティ
detailed
型
任意
変数の型
整数
デフォルト値
0
利用可能な値
[0, 1]
説明
詳細情報を返すかどうか。
例:
パラメータ timezone
timezone のタイムゾーン設定 hour filter と group_by.
プロパティ
timezone
型
任意
変数の型
文字列
デフォルト値
America/New_york
利用可能な値
/collections/timezones の timezone フィールドを設定します
説明
注意: タイムゾーンは、時間単位のデータに基づいてクエリする場合にのみ関連し、時間単位以外のデータでは何もしません。
例:
パラメータ totals
プロパティ
totals
型
任意
変数の型
整数
デフォルト値
0
利用可能な値
[0,1]
説明
応答に合計を追加するかどうかを示します。
例:
パラメータ filter
プロパティ
filter
型
任意
変数の型
オブジェクト
広告主向けの利用可能なオプション
[”adblock”, ”advertiser_ad_type_id”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date_from”, “date_to”, “device_id”, “device_type_id”, hour”, “language_id”, “operating_system_id”, “region_id”, “site_hostname”, “site_id”, “size”, “sub”, “zone_id”, “campaign_group_id”, “campaign_id”, “exclude_deleted”, “offer_id”, “offer_landing_page_id”, “variation_id”]
パブリッシャー向けの利用可能なオプション
[”adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date_from”, “date_to”, “device_id”, “device_type_id”, “hour”, “language_id”, “operating_system_id”, “region_id”, “site_hostname”, “site_id”, “zone_id”, “publisher_ad_type_id”, “size”, “sub”]
説明
特定のパラメータでフィルターします。
フィルター: country_iso
プロパティ
country_iso
型
任意
変数の型
文字列
デフォルト値
-
利用可能な値
/collections/countries エンドポイントの iso3 プロパティを参照してください
説明
ISO 3 コード一覧
例:
フィルター date_from, date_to
その date_from および date_to これらのパラメータは、統計情報を取得する期間を制御します。
date_from: 統計の開始日範囲(デフォルトは月初),
date_to: 統計の終了日範囲(デフォルトは今日)
プロパティ
date_from, date_to
型
任意
変数の型
文字列
デフォルト値
日付はデフォルトで当月になります。
利用可能な値
YYYY-mm-dd
説明
統計の開始日/終了日範囲。形式は YYYY-mm-dd
例:
タイムゾーンは、時間単位のデータに基づいてクエリする場合にのみ関連し、時間単位以外のデータでは何もしません。
フィルター: advertiser_ad_type_id, campaign_group_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, publisher_ad_type_id
プロパティ
advertiser_ad_type_id, campaign_group_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, advertiser_ad_type_id, publisher_ad_type_id
型
任意
変数の型
配列
アイテムの型
整数
デフォルト値
-
利用可能な値
関連プロパティ または コレクション
説明
エンティティ ID の一覧
例:
フィルター: exclude_deleted
プロパティ
exclude_deleted
型
任意
変数の型
整数
デフォルト値
0
利用可能な値
[0, 1]
説明
削除済みキャンペーンを除外するかどうか。
例:
フィルター: adblock
プロパティ
adblock
型
任意
変数の型
文字列
デフォルト値
"all"
利用可能な値
"adblock", "all", "standard"
説明
adblock ゾーンを含めるかどうか。
例:
フィルター: site_hostname
プロパティ
site_hostname
型
任意
変数の型
文字列
デフォルト値
-
利用可能な値
ホスト名として有効な文字は、a から z までの英字、0 から 9 までの数字、ハイフン、ドットです。
説明
サイトのホスト名でフィルターします。
例:
フィルター: size
プロパティ
size
型
任意
変数の型
文字列
デフォルト値
-
利用可能な値
size に有効な文字は、0 から 9 までの数字と x 文字です。例: 300x100
説明
size でフィルターします
例:
パラメータ group_by
プロパティ
group_by
型
必須
変数の型
配列
アイテムの型
文字列
デフォルト値
-
広告主向けの利用可能な値
[”adblock”, “advertiser_ad_type_id”, browser_id”, “idcampaign_group“, “campaign_id”, “carrier_id”, “category_id”, “country_iso”, “date”, “hour”, “device_id”, “device_type_id”, “language_id”, “operating_system_id”, “region_id”, “site_id”, “sub”, “zone_id”, “week”, “month”, “quarter”, “year”, “offer_id”, “offer_landing_page_id”, “site_hostname”, “size”, “variation_id”]
パブリッシャー向けの利用可能な値
[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date”, “device_id”, “device_type_id”, “hour”, “language_id”, “operating_system_id”, “publisher_ad_type_id” “region_id”, “site_id”, “size”, “sub”, “zone_id”, “week”, “month”, “quarter”, “year”]
説明
追加データを応答に含めるためのサブリクエスト一覧。
例:
パラメータ order_by
型
任意
変数の型
配列
アイテムの型
文字列
デフォルト値
-
利用可能なメトリクス項目値
[“cpc”, “cpc”, “cpm”, “cpv”, “ctr”, “clicks”, “impressions”, “video_impressions”, “video_views”, “vtr”, “rtb_win_ratio”, “rtb_avg_total_time”, “rtb_skipped”, “rtb_bid_response_ratio”, “rtb_avg_cpm”, “rtb_timeouts_ratio”, “rt_errors_ratio”, “rtb_no_bid_ratio”, “rtb_skipped_ratio”]
広告主向けの `group_by` に依存する利用可能な項目値
[”adblock”, “browser_id”, “campaign_id”, “carrier_id”, “category_id”, “country_iso”, “device_id”, “date”, “device_type_id”, “hour”, “ecpa1”, “g1”,“language_id”, “month”, “offer_id”, “offer_landing_page_id”, “operating_system_id”, “quarter”, “region_id”, “site_hostname”, “site_id”, “sub”, “variation_id”, “week”, “year” ,“zone_id”]
パブリッシャー向けの `group_by` に依存する利用可能な項目値
[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “device_id”, “date”, “device_type_id” , “hour”, “language_id”, “month”, “operating_system_id”, “quarter”, “region_id”, “site_id”, “sub”, “week”, “year”, “zone_id”]
利用可能な order 値
[“asc”, “desc”]
説明
利用可能な order_by オプション一覧
ヒント:
メトリクス項目は、常に order_by フィールドとして使用できます。
特定の値(たとえば “browser_id”)で並べ替えるには、“group_by” パラメータに含める必要があります。
“g1”, “ecpa1” の値は、ユーザーがコンバージョントラッキング(Goals)を有効にしている場合にのみ利用できます。シリアル番号(g1, g2, …gx)に関連付けられたすべての goals。eCPA 値はそれぞれ ecpa1, ecpa2, …ecpax です。
例:
キャンペーン結果を時系列で並べるには、“date” を “group_by” と “order_by” の両方に含める必要があります:
パラメータ projection
projection パラメータは、結果ペイロードに何が返されるかを示します。指定しない場合は、すべてのサブ構造が返されます。
型
任意
変数の型
オブジェクト
アイテムの型
配列
デフォルト値
すべてのオプション、以下を参照
広告主向けの利用可能な項目値
[“base”, “rtb”, “video”, “goals*”]
パブリッシャー向けの利用可能な項目値
[“base”, “rtb”, “video”, “wpn”]
*「profit」や「roi」のような一部の "goal" フィールドは、キャンペーンのコストに基づいて計算されるため、正しい "goals" メトリクスを受け取りたい場合は "base" フィールドも使用する必要があります。
例:
広告主として可能なすべてのメトリクスを受け取るには、次を使用します:
パブリッシャーとして可能なすべてのメトリクスを受け取るには、次を使用します:
各 projection フィールド内でメトリクスを指定することもできます:
個別のメトリクス projection を許可しない唯一のフィールドは "goals" です
パラメータ limit
このレスポンスで返却するレコード数。
プロパティ
limit
型
任意
変数の型
整数
デフォルト値
50
例:
パラメータ offset
レコードを取得する開始位置。
プロパティ
offset
型
任意
変数の型
整数
デフォルト値
0
例
例 1
フィルタリング付きの広告主キャンペーン統計。
リクエスト:
レスポンス:
例 2
当月の、impressions で並べ替えた日付別広告主統計。
リクエスト:
レスポンス:
例 3
date と region_id によるパブリッシャー統計。インプレッション順。
リクエスト:
レスポンス:
例 4
site_id によるパブリッシャー統計。プロジェクション付き。
リクエスト:
レスポンス
最終更新
役に立ちましたか?

