Bidder Billing report API

購入者は、入札者請求レポートを使用して取引情報を収集し、広告主に請求できます。

レポートを取得する手順については、「 レポート サービス」を参照してください。

時間枠

JSON 要求の report_interval フィールドは、次のいずれかに設定できます。

  • current_hour
  • last_hour
  • last_48_hours
  • today
  • yesterday
  • last_7_days
  • month_to_date
  • quarter_to_date
  • last_month
  • lifetime
  • month_to_yesterday
  • custom

Dimensions

列 種類 グループ? フィルター? 例 説明
hour time はい はい "2010-02-01 06:00:00" インプレッションの時間。

メモ: 100 日より前のインプレッションの場合、時間ごとのデータは、時として 'YYYY-MM-DD 00:00:00' を使用して 1 つの行に集計されます ('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 Buyer" 購入者メンバーの表示名。
seller_member_id int はい はい 456 販売者メンバーの内部 ID。
seller_member_name 文字列 いいえ 不要 "That Seller" 販売者メンバーの表示名。
publisher_id int はい はい 321 発行元の内部 ID。
geo_country string はい はい "US" 対象の国または地域のコード。
geo_country_name 文字列 いいえ 不要 "United States" 対象の国または地域の名称。
deal_id int はい はい 123 取引の内部 ID。
deal_name 文字列 いいえ 不要 "Deal A" 取引の表示名。
direct_cleared int はい はい 0, 1 買い手が売り手に直接メディア代金を支払うかどうか。 0場合、Xandr は買い手からメディアのコストを回収し、売り手に支払います。 1の場合、買い手は売り手に直接メディア代金を支払います。

ヒント: 購入者は、"清算されたダイレクト" トランザクションをフィルター処理することで、請求書のメディア コストを照合できます。
buying_currency string はい はい "USD" 購入者がこのインプレッションを購入するために使用した取引通貨。
selling_currency string はい はい "EUR" 販売者がこのインプレッションを販売するために使用した取引通貨。
imp_type_id int はい はい 7 インプレッションの種類の ID。 使用可能な値 (かっこ内の関連付けられた型):
- 7 ("RTB"): 第三者の在庫で提供される購入者のクリエイティブ。
- 9(「外部インプレッション」):インプレッショントラッカーからのインプレッション。
- 10(「外部クリック」): クリック トラッカーからのクリック。
buyer_seat_code string はい 不要 "1234" インプレッションへの入札に使用されたカスタム購入者シート ID (DSP から送信)。
buyer_seat_name string はい 不要 "test seat" 購入者のシート コードの表示名。

指標

列 型 例 式 説明
imps int 100 imps_delivered 正常に配信されたインプレッションの総数。
imps_direct_cleared int 100 imps_direct_cleared Xandr が購入者のメディア コストを収集したり、この購入者と販売者のペア間の取引に対して販売者の支払いを支払ったりしないインプレッションの合計数。
imps_appnexus_cleared int 100 imps_appnexus_cleared Xandr が購入者のメディア コストを収集し、この購入者と販売者のペア間の取引に対して販売者の支払いを支払うインプレッションの合計数。
buyer_media_cost 金銭 123.45 buyer_media_cost 購入した在庫の合計コスト。
buyer_media_cost_direct_cleared 金銭 123.45 imps_direct_cleared でbuyer_media_cost 売り手の支払いが Xandr 経由ではなく、この買い手と売り手のペアの間で直接取引されるインプレッションに対する買い手の支出。
buyer_media_cost_direct_cleared_buying_currency 金銭 123.45 buyer_media_cost_direct_cleared_buying_currency インプレッションに対する買い手の支出で、売り手の支払いが、買い手がインプレッションの購入に使用した取引通貨で Xandr を介さずに、この買い手と売り手のペアの間で直接取引されます。
buyer_media_cost_appnexus_cleared 金銭 123.45 imps_appnexus_cleared でbuyer_media_cost Xandr が販売者の支払いを支払うインプレッションに対する購入者の支出。
buyer_media_cost_direct_cleared_buying_currency 金銭 123.45 buyer_media_cost_direct_cleared_buying_currency Xandr がインプレッションの購入に使用した取引通貨で販売者の支払いを支払うインプレッションに対する購入者の支出。
buyer_media_cost_buying_currency 金銭 123.45 buyer_media_cost_buying_currency 購入された在庫の合計コスト。購入者がインプレッションの購入に使用したトランザクション通貨で表します。
creative_overage_fees 金銭 123.45 creative_overage_fees ホスト型クリエイティブに対して請求される料金の合計が、クリエイティブのサイズ制限を超えた場合。
creative_overage_fees_buying_currency 金銭 123.45 creative_overage_fees_buying_currency ホストされたクリエイティブがクリエイティブのサイズ制限を超えた場合に請求される料金の合計は、購入者がインプレッションの購入に使用した取引通貨で表されます。
auction_service_fees 金銭 123.45 auction_service_fees 購入者のメンバー契約で指定された RTB 購入インプレッションに対して請求される料金。 たとえば、10% の手数料で、購入者が在庫に 1,000 ドルを費やした場合、Xandr は購入者に 100 ドルの手数料を請求します。 メディア費用 1,000 ドルとバイヤー オークションサービス料 (BASC) 100 ドル、合計 1,100 ドルの請求書を受け取ります。

次の 2 種類があります。
- direct_cleared行の場合、直接クリア料金がこのフィールドに記録されます。
- バイヤー オークション サービス料金 (BASC) を控除ではなく手数料として設定している場合、ここにも値が記録されます。 レポートをプルするときに、direct_clearedディメンションでグループ化することで区別できます。
auction_service_fees_buying_currency 金銭 123.45 auction_service_fees_buying_currency 購入者のメンバー契約で指定された RTB 購入インプレッションに対して請求される手数料は、購入者がインプレッションの購入に使用した取引通貨で計算されます。
auction_service_deduction 金銭 123.45 auction_service_deduction 購入者のメンバー契約で指定された RTB 購入インプレッションの控除。 たとえば、10% の控除で、キャンペーンに 1,000 ドルの予算を立てた場合、Xandr はそこから 100 ドルを受け取り、買い手は売り手から在庫を購入するために使用される 900 ドルを残します。 ここでは、クリエイティブ オークション サービス変更 (CASC) も紹介します。 上記の例では、購入者は Xandr 料金の控除を含む 1,000 ドルのメディア コストの請求書を受け取ります。

警告: このフィールドは、契約の購入者オークション サービス料金 (BASC) が 0% を超える場合auction_service_fees一致します。
auction_service_deduction_buying_currency 金銭 123.45 auction_service_deduction_buying_currency 購入者メンバーの契約で指定された RTB 購入インプレッションに対する控除額は、購入者がインプレッションの購入に使用した取引通貨で表します。
buyer_ecpm 金銭 123.45 buyer_media_cost / imps_delivered * 1000 eCPM で表される購入者のインプレッション単価。
buyer_ecpm_buying_currency 金銭 123.45 buyer_ecpm、購入者の通貨で表されます 購入者が選択した通貨でのインプレッション単価。 サポートされている通貨の一覧については、「 サポートされている通貨」を参照してください。

例

JSON 形式のレポート要求を作成する

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

$ cat buyer_invoice_report_request.json
{
    "report": {
        "format": "csv",
        "report_interval": "last_48_hours",
        "columns": [
            "seller_member_name",
            "buyer_member_name",
            "imps"
        ],
        "report_type": "bidder_pricing_report"
    }
}

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

$ curl -b cookies -c cookies -X POST -d @bidder_pricing_report_request.json 'https://api.adnxs.com/report'
{
 "response": {
   "status": "OK",
   "report_id": "39c4855a07e92433947886b5aabd267d", <=== COPY THIS report_id as you will need it to check the status of your report and to download your report
   "existing": false,
   "dbg_info": {
     ...
     }
   }
 }
}

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

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

