デジタル プラットフォーム API - ベンダー使用状況レポート

このネットワーク レポートでは、サードパーティ ベンダー (ユーザー セグメント プロバイダーなど) が提供するデータまたはプラットフォームの使用状況、そのデータまたは機能の使用状況のコスト、ベンダーのコストが適用されるライン アイテム/キャンペーンに関する詳細が表示されます。

時間枠

JSON 要求の report_interval フィールドは、次のいずれかに設定する必要があります。

  • 今日
  • yesterday
  • last_7_days
  • last_30_days
  • month_to_date
  • quarter_to_date
  • last_month
  • 有効期間

データの time_granularity は hourlyです。 レポートを取得する手順については、 レポート サービス または以下の 例 を参照してください。

注:

カスタムの時間枠でレポートを実行するには、レポート要求の start_date フィールドと end_date フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。

データ保持期間

このレポートのデータ保持期間は 60 日です。

Dimensions

列 種類 フィルター? 例 説明
month date はい "2010-02" インプレッションに関連付けられたオークションが発生した月。
day date はい "2010-02-01" インプレッションに関連付けられたオークションが発生した曜日。
hour date はい "2010-02-01 05:00:00" インプレッションに関連付けられているオークションが発生した時刻。
buyer_member_id int はい 643 サード パーティ ベンダー (ユーザー セグメント プロバイダーなど) によって提供されたデータを使用したメンバーの ID。
geo_country string はい "US" インプレッションに関連付けられている地理的な国/地域のコード。
geo_country_name string いいえ "United States" インプレッションに関連付けられている地理的な国/地域の名前。
geo_country_code string はい "CA" インプレッションに関連付けられている国/地域を示す 2 文字の文字列。
campaign_id int はい 31 サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられているキャンペーンの ID。
campaign_name string いいえ "Prospect Campaign" サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられているキャンペーンの名前。
campaign string いいえ "Prospect Campaign (31)" インプレッションに関連付けられているキャンペーンの名前と ID。
campaign_group_type_id int はい 154 このインプレッションを購入したキャンペーン グループのタイプの ID。 分割レポートで使用されます。
split_id int はい 342 このデータ セットのインプレッションを購入した分割の ID。 分割は、拡張広告申込情報にのみ適用されます。 キャンペーンを含むレポートでは、 split_id (含まれている場合) が nullされます。
split_name string いいえ "Mobile Split A" このデータ セットのインプレッションを購入した分割の名前。 分割は、拡張広告申込情報にのみ適用されます。 キャンペーンを含むレポートでは、 split_name (含まれている場合) が nullされます。
split string いいえ "Mobile Split A (342)" 分割の名前と ID。
line_item_name string いいえ "Fall Apparel" サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられた広告申込情報の名前。
targeted_segment_ids string いいえ "935035, 935146" ターゲティング時に使用される各セグメントの ID のコンマ区切りリスト。
advertiser_currency string はい "USD" 広告主が希望する通貨。 この設定は、 広告主サービスを使用して設定できます。
insertion_order_id int はい 1243 サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられた広告掲載オーダーの ID。
insertion_order_name string いいえ "IO001" サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられている広告掲載オーダーの名前。
insertion_order_code string いいえ "IOABC-1243" 広告掲載オーダーに関連付けられているユーザー定義コード。
insertion_order string いいえ "IO001 (1243)" サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられた広告掲載オーダーの名前と ID。
advertiser_id int はい 9843 インプレッションに関連付けられている広告主 ID。 値が 0 の場合は、インプレッションが外部購入者によって購入されたか、既定または PSA が表示された場合です。
advertiser_name string いいえ "ADVUS" インプレッションに関連付けられている広告主の名前。
advertiser string いいえ "ADVUS (9843)" インプレッションに関連付けられている広告主の名前と ID。
line_item_id int はい 9865 サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられた広告申込情報の ID。
line_item_code string いいえ "LI001" 明細行品目に関連付けられているユーザー定義コード。
line_item string いいえ "Fall Apparel (9865)" サードパーティのデータ ターゲティングを使用したインプレッションに関連付けられた広告申込情報の名前と ID。
vendor_id int はい 76 データ使用量とコストがこのレポートに含まれるサード パーティ ベンダー (ユーザー セグメント プロバイダーなど) の ID。
vendor_name string いいえ "AXM" サード パーティ ベンダーの名前。
vendor string いいえ "AXM (76)" サード パーティ ベンダーの名前と ID。
vendor_type string いいえ "Segment Marketplace" ベンダーが提供するサード パーティ データに応じたベンダーの種類。
有効な値は次のとおりです。
- Segment Marketplace
- Cross Device Graph
- Measurement
- Offline Attribution
- Unknown Vendor Type
cost_type string いいえ "Segment Data Costs" サード パーティ ベンダーが提供するデータ使用量に対して発生するコストの種類。 有効な値は次のとおりです。
- Segment Data Costs
- Feature Costs
- Unknown Vendor Type
buying_currency string はい "USD" 購入者がこのインプレッションの購入に使用した取引通貨。
cpm_usd 金銭 はい 7.8 1000 または 1,000 (ラテン語で mille = 1,000) を米ドルで表します。 広告の 1,000 回のインプレッションに対して広告主が支払う価格モデル。

