Bidders - レポート サービス
[アーティクル] 2024/02/23
2 人の共同作成者
フィードバック
この記事の内容
レポートの種類
メタデータを表示するための REST API
メタデータの例
データ取得のための REST API
JSON フィールド
レポートを取得する方法
定期的なレポートをスケジュールする
関連項目
さらに 4 個を表示
Report Service は、関心のあるレポート データを購入者と販売者の両方に提供します。 これは、次のような質問に回答するために使用されます。
どのくらいのお金が費やされましたか?
何個の印象が見られましたか?
販売されたインプレッション数はいくつですか?
収益はどのくらいですか?
これは 読み取り専用サービスです 。 JSON 形式のレポート要求は POST
行われますが、Imp Bus キャッシュ内のデータは変更されません。 レポートを実行するには、ユーザーの "bidder"
種類として認証する必要があります。 各レポートの種類には、独自のメトリック、フィルター処理、およびグループ化オプションが用意されています。
ヒント
90 日を超えるデータが必要ですか?
および platform_seller
レポートの種類はplatform_buyer
、過去 90 日間のデータを格納するテーブルから取得されます。 古いデータの場合は、 と レポートの種類をbidder_pricing_report
seller_invoice_report
使用してください。
Report Service はレポートを非同期的に実行します。つまり、複数のプロセスを並列で実行できます。 レポート要求を行うと、レポート、エラー メッセージ、または保留中のメッセージが表示されます。 詳細については、以下の 「レポートを取得する方法 」を参照してください。
Bidder でこのレポート データを表示するためのグラフィカル ユーザー インターフェイス (UI) もあります。 この UI にアクセスできない場合は、Xandr の担当者にお問い合わせください。
注意
Bidder UI では、API を介して使用できる機能がすべて公開されているわけではありません。 分析レポートのみが公開 platform_buyer
されます。 別のレポートが必要な場合は、API を使用する必要があります。
主なレポートの種類は次のとおりです。
レポート サービスには、メタデータと実際のデータという 2 つのレイヤーのデータがあります。 メタデータは、使用可能なレポート パラメーターの一覧です。
カスタム レポートを実行するには、JSON 形式の要求が必要です。 フィルター、グループ、または列でデータを要求できます。 フィルターによって結果が除外されます。 などの day
フィルターを持つ要求は、集計されたデータに基づいてフィルター処理されます。 などの個々のパラメーター imps_sold
で検索することもできます。
テーブルを展開する
HTTP メソッド
エンドポイント
説明
取得
https://api.adnxs.com/report?meta=buyer_platform_billing
型のメタデータを bidder_pricing_report
返します。
取得
https://api.adnxs.com/report/meta/platform_buyer
型のメタデータを platform_buyer
返します。
GET
https://api.adnxs.com/report/meta/platform_seller
型のメタデータを platform_seller
返します。
GET
https://api.adnxs.com/report/meta/seller_platform_billing
型のメタデータを seller_invoice_report
返します。
注意
より標準的なクエリ形式を使用して、メタデータを返すこともできます。
report?meta=report_type
例:
GET https://api.adnxs.com/report?meta=platform_buyer
メタデータの形式は次のとおりです。
{"column":"day","type":"time"}
{"column":"month","type":"time"}
{"column":"geo_country","type":"string"}
$ curl "https://api.adnxs.com/report/meta/platform_buyer"
"response": {
"status": "OK",
"meta": {
"columns": [
{
"column": "month",
"type": "time"
},
{
"column": "day",
"type": "date"
},
{
"column": "hour",
"type": "date"
},
...
],
"filters": [
{
"column": "hour",
"type": "date"
},
{
"column": "day",
"type": "date"
},
{
"column": "year",
"type": "date"
},
...
],
"havings": [
{
"column": "clicks"
},
{
"column": "buyer_spend"
},
{
"column": "imps_bought"
},
{
"column": "buyer_ecpm"
},
{
"column": "click_rate_sold"
}
],
"time_intervals": [
"current_hour",
"last_hour",
"last_48_hours",
"today",
"yesterday",
"last_7_days",
"month_to_date",
"quarter_to_date",
"last_month",
"lifetime",
"mtd"
]
}
}
テーブルを展開する
HTTP メソッド
エンドポイント
説明
取得
https://api.adnxs.com/report/REPORT_ID
レポートの状態を要求します。
取得
https://api.adnxs.com/report-download/REPORT_ID
レポート データを取得します。
POST
https://api.adnxs.com/report?member_id=MEMBER_ID
(レポート JSON)
レポートを要求します。
テーブルを展開する
フィールド
必須
型
説明
columns
はい (少なくとも 1 つ)
配列
レポートに含める列の一覧。 使用できる列については、個々のレポートのドキュメントを参照してください。 簡単な例については、以下の 「レポートを取得する方法 」を参照してください。
end_date
いいえ
string
レポートの終了日。 - 時間単位のデータを提供するレポートの種類の場合、これは として "YYYY-MM-DD HH:MM:SS"
書式設定する必要があります。 ただし、 MM:SS
データは 00:00
分と秒で使用できないので、 である必要があります。 - 時間単位のデータを提供しないレポートの種類の場合、これは として "YYYY-MM-DD"
書式設定する必要があります。 注 : は end_date
非包括です。 たとえば、 で2012-07-01"
月次レポートを開始し、 でレポート "2012-07-31"
を終了すると、レポートには月の最終日のデータは含まれません。 このデータを取得する正しい方法は、 のレポートを終了することです "2012-08-01"
。
escape_fields
いいえ
ブール値
の場合 true
、レポート出力の各フィールドの周囲に引用符が追加され、Excel へのより安全なインポートが可能になります。 これは、CSV およびタブ区切りのレポートにのみ適用されます。
filters
いいえ
配列
レポートに適用するフィルターの一覧。 個々のレポートのドキュメントを参照して、フィルター処理できるフィールドを確認してください。 簡単な例については、以下の 「レポートを取得する方法 」を参照してください。 注 : is_delivered
フィルター値は、インプレッションが正常に配信された場合のみです true
。 それ以外の場合は です false
。
report_interval
いいえ
列挙
レポートの時間範囲。 すべてのレポートですべての間隔を受け入れるわけではありません。詳細については、各レポートのドキュメントとメタデータを参照してください。 使用可能な値: - current_hour
- last_hour
- today
- yesterday
- last_48_hours
- last_7_days
- lifetime
- month_to_date
- mtd
- last_month
report_type
はい
列挙
次のいずれかである必要があります。 - "platform_buyer
" - "platform_seller
" - "bidder_pricing_report
" - "seller_invoice_report
" - "completed_creative_audits
" - "bidder_bid_error_report
" これにより、返される情報が決まります。
row_per
いいえ
配列
レポートに含めるグループの一覧。 グループ化に使用できる列については、個々のレポートのドキュメントを参照してください。 簡単な例については、以下の 「レポートを取得する方法 」を参照してください。
start_date
いいえ
string
レポートの終了日。 - 時間単位のデータを提供するレポートの種類の場合、これは として "YYYY-MM-DD HH:MM:SS"
書式設定する必要があります。 ただし、 MM:SS
データは 00:00
分と秒で使用できないので、 である必要があります。 - 時間単位のデータを提供しないレポートの種類の場合、これは として "YYYY-MM-DD"
書式設定する必要があります。
timezone
いいえ
string
データが報告されるタイムゾーン。 使用可能なタイムゾーン値の一覧については、「 レポートのタイムゾーン 」を参照してください。
JSON ファイルには、実行する特定report_type
のファイルと、columns
取得する (ディメンションとメトリック) と report_interval
("today"
、、"yesterday"
"month_to_date"
など) が含まれている必要があります。 ディメンションにを含 filters
め、粒度 (年、月、日) を定義し、データを format
返す必要がある を指定することもできます。 オプションは format
次のとおりです。
"csv"
- コンマ区切りファイル
"xls"
- タブ区切りの M.S. Excel ファイル
"xlsx"
- ネイティブ M.S. Excel 形式
注意
複数の値でディメンションをフィルター処理するには、配列を使用します。 例:
正しい:
"filters": [{"bid_type": ["learn","optimized"]}, {"geo_country":"US"}]
正しくない:
"filters": [{"bid_type":"learn"}, {"bid_type":"optimized"}, {"geo_country":"US"}]
要求 に 含めることができるフィールドの詳細については、上記の JSON フィールドを参照してください。 使用可能なディメンションとメトリックの完全な一覧については、「 メタデータを表示するための REST API 」で説明されているように、実行する特定のレポートの種類に関するドキュメントを参照するか、そのレポートのメタデータをプルします。
$ cat report_request
{
"report": {
"report_type": "platform_buyer",
"report_interval": "last_48_hours",
"columns": ["day","imps_bought"],
"filters": [{"geo_country":"US"}],
"orders": [{"order_by":"day", "direction":"ASC"}],
"format": "csv"
}
}
POST
JSON 要求を実行し、レポート ID を取得します。
$ curl -b cookies -c cookies -X POST -d @report_request 'https://api.adnxs.com/report?member_id=255'
{
"response": {
"status": "OK",
"report_id": "ca9955709eade9a0e89f5cda5345c12r",
"dbg_info": {
...
}
}
}
手順 3. GET
レポート サービスからのレポートの状態
レポート ID を GET
使用して呼び出しを行って、レポートの状態を取得します。 が "ready"
になるまでこの呼び出しを"execution_status"
続けます。 次に、サービスを report-download
使用して、レポート データをファイルに保存します。 (これについては、次の手順で説明します)。
$ curl -b cookies -c cookies 'https://api.adnxs.com/report/ca9955709eade9a0e89f5cda5345c12r'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2012-03-13 18:15:48",
"cache_hit": false,
"fact_cache_hit": false,
"json_request": "{\"report\":{\"report_type\":\"network_analytics\",\"report_interval\":
\"last_48_hours\",\"columns\":[\"day\",\"imps\",\"clicks\"],\"filters\":[{\"geo_country\":
\"US\"},{\"entity_member_id\":\"514\"},{\"entity_member_id\":null}],\"orders\":
[{\"order_by\":\"day\",\"direction\":\"ASC\"},{\"order_by\":\"imps\",\"direction\":
\"DESC\"}]}}",
"header_info": "Report type:,network_analytics\r\n,\r\nRun at:,2012-03-13 18:15:48\r\nStart date:,
\r\nEnd date:,\r\nTimezone:,\r\nUser:,John Smith (9385)\r\n",
"report_size": "10",
"row_count": "35",
"url": "report-download?id=ca9955709eade9a0e89f5cda5345c12r"
},
"execution_status": "ready",
"dbg_info": {
...
}
}
}
手順 4. GET
レポート ダウンロード サービスからのレポート データ
レポート データをファイルにダウンロードするには、レポート ID を使用して別 GET
の呼び出しを行いますが、今回はサービスに report-download
対して呼び出します。 サービスとレポート ID は、前 GET
の応答の URL フィールドにあります。 保存するファイルを識別する場合は、最初POST
の で指定した の"format"
ファイル拡張子を使用してください。
ヒント
ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTPS エラー コードとメッセージが含まれます。 要求で または -v
を使用-i
して、応答ヘッダーを公開します。
$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=<download_id>
その後、ファイルを開くことができます。
気になるレポートの保存済みバージョンを作成し、指定した間隔でシステムからデータを電子メールで送信することで、レポート プロセスを自動化できます。 これらの自動レポートを設定する方法の詳細については、 保存されたレポート サービス に関するページを参照してください。