$ curl -b cookies -c cookies 'https://api.adnxs.com/report?id=39c4855a07e92433947886b5aabd267d'
{
 "response": {
   "status": "OK",
   "report": {
     "name": null,
     "created_on": "2015-11-17 21:27:21",
     "cache_hit": false,
     "fact_cache_hit": false,
     "fact_cache_error": null,
     "json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"last_48_hours\",\"columns\":[\"seller_member_name\",\"buyer_member_name\",\"imps\",\"report_type\":\"bidder_pricing_report\"}}",
     "header_info": "Report ID:,39c4855a07e92433947886b5aabd267d\r\nRun at:,2015-11-17 21:27:21\r\nStart date:,2015-11-15 21:00:00\r\nEnd date:,2015-11-17 20:00:00\r\nTimezone:,\r\nUser:,Huanqing Liu (171989)\r\n",
     "row_count": "309",
     "report_size": "15583",
     "internal_info": "{...}",
     "user_id": "171989",
     "entity_id": "0",
     "started_on": "2015-11-17 21:27:22",
     "finished_on": "2015-11-17 21:27:24",
     "query_time": "0",
     "url": "report-download?id=39c4855a07e92433947886b5aabd267d"
   },
   "execution_status": "ready",
   "_was_this_status_cached_": 0,
   "dbg_info": {
     ...
     }
   }
 }
}

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

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

注:

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

$ curl -b cookies -c cookies 'https://api.adnxs.com/report-download?id=39c4855a07e92433947886b5aabd267d' > bidder_pricing_report.csv
  • Last updated on