指標

列 種類 Filter 例 式 説明
imps int はい 34534 imps サードパーティのデータを使用して広告を配信したインプレッションの合計数。
third_party_costs 金銭 はい 5.20 third_party_costs データ セグメント コスト、機能コスト、またはその他の総金額。
transaction_tax 金銭 いいえ .43 transaction_tax 適用される売上税、付加価値税、商品サービス税、または同様の取引税 (取引税) は、オンボード エクスペリエンスで提供されたお客様のアカウントの事業拠点に基づいて、Microsoft との取引に適用されます。
vendor_costs 金銭 いいえ 5.00 vendor_costs セグメント データ コストと機能コストを含むがこれらに限定されない合計コスト。
機能コスト: Nielsen Digital Ad Ratings (DAR)、Nielsen Catalina Solutions (NCS)、Cross Device などのプラットフォーム機能を使用する際に発生するコスト。
セグメント データ コスト:データ マーケットプレースでのセグメントの使用に関連するすべてのコスト。 特定のセグメントがライン アイテムに適用され、関連する価格がプラットフォームに表示される場合に適用されます。
vendor_costs_buying_currency 金銭 いいえ 1.50 vendor_costs_buying_currency 仕入先のコストは、購入者が使用するトランザクション通貨で表されます。

例

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

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

$ cat buyer_vendor_usage_analytics  
{
    "report": {
        "report_type": "buyer_vendor_usage_analytics",
        "format": "csv",
        "report_interval": "last_7_days",
        "columns": [
            "imps",
            "line_item_id",
            "vendor_costs",
            "sales_tax",
            "vendor_type",
            "vendor"
        ],
        "orders": [
            "line_item_id",
            "vendor_costs",
            "vendor_type"
        ]
    }
}

POST リクエストをレポート サービスに送信します

POST レポート ID を取得するための JSON 要求。

$ curl -b cookies -c cookies -X post -d @buyer_vendor_usage_analytics "https://api.appnexus.com/report"
{
    "response": {
        "report_id": "d89151942729f768dcac4586288ff7eb",
        "status": "OK",
        "dbg_info": {
            "user::read_limit": 100,
            "user::write_limit": 60,
            "read_limit": 100,
            "write_limit": 60,
            "user::read_limit_seconds": 60,
            "user::write_limit_seconds": 60,
            "read_limit_seconds": 60,
            "write_limit_seconds": 60,
            "instance": "50.bm-report-processor.prod.nym2",
            "version": "1.73.238",
            "time": 712.83793449402,
            "start_microtime": 1686106227,
            "warnings": [],
            "api_cache_hit": "0",
            "output_term": null,
            "edge_forwarded_dbg_info": {
                "user::read_limit": 100,
                "user::write_limit": 60,
                "read_limit": 100,
                "write_limit": 60,
                "user::read_limit_seconds": 60,
                "user::write_limit_seconds": 60,
                "read_limit_seconds": 60,
                "write_limit_seconds": 60,
                "instance": "37.report-processor.prod.nym2",
                "version": "1.73.238",
                "time": 708.98699760437,
                "start_microtime": 1686106227,
                "warnings": [],
                "api_cache_hit": "0",
                "output_term": "report_id"
            },
            "edge_forwarded": true,
            "edge_forwarded_by": "50.bm-report-processor.prod.nym2",
            "edge_forwarded_to": "http://report-processor-edge.adnxs.net/report"
        }
    }
}

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

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

