デジタル プラットフォーム API - データ使用状況レポート

このレポートでは、サード パーティ (ユーザー セグメント プロバイダーなど) から提供されるデータの使用状況、そのデータ使用にかかるコスト、そのデータがユーザーをターゲットに使用した広告申込情報やキャンペーンに関する詳細が示されます。

このレポートのデータは 60 日間保持されます。 データの time_granularity は hourlyです。 レポートを取得する手順については、 レポート サービス または次の 例 を参照してください。

時間枠

JSON 要求の report_interval フィールドは、次のいずれかに設定する必要があります。

  • 今日
  • yesterday
  • last_7_days
  • last_30_days
  • month_to_date
  • quarter_to_date
  • last_month
  • 有効期間

カスタムの時間枠でレポートを実行するには、レポート要求の start_date フィールドと end_date フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。

Dimensions

列 種類 フィルター? 例 説明
geo_country_code string はい "CA" インプレッションに関連付けられている国/地域を示す 2 文字の文字列。
campaign string いいえ "Prospect Campaign (31)" 非推奨です (2016 年 10 月 17 日現在)。
data_provider string いいえ "Peer 39 (Data Provider) (517)" 非推奨です (2016 年 10 月 17 日現在)。
geo_country string はい "US" インプレッションに関連付けられている地理的な国/地域のコード。
targeted_segment_ids string いいえ "935035, 935146" ターゲティング時に使用される各セグメントの ID のコンマ区切りリスト。
day date はい "2010-02-01" インプレッションに関連付けられたオークションが発生した日
hour date はい "2010-02-01 05:00:00" インプレッションに関連付けられているオークションが発生した時刻。
campaign_id int はい 31 サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられているキャンペーンの ID。
buyer_member_id int はい 643 サードパーティのデータを使用したメンバーの ID。
split_id int はい 342 このデータ セットのインプレッションを購入した分割の ID。 分割は、拡張広告申込情報にのみ適用されます。 キャンペーンを含むレポートでは、 split_id (含まれている場合) が nullされます。
data_provider_id int はい 517 ターゲティング データを提供したサード パーティの ID。
month date はい "2010-02" インプレッションに関連付けられたオークションが発生した月
data_provider_name string いいえ "Peer 39 (Data Provider)" ターゲティング データを提供したサード パーティの名前と ID。
campaign_name string いいえ "Prospect Campaign" サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられているキャンペーンの名前。
geo_country_name string いいえ "United States" インプレッションに関連付けられている地理的な国/地域の名前。
line_item_name string いいえ "Fall Apparel" サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられた広告申込情報の名前。
split_name string はい "Mobile Split A" このデータ セットのインプレッションを購入した分割の名前。 分割は、拡張広告申込情報にのみ適用されます。 キャンペーンを含むレポートでは、 split_name (含まれている場合) が nullされます。

指標

列 型 例 式 説明
imps int 34534 imps サードパーティのデータを使用して広告を配信したインプレッションの合計数。
data_costs 金銭 3.50 サード パーティのデータ プロバイダーから購入したデータ セグメントの金額。
transaction_tax 金銭 .43 適用される売上税、付加価値税、商品サービス税、または同様の取引税 (取引税) は、オンボード エクスペリエンスで提供されたお客様のアカウントの事業拠点に基づいて、Microsoft との取引に適用されます。
data_type string Segment 利用可能な選択肢は、[セグメント] と [クロスデバイス] です
現地通貨で利用可能なメトリック
data_costs_buying_currency 金銭 3.50 サード パーティのデータ プロバイダーから購入したデータ セグメントの金額。 広告主の通貨で表されます

例

JSON レポート要求の作成

JSON ファイルには、取得する列 (ディメンションとメトリック) とreport_intervalだけでなく、"buyer_data_usage_analytics"のreport_typeを含める必要があります。 また、特定のディメンションでフィルター処理したり、粒度 (month、 day、 hour) を定義したり、データを返す "format" ("csv"、 "excel"、 "html") を指定したりすることもできます。 JSON ファイルに含めることができるフィールドの詳細については、「 レポート サービス」を参照してください。

$ cat buyer_data_usage_analytics

{"report":
    {
        "format": "csv",
        "report_interval": "yesterday",
        "row_per": ["geo_country"],
        "columns": ["imps","campaign_id","geo_country"],
        "report_type": "buyer_data_usage_analytics"
    }
}

POST レポート サービスへの要求

POST レポート ID を取得するための JSON 要求。

$ curl -b cookies -c cookies -X post -d @seller_brand_review "https://api.appnexus.com/report"

{
   "response":{
      "status":"OK",
      "report_id":"c445bca183a3d338dc1c5b85a3d484f5"
   }
}

GET レポート サービスからのレポートの状態

レポート ID を使用して GET 呼び出しを行い、レポートの状態を取得します。 execution_statusが"ready"されるまで、このGET呼び出しを続けます。 次に、次の手順で説明するように、 レポート ダウンロード サービスを使用して、レポート データをファイルに保存します。

$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=c445bca183a3d338dc1c5b85a3d484f5'

{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2014-11-19 22:33:31",
            "json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"yesterday\",\"row_per\":[\"geo_country\"],\"columns\":[\"imps\",\"campaign_id\",\"geo_country\"],\"report_type\":\"buyer_data_usage_analytics\",\"filters\":[{\"buyer_member_id\":\"958\"}]}}",
            "url": "report-download?id=c445bca183a3d338dc1c5b85a3d484f5"
        },
        "execution_status": "ready"
    }
}

GET レポート ダウンロード サービスからのレポート データ

レポート データをファイルにダウンロードするには、レポート ID を使用して別の GET 呼び出しを行います。今回は レポート ダウンロード サービスに対して呼び出します。 サービス ID とレポート ID は、前回のGET呼び出しへの応答の url フィールドにあります。 保存するファイルを特定する際は、初期 POSTで指定したファイル形式の拡張子を使用してください。

注:

ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTP エラー コードとメッセージが含まれます。 呼び出しで -i または -v を使用して、応答ヘッダーを公開します。

$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=c445bca183a3d338dc1c5b85a3d484f5' > /tmp/buyer_data_usage_analytics.csv

注:

XLSX および Excel ファイルとしてダウンロードする場合、レポートごとに 100,000 行の制限があります。

  • Last updated on