Digital Platform 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
Column | 種類 | フィルター。 | 例 | 説明 |
---|---|---|---|---|
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 。 |
指標
Column | 型 | 例 | 式 | 説明 |
---|---|---|---|---|
imps |
int | 34534 |
Imps | サード パーティのデータを使用して広告を配信したインプレッションの合計数。 |
data_costs |
お 金 | 3.50 |
サード パーティのデータ プロバイダーから購入されたデータ セグメントの金額。 | |
sales_tax |
お 金 | .43 |
徴収される売上税の金額。 このフィールドは、購入者の請求先住所が米国のいずれかの州 (NY、TX、または NJ) にある場合にのみ設定されます。 この税金を徴収するには、(関連する地方州規制当局によって) Xandr が必要です。 | |
data_type |
string | Segment |
利用可能な選択肢は、セグメントとクロスデバイスです | |
現地通貨で使用できるメトリック | ||||
data_costs_buying_currency |
お 金 | 3.50 |
サード パーティのデータ プロバイダーから購入されたデータ セグメントの金額。 広告主の通貨で表されます |
例
JSON レポート要求を作成する
JSON ファイルには、 report_type
と "buyer_data_usage_analytics"
、取得する列 (ディメンションとメトリック) とreport_intervalが含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (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
Report Service への要求
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
使用して呼び出しを行って、レポートの状態を取得します。 が "ready"
になるまでこのGET
呼び出しをexecution_status
続けます。 次の手順で説明するように、 レポート ダウンロード サービスを使用してレポート データをファイルに保存します。
$ 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 は、前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 行の制限があります。