$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=d89151942729f768dcac4586288ff7eb'
{
    "response": {
        "status": "OK",
        "report": {
            "id": "d89151942729f768dcac4586288ff7eb",
            "name": "",
            "created_on": "2023-06-07 02:50:27",
            "cache_hit": false,
            "fact_cache_hit": false,
            "fact_cache_error": "",
            "json_request": "{\"report\":{\"report_type\":\"buyer_vendor_usage_analytics\",\"format\":\"csv\",\"report_interval\":\"last_7_days\",\"columns\":[\"imps\",\"line_item_id\",\"vendor_costs\",\"sales_tax\",\"vendor_type\",\"vendor\"],\"orders\":[{\"order_by\":\"line_item_id\",\"direction\":\"ASC\"},{\"order_by\":\"vendor_costs\",\"direction\":\"ASC\"},{\"order_by\":\"vendor_type\",\"direction\":\"ASC\"}],\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"buyer_member_id\":\"958\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1686096000,\"start_date\":1685491200,\"user_id\":\"4814\"}",
            "header_info": "Report type: buyer_vendor_usage_analyticss\nReport ID: d89151942729f768dcac4586288ff7eb\nRun at: 2023-06-07 04:08:58 UTC\nRequested Start date: 2023-05-31 00:00:00 UTC\nRequested End date: 2023-06-07 00:00:00 UTC\nTimezone: UTC\n",
            "user_id": "4814",
            "member_id": "958",
            "bidder_id": "2",
            "entity_id": "958",
            "row_count": 0,
            "report_size": 61,
            "url": "report-download?id=d89151942729f768dcac4586288ff7eb"
        },
        "execution_status": "ready",
        "_was_this_status_cached_": 0,
        "dbg_info": {
            "user::read_limit": 100,
            "user::write_limit": 60,
            "read_limit": 100,
            "write_limit": 60,
            "user::read_limit_seconds": 60,
            "user::write_limit_seconds": 60,
            "read_limit_seconds": 60,
            "write_limit_seconds": 60,
            "instance": "50.bm-report-processor.prod.nym2",
            "version": "1.73.238",
            "time": 454.48088645935,
            "start_microtime": 1686110938,
            "warnings": [],
            "api_cache_hit": "0",
            "output_term": null,
            "edge_forwarded_dbg_info": {
                "user::read_limit": 100,
                "user::write_limit": 60,
                "read_limit": 100,
                "write_limit": 60,
                "user::read_limit_seconds": 60,
                "user::write_limit_seconds": 60,
                "read_limit_seconds": 60,
                "write_limit_seconds": 60,
                "instance": "37.report-processor.prod.nym2",
                "version": "1.73.238",
                "time": 448.82392883301,
                "start_microtime": 1686110938,
                "warnings": [],
                "api_cache_hit": "0",
                "output_term": "report"
            },
            "edge_forwarded": true,
            "edge_forwarded_by": "50.bm-report-processor.prod.nym2",
            "edge_forwarded_to": "http://report-processor-edge.adnxs.net/report"
        }
    }
}

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

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

curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=d89151942729f768dcac4586288ff7eb' > /tmp/buyer_vendor_usage_analytics.csv

ヒント

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

注:

XLSX および Excel ファイルとしてダウンロードする場合、レポートごとに 100,000 行の制限があります。

  • Last updated on