Digital Platform API - 販売請求レポート
警告
このレポートは、2015 年 9 月 30 日以降のデータにのみ使用してください。
販売請求レポートを使用すると、直接パブリッシャー全体 (直接広告主やその他のプラットフォーム購入者間で販売) の請求データを表示できます。
レポートを取得する手順については、 レポート サービスを参照してください。
時間枠
JSON 要求のフィールドは report_interval
、次のいずれかに設定できます。
- last_hour
- 今日
- yesterday
- last_48_hours
- last_7_days
- last_30_days
- month_to_date
- quarter_to_date
- last_month
- 有効 期間
- カスタム
ヒント
カスタム時間枠のレポートを実行するには、レポート要求の フィールド start_date
と end_date
フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。
データ保持期間
このレポートのデータ保持期間は 1095 日です。
Dimensions
Column | 種類 | フィルター。 | 例 | 説明 |
---|---|---|---|---|
hour |
time | 不要 | "2010-02-01 06:00:00" |
印象の時間。 注: 100 日を超えるインプレッションの場合、1 時間あたりのデータは 1 行に集計され、"YYYY-MM-DD 00:00:00" は時間 ('YYYY-MM-DD' はアクティビティが発生した UTC 日) になります。 これにより、すべてのアクティビティが真夜中に発生したかのように見えるようになります。 100 日を超える日単位のデータはすべて UTC タイム ゾーンで返されます。 |
day |
time | 不要 | "2010-02-01" |
印象の日。 |
month |
time | 不要 | "2010-02" |
印象の月。 |
buyer_member_id |
int | はい | 123 |
購入者メンバーの内部 ID |
buyer_member_name |
文字列 | いいえ | "My Network" |
購入者メンバーの表示名。 |
seller_member_id |
int | はい | 456 |
販売者メンバーの内部 ID。 |
seller_member_name |
文字列 | いいえ | "That Seller" |
販売者メンバーの表示名。 |
advertiser_id |
int | はい | 789 |
広告主の内部 ID。 |
advertiser_name |
文字列 | いいえ | "Verizon" |
広告主の表示名。 |
publisher_id |
int | はい | 321 |
パブリッシャーの内部 ID。 |
publisher_name |
文字列 | いいえ | "Test" |
発行元の表示名。 |
publisher_code |
int | はい | 123 |
発行元の外部 ID。 |
selling_currency |
string | はい | Yes |
販売者がこのインプレッションを販売するために使用する取引通貨。 |
buying_currency |
string | はい | "USD" |
購入者がこのインプレッションを購入するために使用する取引通貨。 |
deal_id |
int | はい | 123 |
取引の内部 ID |
imp_type_id |
int | はい | 1 |
インプレッションの種類の ID。 使用可能な値 (かっこ内の関連付けられた ID): - "Blank" ( 1 ): クリエイティブは提供されません。- "PSA" ( 2 ): 有効な入札がなく、既定のクリエイティブが利用できなかったため、パブリック サービスのお知らせが配信されました。- "既定のエラー" ( 3 ): タイムアウトの問題が原因で配信された既定のクリエイティブ。- "Default" ( 4 ): 有効な入札がなかったため、既定のクリエイティブが配信されました。- "保持" ( 5 ): 広告主のクリエイティブがパブリッシャーのサイトで配信されました。- "Resold" ( 6 ): 発行元の印象がサード パーティの購入者に販売されました。- "RTB" ( 7 ): 発行元の印象がサード パーティの購入者に販売されました。- "PSA エラー" ( 8 ): タイムアウトの問題または既定のクリエイティブがないため、パブリック サービスのお知らせが配信されました。- "外部インプレッション" ( 9 ): インプレッション トラッカーからのインプレッション。- "外部クリック" ( 10 ): クリック トラッカーからのクリック。 |
selling_imp_type |
string | はい | "Resold" |
インプレッションの種類。 使用可能な値については、を参照してください imp_type_id 。 |
cleared_direct |
int | はい | 0 , 1 |
買い手がメディアのコストのために売り手に直接支払うかどうか。 の場合 0 、Xandr は買い手からメディアのコストを収集し、売り手に支払います。 の場合 1 、買い手は売り手に直接メディアのコストを支払います。ヒント: 購入者は、"クリアされた直接" トランザクションを除外することで、請求書のメディアのコストを一致させることができます。 |
pricing_media_type_id |
int | 不要 | 0 , 1 |
ビデオ固有のメディアタイプ分類の ID (課金のみ)。 ビデオ固有の価格がない場合、このフィールドは無関係です。 使用可能な値は、0 、1 、2 、3 です。 |
pricing_media_type_name |
文字列 | いいえ | "Non Video" |
ビデオ固有のメディアタイプ分類の名前 (課金のみ)。 ビデオ固有の価格がない場合、このフィールドは無関係です。 使用可能な値は次のいずれかです: - "--" - "Non-Video" - "Video (Hosted)" - "Video (Non-Hosted)" |
deal_type |
string | はい | "Open Auction" |
特定の取引の取引の種類。 取引の種類のオプションは次のとおりです。 - Open Auction - Private Auction - Curated - First Look - Programmatic Guaranteed |
auction_charges_available |
string | はい | "Yes" |
販売者の控除を開示できる課金対象アクティビティを識別します。 値が の場合、 “yes” SASC の [推定] 列が設定されます。 |
is_claims_activity |
string | はい | "No" |
無効なトラフィック要求が処理されたために支払われない課金対象アクティビティを識別します。 |
is_cross_seat_activity |
string | はい | "No" |
Xandr プラットフォームに複数のメンバー/シートがある場合にのみ関連します。 その場合、このフィールドを使用すると、アクティビティが管理するメンバー間のトランザクションに関連付けられているかどうかを知ることができます。そのため、請求書の調整が簡略化されます。 |
buyer_cleared |
int | はい | 0 |
買い手が売り手またはキュレーターにメディアのコストを直接支払うかどうか。 指定できる値は次のとおりです。0 :Xandrはクリアリングハウスとして機能し、買い手からメディアのコストを収集し、売り手に支払います。1 : Xandr は現金をクリアしません。買い手は、メディアのコストのために売り手を直接支払います。-1 : 未請求アクティビティのダミー値。 |
curator_cleared |
int | はい | 1 |
販売者が Xandr またはキュレーターからリセラー収益を受け取るかどうか。 指定できる値は次のとおりです。0 : 販売者は Xandr からリセラーの収益を受け取ります。1 : 販売者はキュレーターからリセラーの収益を受け取ります。-1 : 未請求アクティビティのダミー値。 |
指標
Column | 型 | 例 | 式 | 説明 |
---|---|---|---|---|
seller_billable_imps |
int | 123456 |
Imps | 請求可能なインプレッションの合計数。 |
imps_filtered |
int | 2365 |
imps_filtered | Xandr の在庫品質レビュー (ブロックされた購入者からのインプレッションなど) によって除外されたインプレッションの合計数。 |
clicks |
int | クリック | すべてのインプレッションに対するクリックの合計数。 | |
convs |
int | 123456 |
total_convs | すべてのインプレッションのコンバージョンの合計数。 |
reseller_revenue |
お 金 | 123.45 |
seller_revenue | 外部 (RTB) バイヤーに対する売上を通じて生じた収益 (米ドル)。 |
reseller_revenue_selling_currency |
お 金 | 123.45 |
reseller_revenue_selling_currency | 外部 (RTB) 購入者への売上を通じて生じた収益。販売者がインプレッションを販売するために使用した取引通貨。 |
seller_media_cost |
お 金 | 123.45 |
seller_media_cost | 発行元に対して支払う金額 (米ドル)。 |
seller_media_cost_selling_currency |
お 金 | 123.45 |
seller_media_cost_selling_currency | 販売者がインプレッションを販売するために使用したトランザクション通貨で、パブリッシャーに対して負う金額。 |
gross_seller_revenue |
お 金 | 123.45 |
gross_seller_revenue | SASC 控除前の販売者収益。 |
SASC_deduction |
お 金 | 122 |
SASC_deduction | 一部の契約では販売者収益シェアとも呼ばれる販売者オークションサービス料金は、SASCがサードパーティの購入者に在庫を販売するための料金です。 これは、買い手のメディアコストの割合として引用され、売り手収益の計算の前に差し引かれます。 オークション時の入札から差し引かれます。 |
SASC_fees |
お 金 | 111 |
SASC_fees | 料金が入札から差し引かれず、クライアントに請求されるコストプラス モデルとして課金されます。 |
bad_debt_fees |
お 金 | 124 |
bad_debt_fees | 買い手が支払ったかどうかに関係なく、販売者への支払いを保証するために請求する合意された金額。 料金が入札から差し引かれず、クライアントに請求されるコストプラス モデルとして課金されます。 |
bad_debt_deductions |
お 金 | 155 |
bad_debt_deductions | 買い手が支払ったかどうかに関係なく、販売者への支払いを保証するために請求する合意された金額。 オークション時の入札から差し引かれます。 |
例
JSON 形式のレポート要求を作成する
JSON ファイルには、 report_type
"seller_pricing_report"
と、取得する列 (ディメンションとメトリック) report_interval
が含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (year
、、) を定義し、month
day
データを"format"
返す対象 (csv
、、excel
またはhtml
) を指定することもできます。 JSON ファイルに含めることができるフィールドの詳細については、 レポート サービスに関するページを参照してください。
$ cat seller_pricing_report.json
{
"report": {
"format": "csv",
"report_interval": "last_48_hours",
"columns": [
"seller_member_name",
"buyer_member_name",
"imps",
"clicks",
"convs"
],
"report_type": "seller_pricing_report"
}
}
POST
を置き換えてメンバー ID を指定するレポート サービスへの要求 INSERT_DESIRED_MEMBER_ID
$ curl -b cookies -c cookies -X POST -d @seller_pricing_report_request.json 'https://api.appnexus.com/report?member_id=INSERT_DESIRED_MEMBER_ID'
{
"response": {
"status": "OK",
"report_id": "9282cde2a86670d9861b77b8fc0954ad", <=== COPY THIS report_id as you will need it to check the status of your report and to download your report
"existing": false,
"cached": true
}
}
}
GET
レポート サービスからのレポートの状態
レポート ID を GET
使用して呼び出しを行って、レポートの状態を取得します。 が "ready"
になるまでこのGET
呼び出しをexecution_status
続けます。 次の手順で説明するように、 レポート ダウンロード サービスを使用してレポート データをファイルに保存します。
$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=9282cde2a86670d9861b77b8fc0954ad'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2015-11-17 22:15:52",
"cache_hit": true,
"fact_cache_hit": true,
"fact_cache_error": null,
"json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"last_48_hours\",\"columns\":[\"seller_member_name\",\"buyer_member_name\",\"imps\",\"clicks\",\"convs\"],\"report_type\":\"seller_pricing_report\",\"filters\":[{\"seller_member_id\":\"2414\"},{\"is_delivered\":{\"value\":[\"1\"],\"operator\":\"=\"}},{\"is_valid_seller\":{\"value\":[\"1\"],\"operator\":\"=\"}}]}}",
"header_info": "Report ID:,6adf8e4e075f93f7dfba164fe8cddab3\r\nRun at:,2015-11-17 22:15:30\r\nStart date:,2015-11-15 22:00:00\r\nEnd date:,2015-11-17 20:00:00\r\nTimezone:,\r\nUser:,Huanqing Liu (171989)\r\n",
"row_count": "0",
"report_size": "56",
"internal_info": "{\"report_id\":\"9282cde2a86670d9861b77b8fc0954ad\",\"cache_hit_using\":\"6adf8e4e075f93f7dfba164fe8cddab3\",\"cache_cause\":1,\"controller_cache_hit\":true}",
"user_id": "171989",
"entity_id": "0",
"started_on": "1970-01-01 00:00:01",
"finished_on": "2015-11-17 22:15:52",
"query_time": null,
"url": "report-download?id=9282cde2a86670d9861b77b8fc0954ad"
},
"execution_status": "ready"
}
}
}
GET
レポート ダウンロード サービスからのレポート データ
レポート データをファイルにダウンロードするには、レポート ID を使用して別 GET
の呼び出しを行いますが、今回は report-download サービスに対して呼び出します。 サービスとレポート ID は、前GET
の応答のフィールドにありますurl
。 保存するファイルを識別する場合は、最初POST
の で指定した の"format"
ファイル拡張子を使用してください。
ヒント
ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTP エラー コードとメッセージが含まれます。 -i
-v
または を呼び出して応答ヘッダーを公開します。
$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=9282cde2a86670d9861b77b8fc0954ad' > seller_pricing_report.csv