Digital Platform API - マルチバイヤー販売者取引メトリック
マルチバイヤー販売者取引メトリック レポートには、販売者に関連する取引メトリック、パフォーマンス、拒否の理由に関する重要な情報が表示されます。
レポートを取得する手順については、 レポート サービス または以下の 例 を参照してください。
時間枠
JSON 要求のフィールドは report_interval
、次のいずれかに設定できます。
- カスタム
- yesterday
- 今日
- last_2 _days
- last_7_days (現在は含まれません)
- last_14_Days
- last_30_days
データ保持期間
このレポートのデータ保持期間は 30 日間です。
注:
カスタム時間枠のレポートを実行するには、レポート要求の フィールド start_date
と end_date
フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。
Dimensions
Column | フィルター。 | 説明 |
---|---|---|
ask_price |
はい | 取引の要求価格。 |
bidder_id |
はい | インプレッションの入札者 (DSP) の ID。 |
bidder_name |
不要 | インプレッションの入札者 (DSP) の名前。 |
buyer_member_name |
はい | インプレッションを購入した特定の購入者。 |
buyer_member_id |
はい | インプレッションを購入した購入者の ID。 |
deal_auction_type_name |
はい | 取引のオークションの種類。 取引には、次のオークションの種類を指定できます。 - first price - second price - fixed price |
deal_buyer_type |
はい | 選択すると、インプレッションが配信した購入者の種類でフィルター処理されます。 使用可能な値: - "Entire Deal" - "Bidder" - "Buyer Member" - "Buyer Seat" 注: このディメンションは、マルチバイヤー取引メトリック レポートで必須です。 取引購入者の種類別にデータが分割されていない場合は、[取引全体] でフィルター処理します。 |
deal_name |
はい | インプレッションのトランザクションに関連付けられた取引。 |
deal_type_name |
はい | 取引がパブリック 取引、プライベート 取引、またはプログラムによる保証取引のいずれであるか。 |
end_date |
はい | 取引が買い手に提供されなくなった日と時刻。 |
package_id |
はい | 取引が作成されたパッケージの ID。 この値は 0 、取引がパッケージから作成されなかった場合になります。 |
priority |
はい | プライベート オークションの場合のみ、売り手が取引に割り当てた優先順位。 |
start_date |
はい | 取引が買い手に提供され始める日時。 |
指標
Column | 種類 | フィルター。 | 説明 |
---|---|---|---|
hour |
time | 不要 | オークションの時間。 注: 100 日を超えるインプレッションの場合、1 時間ではなく日が返されます。 |
day |
time | 不要 | オークションの日。 |
month |
time | 不要 | オークションの月。 |
imps_matched |
int | はい | 取引の販売者の設定 (購入者ではなく) に一致するインプレッションの合計数。 |
bid_requests |
int | はい | 入札要求の数。 |
bids |
int | はい | 完了した入札の数。 |
imps_won |
int | はい | 獲得したインプレッションの合計数。 |
seller_revenue |
通貨 | はい | 取引の販売者収益。 |
seller_revenue_ecpm |
通貨 | はい | eCPM で表される取引の販売者収益。 |
average_net_bid |
通貨 | はい | 取引の平均純入札。 これは、すべての手数料の純額であり、売り手の収益を決定するために使用される入札価格です (発生する可能性のある入札価格の引き下げの前)。 |
average_biased_bid |
通貨 | はい | 取引の平均バイアス入札。 これは、オークションのランキング目的で使用される入札価格です。 |
average_floor_price |
通貨 | はい | 取引の平均フロア価格。 |
deal_type_name |
string | はい | 取引がパブリック 取引かプライベート 取引か。 |
bid_rate |
int | はい | 取引に対する入札率。 |
ineligible_bid_rate |
int | はい | 取引に対する不適格な入札のレート。 |
gross_win_rate |
int | はい | 取引の総勝率。 |
net_win_rate |
int | はい | 取引の純勝率。 |
ask_price |
通貨 | はい | 取引の要求価格 |
reject_count |
int | はい | 拒否された入札の合計数。 |
reject_bidder_error_count |
int | はい | 入札者エラーが原因で拒否された入札の数。 |
reject_blocked_by_ad_profile_count |
int | はい | 広告プロファイルによって拒否されたすべての入札の合計。 |
reject_below_floor_count |
int | はい | オークションで設定された予約価格を下回るため、拒否された入札の数。 |
reject_blocked_by_deal_count |
int | はい | 取引の制約により拒否されたすべての入札の合計。 |
reject_invalid_creative_count |
int | はい | 購入者が入札した無効なクリエイティブが原因で拒否された入札の数。 |
reject_blocked_by_dynamic_adserver_count |
int | はい | インプレッションリクエスト時に販売者が動的に渡した広告サーバーの制約により拒否された入札の数。 |
reject_other_count |
int | はい | ここに記載されていない理由で拒否された入札の数。 |
reject_bidder_error_deal_not_available_count |
int | はい | 取引が利用できなくなったために拒否された入札の数。 |
reject_blocked_by_ad_profile_creative_count |
int | はい | クリエイティブ広告サーバーが広告プロファイルによってブロックされたために拒否された入札の数。 |
reject_blocked_by_ad_profile_language_count |
int | はい | 広告プロファイルによって広告の言語がブロックされたために拒否された入札の数。 |
reject_blocked_by_ad_profile_tech_attribute_count |
int | はい | 広告プロファイルによって広告の技術属性がブロックされたために拒否された入札の数。 |
reject_blocked_by_ad_profile_category_count |
int | はい | 広告プロファイルでクリエイティブのカテゴリが許可されていないために拒否された入札の数。 |
reject_blocked_by_ad_profile_brand_count |
int | はい | ブランドの除外が原因で広告プロファイルによってブロックされた入札の数。 |
reject_blocked_by_ad_profile_adserver_count |
int | はい | 購入者が入札するクリエイティブに関連付けられている広告サーバーがブロックされているため、入札が拒否された数。 |
reject_blocked_by_ad_profile_member_count |
int | はい | メンバーが広告プロファイルによってブロックされたために拒否された入札の数。 |
reject_blocked_by_ad_profile_audit_status_count |
int | はい | 広告プロファイルが監査状態のためにブロックした入札の数。 これは通常、購入者が未監査のクリエイティブで入札していて、販売者が広告品質の監査されていないクリエイティブをブロックした場合に発生します。 |
reject_below_floor_ym_count |
int | はい | オークションに適用される利回り管理フロアを下回るため、拒否された入札の数。 |
reject_invalid_creative_not_ssl_count |
int | はい | クリエイティブが SSL で安全なオークションに承認されていないために拒否された入札の数。 |
reject_blocked_by_deal_creative_count |
int | はい | 言語設定が原因で取引によってブロックされた入札の数。 |
reject_blocked_by_deal_language_count |
int | はい | 言語設定が原因で取引によってブロックされた入札の数。 |
reject_blocked_by_deal_tech_attribute_count |
int | はい | 技術的属性が取引によってブロックされたために拒否された入札の数。 |
reject_blocked_by_deal_category_count |
int | はい | 取引でクリエイティブのカテゴリが許可されていないために拒否された入札の数。 |
reject_blocked_by_deal_brand_count |
int | はい | 取引によってブランドがブロックされたために拒否された入札の数。 |
reject_blocked_by_deal_below_floor_count |
int | はい | オークションに適用されるフロアを下回っているために拒否された入札の数。 |
reject_blocked_by_deal_media_subtype_count |
int | はい | メディア サブタイプが原因で拒否された入札の数。 |
reject_blocked_by_deal_size_count |
int | はい | 案件のサイズ要件と一致しなかったために拒否された入札の数。 |
reject_blocked_by_deal_payment_type_count |
int | はい | 支払いタイプが取引で許可されていないために拒否された入札の数。 |
reject_blocked_by_deal_adserver_count |
int | はい | 取引に対する広告サーバーの制約が原因でブロックされた入札の数。 |
reject_blocked_by_dynamic_brand_count |
int | はい | 販売者が渡した入札要求によってブランドが動的にブロックされるため、拒否された入札の数。 |
reject_blocked_by_dynamic_language_count |
int | はい | 販売者が渡した入札要求によって言語が動的にブロックされるため、拒否された入札の数。 |
reject_blocked_by_dynamic_tech_attribute_count |
int | はい | 技術的属性が販売者によって渡された入札要求によって動的にブロックされるため、拒否された入札の数。 |
reject_blocked_by_dynamic_category_count |
int | はい | クリエイティブ カテゴリが販売者によって渡された入札要求によって動的にブロックされるため、拒否された入札の数。 |
reject_other_data_protection_count |
int | はい | ここに記載されていないデータ セキュリティ上の理由で拒否された入札の合計数。 |
reject_other_advertiser_exclusion_count |
int | はい | 上記に記載されていない広告主の除外が原因で拒否された入札の合計数。 |
例
JSON 形式のレポート要求を作成する
JSON ファイルには、 report_type
"multi_buyer_seller_deal_metrics"
と、取得する columns
(ディメンションとメトリック) が report_interval
含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (year
、、) を定義し、month
day
データを"format"
返す対象 ("csv"
、、"excel"
または"html"
) を指定することもできます。 JSON ファイルに含めることができるフィールドの詳細については、 レポート サービスに関するページを参照してください。
$ cat multi_buyer_seller_deal_metrics
{
"report": {
"report_type": "multi_buyer_seller_deal_metrics",
"columns": [
"hour",
"buyer_member_name",
"deal_name",
"start_date",
"end_date",
"average_net_bid",
"imps_won",
"seller_revenue",
"reject_count"
],
"filters": [{
"deal_buyer_type": ["Buyer Member"]
}],
"report_interval": "last_7_days",
"format": "csv"
}
}
POST
レポート サービスへの要求
$ curl -b cookies -X POST -d @multi_buyer_seller_deal_metrics 'https://api.appnexus.com/report'
{
"response":{
"status":"OK",
"report_id":"b97897a7864dd8f34e7457226c7af592"
}
}
GET
レポート サービスからのレポートの状態
レポート ID を GET
使用して呼び出しを行って、レポートの状態を取得します。 が "ready"
になるまでこのGET
呼び出しをexecution_status
続けます。 次の手順で説明するように、 レポート ダウンロード サービスを使用してレポート データをファイルに保存します。
$ curl -b cookies 'https://api.appnexus.com/report?id=b97897a7864dd8f34e7457226c7af592'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2010-05-25 19:19:53",
"json_request": "{\"report\":{\"report_type\":\"multi_buyer_seller_deal_metrics\",\"columns\":[\"hour\",\
"buyer_member_name\",\"deal_name\",\"start_date\",\"end_date\",\"average_net_bid\",\"imps_won\",\"seller_revenue\,\"reject_count\"],\
"row_per\":[\"hour\",\"buyer_member_id\",\"deal_id\"],\
"report_interval\":\"last_7_days\"}}",
"url": "report-download?id=b97897a7864dd8f34e7457226c7af592"
},
"execution_status": "ready"
}
}
GET
レポート ダウンロード サービスからのレポート データ
レポート データをファイルにダウンロードするには、レポート ID を使用して別 GET
の呼び出しを行いますが、今回は report-download サービスに対して呼び出します。 サービスとレポート ID は、前GET
の応答のフィールドにありますurl
。 保存するファイルを識別する場合は、最初POST
の で指定した の"format"
ファイル拡張子を使用してください。
注:
ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTP エラー コードとメッセージが含まれます。 i
v
または を呼び出して応答ヘッダーを公開します。
$ curl -b cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/multi_buyer_seller_deal_metrics.csv
注:
XLSX および Excel ファイルとしてダウンロードする場合、レポートごとに 100,000 行の制限があります。