Digital Platform API - 保存されたレポート サービス
保存されたレポート サービスを使用して、保存され、いつでも取得できる新しいレポートを作成できます。 これらは、頻繁に実行されるレポートに役立ちます。 保存されたレポート サービスは、 レポート サービスのラッパーとして機能します。
注:
レポートごとに 100,000 行の制限があります。
保存されたレポートに関して留意すべきいくつかの事実:
- 保存されたレポートの有効期限は 6 か月後です。 6 か月後に新しい保存済みレポートを作成する必要があります。
- 保存されたレポートに 有効期間 または カスタム の日付範囲を指定することはできません。
- 保存されたレポートは、最初に作成された順序で実行されます。 たとえば、2 つの日次レポートを作成すると、最初に作成された日次レポートが毎日最初に実行されます。
- 日次レポートは毎日実行され、1 日を通してさまざまな時間に送信されます。
- 毎週のレポートは、前の 7 日間、毎週の月曜日に実行され、送信されます。
- 月次レポートは、毎月の最初の日に実行され、送信されます。
REST API
注:
ネットワーク内の他のユーザー (メンバー) によって保存されたレポートは、これらの呼び出しでは返されません。 ユーザー アカウントによって保存されたレポートのみが返されます。
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/saved-report?advertiser_id=ADVERTISER_ID | 広告主のすべての保存済みレポートを表示するには。 |
GET |
https://api.appnexus.com/saved-report?publisher_id=PUBLISHER_ID | パブリッシャーのすべての保存済みレポートを表示するには。 |
GET |
https://api.appnexus.com/saved-report?id=SAVED_REPORT_ID | 特定の保存済みレポートを表示するには。 |
POST |
https://api.appnexus.com/saved-report?advertiser_id=ADVERTISER_ID | 広告主の新しい保存済みレポートを追加するには。 |
POST |
https://api.appnexus.com/saved-report?publisher_id=PUBLISHER_ID | パブリッシャーの新しい保存済みレポートを追加するには。 |
PUT |
https://api.appnexus.com/saved-report?advertiser_id=ADVERTISER_ID | 広告主の既存の保存済みレポートを変更するには。 |
PUT |
https://api.appnexus.com/saved-report?publisher_id=PUBLISHER_ID | 発行元の既存の保存済みレポートを変更するには。 |
DELETE |
https://api.appnexus.com/saved-report?id=SAVED_REPORT_ID | 既存の保存済みレポートを削除するには。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
category |
string | レポートのカテゴリ。 |
created_on |
string | 保存されたレポートが作成された日付と時刻。 |
emails |
配列 | レポートを送信するメールの一覧。 配列は形式にする必要があります ["email_address1@domain.com", "email_address2@domain.com", ...] |
entity_id |
int | レポートを作成するユーザーのエンティティ ID。 これにより、レポートのスコープが設定されます。 |
expires_on |
string | 保存されたレポートの有効期限が切れる日付と時刻。 これは現在、1 年後に制限されています。 日付/時刻は、時刻が 24 時間形式で指定 "YYYY-MM-DD HH:MM:SS" 形式で指定する必要があります。必須のオン: POST と PUT 。 |
format |
列挙 | レポートの結果を保存する形式。 使用可能な値: "excel" または "csv" 。 |
id |
int | 保存されたレポートに関連付けられている内部 ID。 必須: PUT |
last_modified |
string | 保存されたレポートが最後に変更された日付と時刻。 |
name |
string | UI に表示されるレポートの名前。 最大長は 100 文字です。 |
report |
object | Reporting Service で使用されるのと同じ形式で定義されたレポート。 |
scheduling |
列挙 | レポートが実行される頻度。 使用可能な値: "daily" 、 "weekly" 、または "monthly" 。 |
例
パブリッシャーの新しい保存済みレポートを追加する
- レポート JSON を作成します ( 「Report Service - 手順 1」の説明に従います)。
-
POST
保存されたレポート サービスへの JSON。 - 返される ID を格納します。
$ cat saved-report
{
"saved-report":{
"name":"Publisher Report Last 48 Hours",
"report":{
"report_type":"publisher_analytics",
"columns":[
"publisher_revenue",
"imps_total",
"imps_sold",
"imps_default",
"clicks",
"ctr",
"month",
"day",
"hour",
"geo_country",
"size",
"placement",
"total_convs",
"convs_rate",
"publisher_rpm"
],
"row_per":[
"month",
"day",
"hour",
"geo_country",
"size",
"placement_id"
],
"timezone":"EST",
"report_interval":"last_48_hours"
},
"scheduling":"daily",
"format":"excel",
"emails":[
"reporting@publisher.com",
"noreply@publisher.com"
],
"expires_on":"2010-10-31 0:00:00"
}
}
$ curl -b cookies -c cookies -X post --data-binary @saved-report 'https://api.appnexus.com/saved-report?publisher_id=35'
{
"response":{
"status":"OK",
"id":39
}
}
保存したレポートを実行して取得する
注:
更新されたレポートを取得するたびに、この手順を実行する必要があります。
-
POST
を上の ID でレポート サービスに保存し、返されたreport_id
を格納します。 - レポート サービスへの
GET
でレポートの状態をreport_id
で確認します ( 「レポート サービス - 手順 3」で説明されています)。 -
GET
report-download
サービスからのレポート (レポート サービス - 手順 4 で説明されているように)。
$ curl -b cookies -c cookies -X post "https://api.appnexus.com/report?saved_report_id=39&publisher_id=35"
{
"response":{
"status":"OK",
"report_id":"fa16873114e1d5697091069e45bccec0"
}
}
$ curl -b cookies -c cookies "https://api.appnexus.com/report?id=fa16873114e1d5697091069e45bccec0"
{
"response":{
"status":"OK",
"report":{
"name":null,
"created_on":"2010-06-10 15:53:07",
"json_request":"{\"report\":{\"report_type\":\"publisher_analytics\",\"columns\":[\"publisher_revenue\",\"imps_total\",
\"imps_sold\",\"imps_default\",\"clicks\",\"ctr\",\"month\",\"day\",\"hour\",\"geo_country\",\"size\",\"placement\",
\"total_convs\",\"convs_rate\",\"publisher_rpm\"],\"row_per\":[\"month\",\"day\",\"hour\",\"geo_country\",\"size\",
\"placement_id\"],\"timezone\":\"EST\",\"report_interval\":\"last_48_hours\",\"filters\":[{\"publisher_id\":\"4642\"},
{\"publisher_id\":\"4642\"}]}}",
"data":"publisher_revenue,imps_total,imps_sold,imps_default,clicks,ctr,month,day,hour,geo_country,size,placement,total_convs,convs_rate,publisher_rpm\r\n"
},
"execution_status":"ready"
}
}
$ curl -i -b cookies -c cookies 'https://api.appnexus.com/report-download?id=fa16873114e1d5697091069e45bccec0' > /tmp/publisher_analytics.csv