本文へスキップ

グローバル統計API

このセクションでは、Global Statistics API のリクエスト・パラメータと結果データについて説明します。

*注***：統計APIルートの名前が変更されました：

  • /統計/広告/... -> /統計/広告/...
  • /統計/出版社/... -> /統計/出版社/...

注：Global Statistics APIは、Date、Sites、Zones、Countries、Region、およびSub IDに対してスキップされたRTBクエリのみを表示します。

パラメータ説明備考タイプ
カウント結果の合計のみを返す。整数任意
詳細可能であれば、もっと詳しく教えてほしい。整数任意
タイムゾーン'hour'フィルターと'group_by'のタイムゾーン設定ストリング任意
合計応答に合計を追加するかどうかを示します。整数任意
フィルター統計クエリの返される値を制限するフィルターオブジェクト任意
group_byデータに適用されるgroup by値のリスト。最大4つまで許される。配列必須
オーダーバイ特定のフィールドによる結果の順序付け。最大2つまで可能。配列任意
投影ユーザーがレスポンスで返したい個々のサブストラクチャー。配列任意
制限このレスポンスで返すレコード数。整数任意
オフセットレコードを取得する位置。整数任意

パラメータ数​

プロパティカウント
タイプ任意
可変タイプ整数
デフォルト値0
利用可能な値[0, 1]
説明結果の合計のみを返す。

例​


    {
        "count": 1
    }

パラメータ詳細​

プロパティ詳細
タイプ任意
可変タイプ整数
デフォルト値0
利用可能な値[0, 1]
説明詳細情報を返すかどうか。

例​


    {
        "detailed": 1
    }

パラメータ timezone​

hourフィルタとgroup_by` のタイムゾーン設定。

プロパティタイムゾーン
タイプ任意
可変タイプストリング
デフォルト値アメリカ/ニューヨーク
利用可能な値コレクション/タイムゾーンのタイムゾーンフィールドを設定する
説明注：タイムゾーンが関係するのは、1時間ごとのデータに基づいてクエリを実行する場合のみで、1時間ごとのデータでない場合は、このクエリを実行する必要はありません。

例​


    {
        "timezone": "Europe/Dublin"
    }

パラメータ合計​

プロパティ合計
タイプ任意
可変タイプ整数
デフォルト値0
利用可能な値[0,1]
説明応答に合計を追加するかどうかを示します。

例​


    {
        "totals": 1
    }

パラメーター・フィルター​

プロパティフィルター
タイプ任意
可変タイプオブジェクト
広告主が利用可能なオプション["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_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コード一覧

例​


    {
        "filter": {
            "country_iso": ["ESP", "IRL"]
        }
    }

フィルタ date_from、date_to。​

date_fromとdate_to` パラメータは、統計情報を取得するウィンドウを制御する。

  • date_from: 統計の日付範囲（デフォルトは月初）、
  • date_to：統計の対象となる日付 (デフォルトは今日)
プロパティdate_from, date_to
タイプ任意
可変タイプストリング
デフォルト値日付のデフォルトは当月。
利用可能な値年-月-日
説明統計の開始日/終了日の範囲。フォーマット YYYY-mm-dd

例​


{
        "filter": {
            "date_from": "2019-02-25",
            "date_to": "2019-02-28"
        }
}

タイムゾーンが関係するのは、1時間ごとのデータに基づいてクエリーするときだけで、1時間ごとでないデータでは、これは無意味です。

フィルター：advertiser_ad_type_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_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
タイプ任意
可変タイプ配列
アイテムの種類整数
デフォルト値-
利用可能な値相対プロパティ OR コレクション
説明エンティティIDのリスト

例​


    {
        "filter": {
            "campaign_id": [123, 456],
            "browser_id": [789]
        }
    }

フィルター： exclude_deleted​

プロパティexclude_deleted
タイプ任意
可変タイプ整数
デフォルト値0
利用可能な値[0, 1]
説明削除されたキャンペーンを除外するかどうか。

例​


{
        "filter": {
            "exclude_deleted": 1
        }
}

フィルタ: adblock​

プロパティアドブロック
タイプ任意
可変タイプストリング
デフォルト値"すべて"
利用可能な値"adblock"、"all"、"standard"
説明アドブロックゾーンを含めるかどうか。

