デジタル プラットフォーム API - 販売者ブランド レビュー レポート
このレポートでは、すべてのインベントリでブランドのパフォーマンスが表示されます。 次の操作を行うことができます:
- 広告枠で配信されたクリエイティブとそのパフォーマンスを確認します。
- 監査状態でクリエイティブのパフォーマンスを確認します。
- すべてのインベントリでクライアント ブランド カテゴリのパフォーマンスを確認します。
データの time_granularity は daily。 レポートを取得する手順については、 レポート サービス または以下の 例 を参照してください。
期限
JSON 要求の report_interval フィールドは、次のいずれかに設定する必要があります。
- yesterday
- last_7_days
- last_30_days
- month_to_date
- last_month
ヒント
カスタム時間枠のレポートを実行するには、レポート要求の start_date フィールドと end_date フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。
データ保持期間
このレポートのデータ保持期間は 428 日です。
Dimensions
| 列 | 種類 | フィルター。 | 例 | 説明 |
|---|---|---|---|---|
month |
time | いいえ | "2010-02" |
オークションの月。 |
day |
time | いいえ | "2010-02-01" |
オークションの日。 |
buyer_member_id |
int | はい | 643 |
オークションに勝ったメンバーの ID。 |
buyer_seat_name |
string | いいえ | "My Custom Seat" |
購入者シート コードの表示名。 |
buyer_seat_id |
int | はい | 123 |
購入者シートの ID。 |
buyer_seat_code |
string | いいえ | "Custom Seat" |
インプレッションの入札に使用されたカスタム 購入者シート ID (DSP によって送信)。 |
bidder |
int | いいえ | 非推奨。 | |
bidder_name |
int | いいえ | "Microsoft Invest" |
入札者の名前。 |
bidder_id |
int | いいえ | 2 |
メンバーの入札者 ID。 |
curator_member_id |
int | はい | 10652 |
キュレーター メンバーの ID。 |
placement_id |
int | はい | 546 |
配置の ID。 |
placement_name |
string | いいえ | "300x250 Business" |
配置の名前。 |
placement |
string | いいえ | "300x250 Business (546)" |
非推奨。 |
publisher_id |
int | はい | 6787 |
発行元の ID。 |
geo_country |
string | はい | "US" |
地理的な国/地域のコード。 |
geo_country_name |
string | いいえ | "United States" |
地理的な国/地域の名前。 |
imp_type |
string | はい | "Kept" |
非推奨。 |
imp_type_id |
int | はい | 1 |
インプレッションの種類の ID。 使用可能な値 (かっこ内の関連する型):1 ("Blank"): クリエイティブは提供されません。2 ("PSA"): 有効な入札がなく、既定のクリエイティブが利用できなかったため、パブリック サービスのお知らせが提供されました。3 ("既定のエラー"): タイムアウトの問題が原因で配信された既定のクリエイティブ。4 ("Default"): 有効な入札がないため、既定のクリエイティブが配信されました。5 ("保持"): 広告主のクリエイティブがパブリッシャーのサイトで配信されました。6 ("Resold"): 発行元の印象がサード パーティの購入者に販売されました。7 ("RTB"): 広告主のクリエイティブがサード パーティの広告枠で配信されました。8 ("PSA エラー"): タイムアウトの問題または既定のクリエイティブがないため、パブリック サービスのお知らせが提供されました。9 ("外部インプレッション"): インプレッション トラッカーからのインプレッション。10 ("外部クリック"): クリック トラッカーからのクリック。 |
creative_id |
int | はい | 654 |
クリエイティブの ID。 |
site_id |
int | はい | 555 |
サイトの ID。 詳細については、 サイト サービスに関するページを参照してください。 |
site_name |
string | いいえ | "My Site" |
サイトの名前。 詳細については、 サイト サービスに関するページを参照してください。 |
brand_id |
int | はい | 3 |
パブリッシャーのインベントリで配信されるクリエイティブに関連付けられているブランドの ID。 |
brand_name |
string | いいえ | "Ace Hardware" |
パブリッシャーのインベントリで配信されるクリエイティブに関連付けられているブランドの名前。 |
brand |
string | いいえ | "Ace Hardware (3)" |
非推奨。 |
payment_type |
string | はい | "cpm" |
ブローカーへの支払いの種類。 |
revenue_type |
string | いいえ | "cpm" |
広告主があなたに支払うことに同意した方法。 |
revenue_type_id |
int | はい | 4 |
収益の種類の ID。 使用可能な値:-1 = 支払いなし0 = フラット CPM1 = Cost Plus CPM,2 = コストプラスマージン3 = CPC4 = CPA5 = Revshare6 = 定額料金7 = 変数 CPM8 = 推定 CPM |
width |
int | はい | 250 |
クリエイティブの幅。 |
height |
int | はい | 300 |
クリエイティブの高さ。 |
site |
string | いいえ | "My Site (555)" |
非推奨。 |
publisher_code |
string | いいえ | "My Publisher Code" |
発行元のカスタム コード。 |
site_code |
string | いいえ | "Site Name Code" |
サイトのカスタム コード。 |
placement_code |
string | いいえ | "Photos Code" |
配置のカスタム コード。 |
buyer_member_name |
string | いいえ | "Network" |
購入メンバーの名前。 |
buyer_member |
string | いいえ | "Network (567)" |
非推奨。 |
media_type |
string | はい | "Banner", "Pop", "Interstitial", "Video", "Text" |
パブリッシャーのインベントリで配信されるクリエイティブの一般的な表示スタイル。 メディア タイプ サービスを使用して、 メディアの種類 の完全な一覧を表示できます。 |
mediatype_id |
int | はい | 444 |
配信されたクリエイティブに関連付けられているメディアの種類の ID。 詳細については、「 Media Type Service」を参照してください。 |
publisher_name |
string | いいえ | "LOL - US" |
インプレッションが発生したサイトの発行元の名前。 |
publisher |
string | はい | "LOL - US (44389)" |
非推奨。 |
deal_id |
int | はい | 2345 |
取引の ID。 購入者と交渉した取引の詳細については、「 Deal Service」を参照してください。 |
deal_name |
string | いいえ | "Private deal for buyer 1085 with floor of $2.50" |
取引の名前。 |
deal_type |
string | はい | 1 |
取引の種類を表す ID。 使用可能な値:1 = オークションを開く2 = プライベート オークション4 = プログラムによる保証5 = キュレーションオークション |
deal |
string | いいえ | "Private deal for buyer 1085 with floor of $2.50 (45)" |
非推奨。 |
deal_code |
string | いいえ | "Custom code" |
取引のカスタム コード。 |
brand_offer_category_id |
int | はい | 1256 |
インプレッションに関連付けられているブランド オファー カテゴリの ID。
「ブランド サービス」ページの「category_id」を参照してください。 |
brand_offer_category_name |
string | いいえ | "Luxury Cars" |
インプレッションに関連付けられているブランド オファー カテゴリの名前。
「ブランド サービス」ページの「category_id」を参照してください。 |
creative_audit_status_id |
int | はい | 0 |
インプレッションに関連付けられているクリエイティブの監査状態の ID:0 = 監査されていない1 = 販売者は監査のみ2 = appnexus audited |
creative_audit_status |
string | いいえ | "Unaudited" |
インプレッションに関連付けられているクリエイティブの監査状態: - "Unaudited"- "Self Audit Only"- "AppNexus Audited" |
size |
string | はい | "728x90" |
インプレッションに関連付けられているクリエイティブの幅と高さ。 |
指標
| 列 | 型 | 例 | 式 | 説明 |
|---|---|---|---|---|
imps |
int | 34534 |
imps | 合計インプレッション数 (既定値を含む)。 |
clicks |
int | 345 |
クリック | すべてのインプレッションに対するクリックの合計数。 |
cost |
お金 | 16.833378 |
費用 | 直接発行元と購入済みのリアルタイム インベントリのメディア コストの合計金額。 |
revenue |
お金 | 25.767257 |
booked_revenue + reseller_revenue | 予約収益とリセラー収益の合計。 |
booked_revenue |
お金 | 25.767257 |
booked_revenue | 直接広告主 (広告申込情報) を通じて予約された合計収益。 |
reseller_revenue |
お金 | 0 |
reseller_revenue | 直接パブリッシャーを通じて再販されたインプレッションの合計収益。 |
profit |
お金 | 970.40 |
booked_revenue - total_cost | 予約済み収益から合計コストを差し引いた金額。 |
cpm |
お金 | 1.66051685393258 |
(cost/imps) x 1000 | 1,000 インプレッションあたりのコスト。 |
total_convs |
int | 5 |
total_convs | ポストビューとクリック後のコンバージョンの合計数。 |
convs_rate |
double | 0.000221877080097626 |
total_convs/imps | インプレッションへのコンバージョン率。 |
ctr |
double | 0.002327 |
clicks/imps | インプレッションに対するクリック数の割合。 |
rpm |
お金 | 2.60548314606741 |
(revenue/imps) x 1000 | 1000 インプレッションあたりの収益。 |
ppm |
お金 | 0.944966292134831 |
(profit/imps) x 1000 | 非推奨となる。 1000 インプレッションあたりの利益。 |
convs_per_mm |
double | 221.877080097625 |
(total_convs/imps) x 1,000,000 | 100 万インプレッションあたりのコンバージョン数。 |
imps_viewed |
int | 30,450 |
imps_viewed | IAB ビューアビリティ定義に従って表示可能だった測定されたインプレッションの数。これは、1 秒間にピクセルの 50% が表示されている場合に表示可能であることを示します。 |
view_measured_imps |
int | 10,120 |
view_measured_imps | 視認性のために測定されたインプレッションの合計数。 |
view_rate |
double | 58% |
view_rate | 視認性を測定したインプレッションの総数のうち、表示可能だったインプレッションの割合。 (表示された Imps/View Measured Imps) |
view_measurement_rate |
double | 45% |
view_measurement_rate | 総インプレッション数のうち視認性を測定したインプレッションの割合。 (測定された Imps/Imps を表示する) |
total_cost |
お金 | 123.45 |
total_cost = media_cost + data_costs + partner_fees + 手数料 + serving_fees + publisher_revenue | 報告された期間に発生したコストの合計金額。 これには一般に、プラットフォームでパブリッシャーの支払いを追跡する場合、予算コスト (メディア コスト、データ コスト、パートナー手数料、サービス手数料、手数料) の 2 種類のコストとパブリッシャー収益が含まれます。 注: 破壊的変更期間中にサードパーティの料金を二重にカウントしないようにロジックを追加しました。 |
total_cost_ecpm |
お金 | 123.45 |
(total_cost/imps) * 1,000 | 1,000 imps あたりの合計コスト。 |
total_cost_ecpc |
お金 | 123.45 |
total_cost/クリック数 | クリックあたりの合計コスト。 |
total_cost_ecpa |
お金 | 123.45 |
total_cost/変換 | コンバージョンあたりの合計コスト。 |
network_profit |
お金 | 123.45 |
(booked_revenue + reseller_revenue) - total_cost | 予約収益とリセラー収益の合計から合計コストを差し引いた合計。 |
network_profit_ecpm |
お金 | 123.45 |
(network_profit/imps) * 1,000 | 1,000 imps あたりのネットワーク利益。 |
network_profit_ecpc |
お金 | 123.45 |
network_profit/クリック数 | クリックあたりのネットワーク利益。 |
network_profit_ecpa |
お金 | 123.45 |
network_profit/変換 | コンバージョンあたりのネットワーク利益。 |
network_profit_margin |
お金 | 123.45 |
network_profit/(booked_revenue + reseller_revenue) | ネットワーク利益マージン。 |
profit_ecpm |
お金 | 123.45 |
((booked_revenue - total_cost)/imps) * 1,000 | 1,000 imps あたりの利益。 |
profit_ecpc |
お金 | 123.45 |
(booked_revenue - total_cost)/クリック | クリックあたりの利益。 |
profit_ecpa |
お金 | 123.45 |
(booked_revenue - total_cost)/conversions | コンバージョンあたりの利益。 |
profit_margin |
お金 | 123.45 |
(booked_revenue - total_cost)/booked_revenue | 買い手の利益マージン。 |
例
JSON レポート要求を作成する
JSON ファイルには、"seller_brand_review"のreport_typeと、取得する列 (ディメンションとメトリック) とreport_intervalが含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (year、 month、 day) を定義し、データを返す "format" (csv、 excel、または html) を指定することもできます。 JSON ファイルに含めることができるフィールドの詳細については、 レポート サービスに関するページを参照してください。
$ cat seller_brand_review
{"report":
{
"format": "csv",
"report_interval": "yesterday",
"row_per": ["geo_country"],
"columns": ["placement_id","imp_type_id","creative_id","brand_id","geo_country"],
"report_type": "seller_brand_review"
}
}
POST
Report Service への要求
POST レポート ID を取得するための JSON 要求。
$ curl -b cookies -c cookies -X post -d @seller_brand_review "https://api.appnexus.com/report"
{
"response":{
"status":"OK",
"report_id":"c445bca183a3d338dc1c5b85a3d484f5"
}
}
GET レポート サービスからのレポートの状態
レポート ID を使用して GET 呼び出しを行って、レポートの状態を取得します。
execution_statusが"ready"されるまで、このGET呼び出しを行い続けます。 次の手順で説明するように、 レポート ダウンロード サービスを使用してレポート データをファイルに保存します。
$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=c445bca183a3d338dc1c5b85a3d484f5'
{
"response": {
"status": "OK",
"report": {
"name": null,
"created_on": "2014-11-19 22:33:31",
"json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"yesterday\",\"row_per\":[\"geo_country\"],\"columns\":[\"placement_id\",\"imp_type_id\",\"creative_id\",\"brand_id\",\"geo_country\"],\"report_type\":\"seller_brand_review\",\"filters\":[{\"seller_member_id\":\"958\"}]}}",
"url": "report-download?id=c445bca183a3d338dc1c5b85a3d484f5"
},
"execution_status": "ready"
}
}
GET レポート ダウンロード サービスからのレポート データ
レポート データをファイルにダウンロードするには、レポート ID を使用して別の GET 呼び出しを行いますが、今回は レポートダウンロード サービスに呼び出します。 サービス ID とレポート ID は、前のGET呼び出しに対する応答のurl フィールドにあります。 保存するファイルを特定するときは、最初の POSTで指定したファイル形式のファイル拡張子を使用してください。
ヒント
ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTP エラー コードとメッセージが含まれます。 応答ヘッダーを公開するには、呼び出しで -i または -v を使用します。
$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=c445bca183a3d338dc1c5b85a3d484f5' > /tmp/seller_brand_review.csv
注:
XLSX および Excel ファイルとしてダウンロードする場合、レポートごとに 100,000 行の制限があります。