次の方法で共有

Bidder Billing レポート API

  • [アーティクル]

購入者は、Bidder 課金レポートを使用して取引情報を収集し、広告主に請求書を送ることができます。

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

期限

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

Column 種類 群。 フィルター。 例 説明
hour time はい はい "2010-02-01 06:00:00" 印象の時間。

手記： 100 日を超えるインプレッションの場合、1 時間あたりのデータは 1 行に集計され、"YYYY-MM-DD 00:00:00" が時間 ('YYYY-MM-DD' はアクティビティが発生した UTC 日) として 1 行に集計されます。 これにより、すべてのアクティビティが真夜中に発生したかのように見えるようになります。 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" 購入者シート コードの表示名。

指標

Column 種類 例 式 説明
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,100 のメディア コストの $1,000 と買い手オークション サービス料金 (BASC) の $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) もここに表示されます。 上記の例では、購入者は 1,000 ドルのメディア コストの請求書を受け取ります。この請求書には、Xandr の請求額が含まれています。

警告： このフィールドは、契約の購入者オークション サービス料金 (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