例​


    {
        "filter": {
            "adblock": "standard"
        }
    }

フィルタ: site_hostname​

プロパティサイトホスト名
タイプ任意
可変タイプストリング
デフォルト値-
利用可能な値ホスト名に有効な文字は、aからzまでのアルファベット、0から9までの数字、ハイフン、ドットです。
説明サイトのホスト名でフィルタリングする。

例​


        {
        "filter": {
            "site_hostname": ["www.example.com", "www.example-site.org"]
        }
    }

フィルタ: size​

プロパティサイズ
タイプ任意
可変タイプストリング
デフォルト値-
利用可能な値サイズに有効な文字は、0から9までの数字とx文字です。例 300x100
説明サイズで絞り込む

例​


           {
        "filter": {
            "size": ["300x100"]
        }
    }

パラメータ group_by​

プロパティgroup_by
タイプ必須
可変タイプ配列
アイテムの種類ストリング
デフォルト値-
広告主の利用可能な値[adblock"、"advertiser_ad_type_id"、"browser_id"、"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"］
説明回答に追加データを含めるためのサブリクエストのリスト。

例​


    {
      "group_by": [
        "browser",
        "date"
      ]
    }

パラメータ 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"、"月", "offer_id", "offer_landing_page_id", "operating_system_id", "quarter", "region_id", "site_hostname", "site_id", "sub", "variation_id", "week", "year" , "zone_id"].
Publisherの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」]]。
利用可能な注文値["asc"、"desc"］
説明利用可能な注文オプションのリスト

ヒント：

  • メトリクスのフィールドは、フィールドによる順序として常に使用可能です。
  • 特定の値で（例えば "browser_id "で）注文するには、"group_by "パラメータにその値を含める必要があります。

g1"、"ecpa1 "の値は、ユーザーがコンバージョントラッキング（目標）を持っている場合にのみ利用可能です。すべての目標はシリアル番号（g1、g2、...gx）に関連付けられます。eCPAの値はecpa1、ecpa2、...ecpaxとなります。

例​


    {
      "order_by": [
        {
          "field": "impressions",
          "order": "desc"
        }
      ]
    }

キャンペーン結果を時系列に整理する例では、"group_by "と "order_by "の両方に "日付 "を含める必要があります：


{
  "group_by": [
    "campaign_id",
    "date"
  ],
  "order_by":[
    {
      "field": "date",
      "order": "asc"
    }
  ]
}

パラメーター投影​

projection パラメータは、結果のペイロードに何が返されるかを反映する。指定しない場合は、すべてのサブ構造が返されます。

プロパティ投影
タイプ任意
可変タイプオブジェクト
アイテムの種類配列
デフォルト値すべてのオプション、下記参照
広告主が利用可能なフィールド値["ベース"、"rtb"、"ビデオ"、"ゴール*"]]。
パブリッシャーで利用可能なフィールド値["base"、"rtb"、"video"、"wpn"]]。

*ゴール "フィールドの中には "profit "や "roi "のようにキャンペーンのコストに基づいて計算されるものもあります。

例を挙げよう：​

広告主としての可能な限りの指標を受け取るには、こちらをご利用ください：


    {
        "projection": {
          "base": ["*"],
          "video": ["*"],
          "goals": ["*"],
          "rtb": ["*"]
        }
    }

パブリッシャーとして可能なすべての指標を受け取るには、以下を使用してください：


    {
        "projection": {
          "base": ["*"],
          "video": ["*"],
          "wpn": ["*"],
          "rtb": ["*"]
        }
    }

また、各プロジェクション・フィールド内のメトリクスを指定することもできます：


    {
        "projection": {
          "base": ["impressions","clicks","cost","revenue","cpc","cpm","ctr"],
          "video": ["impressions","views","cpv","vtr"],
          "rtb": ["total_time","queries","value","success","no_bid","skipped","errors","timeouts","wins","win_ratio"],
          //only for Publishers
          "wpn": ["subscriptions","unsubscriptions","sent"]
        }
    }

特定の指標を投影できない唯一のフィールドは "ゴール"

パラメータ制限​

このレスポンスで返すレコード数。

プロパティ制限
タイプ任意
可変タイプ整数
デフォルト値50

例​


{
      "limit": 25
}

パラメーター・オフセット​

レコードを取得する位置。

プロパティオフセット
タイプ任意
可変タイプ整数
デフォルト値0

例​


    {
      "offset": 150
    }

例1​

フィルタリングによる広告主キャンペーン統計。

リクエスト​


{
      "detailed": true,
      "totals": 1,
      "filter": {
        "date_from": "2019-03-10",
        "date_to": "2019-03-11",
        "country_iso": ["USA"]
      },
      "group_by": ["campaign_id"],
      "order_by": [
        {
          "field": "campaign_id",
          "order": "desc"
        }
      ]
      "projection": {
          "base": ["*"],
          "video": ["*"],
          "rtb": ["*"]
        },
      "limit": 2,
      "offset": 0
    }

反応だ：​


    {
      "request_metadata": {
        "count": 4,
        "limit": 2,
        "offset": 0
      },
      "result": [
        {
          "clicks": 0,
          "cost": 1.3302,
          "cpc": 0,
          "cpm": 0.45586017820425,
          "ctr": 0,
          "group_by": {
            "campaign_id": {
              "active": "1",
              "campaign_ad_type_name": "Popunders",
              "id": "1234567",
              "name": "Ron Mainstream Campaign "
            }
          },
          "impressions": 2918,
          "rtb": {
            "avg_cpm": 0.15582967823432,
            "avg_total_time": 89.522714492492,
            "errors": 112,
            "errors_ratio": 0.011368411650186,
            "no_bid": 870594,
            "no_bid_ratio": 88.368490823053,
            "queries": 985186,
            "response_ratio": 11.57101298638,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 984590,
            "timeouts": 484,
            "timeouts_ratio": 0.049127778916875,
            "total_time": 88196525,
            "value": 1776.396,
            "win_ratio": 0.29842080581738,
            "wins": 2940
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        },
        {
          "clicks": 0,
          "cost": 18.1621655,
          "cpc": 0,
          "cpm": 1.8273634671496,
          "ctr": 0,
          "group_by": {
            "campaign_id": {
              "active": "1",
              "campaign_ad_type_name": "Popunders",
              "id": "7654321",
              "name": "Ron Mainstream Campaign Test"
            }
          },
          "impressions": 9939,
          "rtb": {
            "avg_cpm": 1.4753505300475,
            "avg_total_time": 88.777190144965,
            "errors": 46,
            "errors_ratio": 0.0014192869995779,
            "no_bid": 3209674,
            "no_bid_ratio": 99.031490893114,
            "queries": 3241064,
            "response_ratio": 0.8964340105595,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 3238728,
            "timeouts": 2290,
            "timeouts_ratio": 0.070655809326814,
            "total_time": 287732555,
            "value": 4286.48343,
            "win_ratio": 0.30665855410445,
            "wins": 9939
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        }
      ],
      "result_total": {
        "clicks": 0,
        "cost": 74.0473595,
        "cpc": 0,
        "cpm": 2.0864288391096,
        "ctr": 0,
        "impressions": 35490,
        "rtb": {
          "avg_cpm": 0.23441613972984,
          "avg_total_time": 87.995789332859,
          "errors": 539,
          "errors_ratio": 0.0049868154705264,
          "no_bid": 9771471,
          "no_bid_ratio": 90.405422546568,
          "queries": 10808501,
          "response_ratio": 9.5135301370653,
          "skipped": 0,
          "skipped_ratio": 0,
          "success": 10799741,
          "timeouts": 8221,
          "timeouts_ratio": 0.07606050089647,
          "total_time": 951102577,
          "win_ratio": 0.32861171035651,
          "wins": 35518
        },
        "video": {
          "cpv": 0,
          "impressions": 0,
          "views": 0,
          "vtr": 0
        }
      }
    }

例2​

インプレッション順に並べた当月の日付別広告主統計。

リクエスト​

    {
      "group_by": ["date"],
      "order_by": [
        {
          "field": "impressions",
          "order": "desc"
        }
      ]
      "projection": {
          "base": ["*"],
          "video": ["*"],
          "rtb": ["*"]
        }
    }
反応だ：​

    {
      "request_metadata": {
        "count": 3,
        "limit": 50,
        "offset": 0
      },
      "result": [
        {
          "clicks": 0,
          "cost": 624.2439917,
          "cpc": 0,
          "cpm": 1.0978015474007,
          "ctr": 0,
          "group_by": {
            "date": {
              "date": "2019-03-02"
            }
          },
          "impressions": 568631,
          "rtb": {
            "avg_cpm": 0.31273156270632,
            "avg_total_time": 114.34705591799,
            "errors": 4143,
            "errors_ratio": 0.0076578188576312,
            "no_bid": 48085697,
            "no_bid_ratio": 88.8804144989,
            "queries": 54101567,
            "response_ratio": 10.971772776933,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 54021598,
            "timeouts": 75826,
            "timeouts_ratio": 0.14015490530986,
            "total_time": 6186354907,
            "value": 185634.35958,
            "win_ratio": 1.1633248996281,
            "wins": 629377
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        },
        {
          "clicks": 0,
          "cost": 622.1688691,
          "cpc": 0,
          "cpm": 1.1800128762878,
          "ctr": 0,
          "group_by": {
            "date": {
              "date": "2019-03-01"
            }
          },
          "impressions": 527256,
          "rtb": {
            "avg_cpm": 0.27775587567531,
            "avg_total_time": 118.91585420372,
            "errors": 2954,
            "errors_ratio": 0.0078196779097434,
            "no_bid": 32641750,
            "no_bid_ratio": 86.407573260111,
            "queries": 37776492,
            "response_ratio": 13.412992397494,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 37708708,
            "timeouts": 64830,
            "timeouts_ratio": 0.17161466448499,
            "total_time": 4492223815,
            "value": 140737.73563,
            "win_ratio": 1.4077723257099,
            "wins": 531807
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        },
        {
          "clicks": 0,
          "cost": 441.843491,
          "cpc": 0,
          "cpm": 0.96186339096399,
          "ctr": 0,
          "group_by": {
            "date": {
              "date": "2019-03-03"
            }
          },
          "impressions": 459362,
          "rtb": {
            "avg_cpm": 0.26462497173837,
            "avg_total_time": 116.9210100884,
            "errors": 2183,
            "errors_ratio": 0.0059889808787451,
            "no_bid": 32174177,
            "no_bid_ratio": 88.268681100486,
            "queries": 36450275,
            "response_ratio": 11.500815837466,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 36366256,
            "timeouts": 81836,
            "timeouts_ratio": 0.22451408116948,
            "total_time": 4261802971,
            "value": 110932.87869,
            "win_ratio": 1.2852029237091,
            "wins": 468460
          },
          "video": {
            "cpv": 0,
            "impressions": 0,
            "views": 0,
            "vtr": 0
          }
        }
      ]
    }

例3​

日付とregion_idをインプレッション順に並べたパブリッシャー統計。

リクエスト


{
      "detailed": true,
      "filter": {
        "date_from": "2019-03-10",
        "date_to": "2019-03-11",
        "country_iso": ["USA"]
      },
      "group_by": ["date", "region_id"],
      "order_by": [
        {
          "field": "impressions",
          "order": "desc"
        }
      ],
      "projection": {
        "base": ["*"],
        "video": ["*"],
        "wpn": ["*"],
        "rtb": ["*"]
      }
      "limit": 30,
      "offset": 0
    }

反応だ：


    {
      "request_metadata": {
        "count": 2,
        "limit": 30,
        "offset": 0
      },
      "result": [
        {
          "clicks": 3087,
          "cpc": 0.033842716164561,
          "cpm": 0.069188574849649,
          "ctr": 0.20444155402072,
          "group_by": {
            "date": {
              "date": "2019-03-11"
            },
            "region_id": {
              "country_iso": "USA",
              "country_long_name": "United States of America",
              "country_short_name": "United States",
              "id": 5332921,
              "name": "California"
            }
          },
          "impressions": 1494954,
          "revenue": 104.4724648,
          "rtb": {
            "avg_cpm": 0,
            "avg_total_time": 0,
            "bid_response_ratio": 0,
            "errors": 0,
            "errors_ratio": 0,
            "no_bid": 0,
            "no_bid_ratio": 0,
            "queries": 0,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 0,
            "timeouts": 0,
            "timeouts_ratio": 0,
            "total_time": 0,
            "value": 0,
            "win_ratio": 0,
            "wins": 0
          },
          "video": {
            "cpv": 0.038451404048583,
            "impressions": 15013,
            "views": 2717,
            "vtr": 18.097648704456
          },
          "wpn": {
            "subscriptions": 0,
            "unsubscriptions": 0
          }
        },
        {
          "clicks": 3071,
          "cpc": 0.03151133555845,
          "cpm": 0.066658890819906,
          "ctr": 0.21153940205505,
          "group_by": {
            "date": {
              "date": "2019-03-10"
            },
            "region_id": {
              "country_iso": "USA",
              "country_long_name": "United States of America",
              "country_short_name": "United States",
              "id": 5332921,
              "name": "California"
            }
          },
          "impressions": 1436818,
          "revenue": 96.7713115,
          "rtb": {
            "avg_cpm": 0,
            "avg_total_time": 0,
            "bid_response_ratio": 0,
            "errors": 0,
            "errors_ratio": 0,
            "no_bid": 0,
            "no_bid_ratio": 0,
            "queries": 0,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 0,
            "timeouts": 0,
            "timeouts_ratio": 0,
            "total_time": 0,
            "value": 0,
            "win_ratio": 0,
            "wins": 0
          },
          "video": {
            "cpv": 0.036216808196108,
            "impressions": 14921,
            "views": 2672,
            "vtr": 17.907646940554
          },
          "wpn": {
            "subscriptions": 0,
            "unsubscriptions": 0
          }
        }
      ]
    }

例4​

site_idによるパブリッシャー統計（投影付き）。

リクエスト​

{
      "detailed": true,
      "projection": {
        "base": ["*"],
        "video": ["*"],
        "wpn": ["*"],
        "rtb": ["*"]
      },
      "filter": {
        "date_from": "2019-03-10",
        "date_to": "2019-03-11",
        "country_iso": ["USA"]
      },
      "group_by": ["site_id"],
      "order_by": [
        {
          "field": "impressions",
          "order": "desc"
        }
      ],
      "limit": 30,
      "offset": 0
    }
応答​

{
      "request_metadata": {
        "count": 2,
        "limit": 30,
        "offset": 0
      },
      "result": [
        {
          "clicks": 14320,
          "cpc": 0.028298959692737,
          "cpm": 0.057945765404939,
          "ctr": 0.20476288186597,
          "group_by": {
            "site_id": {
              "id": "11223344",
              "name": "nice-example.com"
            }
          },
          "impressions": 6916414,
          "revenue": 405.2411028,
          "rtb": {
            "avg_cpm": 0,
            "avg_total_time": 0,
            "bid_response_ratio": 0,
            "errors": 0,
            "errors_ratio": 0,
            "no_bid": 0,
            "no_bid_ratio": 0,
            "queries": 0,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 0,
            "timeouts": 0,
            "timeouts_ratio": 0,
            "total_time": 0,
            "value": 0,
            "win_ratio": 0,
            "wins": 0
          },
          "video": {
            "cpv": 0.031519102652252,
            "impressions": 77041,
            "views": 12857,
            "vtr": 16.688516504199
          },
          "wpn": {
            "subscriptions": 0,
            "unsubscriptions": 0
          }
        },
        {
          "clicks": 14148,
          "cpc": 0.028769196296296,
          "cpm": 0.063791981699323,
          "ctr": 0.22173710048179,
          "impressions": 6314909,
          "revenue": 407.0265892,
          "rtb": {
            "avg_cpm": 0,
            "avg_total_time": 0,
            "bid_response_ratio": 0,
            "errors": 0,
            "errors_ratio": 0,
            "no_bid": 0,
            "no_bid_ratio": 0,
            "queries": 0,
            "skipped": 0,
            "skipped_ratio": 0,
            "success": 0,
            "timeouts": 0,
            "timeouts_ratio": 0,
            "total_time": 0,
            "value": 0,
            "win_ratio": 0,
            "wins": 0
          },
          "video": {
            "cpv": 0.036406671663685,
            "impressions": 65620,
            "views": 11180,
            "vtr": 17.037488570558
          },
          "wpn": {
            "subscriptions": 0,
            "unsubscriptions": 0
          }
        }
      ]
    }