購入者エンゲージメント レポートでは、ディスプレイおよびビデオ クリエイティブの表示可能な期間について分析情報を得ることができます。
レポートを取得する手順については、 Report Service または以下の 例 を参照してください。
期限
JSON 要求の report_interval フィールドは、次のいずれかに設定できます。
- 習慣
- yesterday
- last_7_days
- last_14_days
- month_to_yesterday
- last_30_days
データ保持期間
このレポートのデータは 1 日の時間細分性を持ち、5 週間保持されます。 このレポートには、UTC/GMT タイム ゾーンの下にデータも表示されます。
注:
カスタム時間枠のレポートを実行するには、レポート要求の start_date フィールドと end_date フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。
Dimensions
| 列 | 種類 | フィルター。 | 説明 |
|---|---|---|---|
buyer_member_id |
int | はい | インプレッションの購入メンバーの ID。 |
seller_member_id |
int | はい | 販売メンバーの ID。 |
size |
string | はい | 配信されたクリエイティブのサイズ。 |
seller_member_name |
文字列 | いいえ | 販売メンバーの名前。 |
advertiser_id |
int | はい | 配信されたインプレッションに関連付けられている広告主オブジェクトの ID。 |
advertiser_name |
文字列 | いいえ | 配信されたインプレッションに関連付けられている広告主オブジェクトの名前。 |
line_item_id |
int | はい | インプレッションが購入された広告申込情報の ID。 購入側の階層は、 Line Item>Campaign です。 |
line_item_name |
文字列 | いいえ | インプレッションが購入された広告申込情報の名前。 購入側の階層は、 Line Item>Campaign です。 |
campaign_id |
int | はい | インプレッションを購入したキャンペーンの ID。 |
campaign_name |
文字列 | いいえ | インプレッションを購入したキャンペーンの名前。 |
imp_type |
int | はい | 発生したインプレッションタイプの名前。 |
imp_type_id |
int | はい | サービスを提供したインプレッションの種類 (かっこ内の関連する型) の TheID: - 1 ("Blank"): クリエイティブが配信されない - 2 ("PSA"): 有効な入札がなく、既定のクリエイティブが利用できなかったため、パブリック サービスのお知らせが提供されました - 3 ("既定のエラー"): タイムアウトの問題が原因で配信された既定のクリエイティブ - 4 ("Default"): 有効な入札がなかったため、既定のクリエイティブが配信されました - 5 ("保持"): 広告主のクリエイティブがパブリッシャーのサイトで配信されました - 6 ("Resold"): 発行元の印象がサード パーティの購入者に販売されました - 7 ("RTB"): 広告主のクリエイティブがサード パーティの広告枠で配信されました - 8 ("PSA エラー"): タイムアウトの問題または既定のクリエイティブがないために提供されたパブリック サービスのお知らせ - 9 ("外部インプレッション"): インプレッション トラッカーからのインプレッション - 10 ("外部クリック"): クリック トラッカーからのクリック - 11 ("挿入"): クリエイティブはサード パーティのインベントリで配信され、ページ読み込みとセッション間で保持されます。 このインプレッション タイプは現在、Facebookニュース フィード クリエイティブに対してのみ使用できます。 |
insertion_order_id |
int | はい | インプレッションが購入された挿入注文の ID。 購入側階層は 、挿入順序>Line Item>Campaign です。 |
insertion_order_name |
文字列 | いいえ | インプレッションが購入された挿入順序の名前。 購入側階層は 、挿入順序>Line Item>Campaign です。 |
publisher_id |
int | はい | インプレッションが発生したインベントリの発行元オブジェクトの ID。 |
publisher_name |
文字列 | いいえ | インプレッションが発生したインベントリの発行元オブジェクトの名前。 |
placement_id |
int | はい | 一致する仕様を持つ広告主のクリエイティブが配信されたパブリッシャー Web サイトのプレースメントまたはオープン スロットの ID。 |
placement_name |
文字列 | いいえ | 一致する仕様を持つ広告主のクリエイティブが配信されたパブリッシャー Web サイトのプレースメントまたはオープン スロットの名前。 |
member_id |
int | はい | レポートが生成されるメンバーの ID。 |
creative_id |
int | いいえ | インプレッション用に提供されたクリエイティブの ID。 14 か月を超えるインプレッションの場合、クリエイティブはクリエイティブ ID として 0 の 1 行に集計されます。 注: 外部クリックまたはインプレッション トラッカーの場合、creative_idは "外部クリック" または "外部インプ" になります。 |
creative_name |
文字列 | いいえ | 印象に役立つクリエイティブの名前。 |
mediatype |
文字列 | いいえ | インプレッションに配信されたクリエイティブに関連付けられているメディアの種類の名前。 |
mediatype_id |
int | はい | インプレッションで配信されたクリエイティブに関連付けられているメディアタイプの ID。 |
device_type |
string | はい | インプレッションが配信されたデバイスの種類。 使用可能な値: - デスクトップ & ノート PC -錠剤 - 携帯電話 -テレビ - ゲーム コンソール - トップ ボックスを設定する - メディア プレーヤー - その他のデバイス |
day |
date | はい | オークションの日。 |
operating_system_family_id |
int | はい | インプレッションが配信されたデバイスに関連付けられているオペレーティング システム ファミリの ID。 |
operating_system_family_name |
文字列 | いいえ | インプレッションが配信されたデバイスに関連付けられているオペレーティング システム ファミリの名前。 |
split_id |
int | はい | このデータ セット内のインプレッションを購入した分割の ID。 分割は、拡張された明細にのみ適用されます。 キャンペーンを含むレポートの場合、split_id (含まれている場合) は null になります。 |
split_name |
文字列 | いいえ | このデータ セット内のインプレッションを購入した分割の名前。 分割は、拡張された明細にのみ適用されます。 キャンペーンを含むレポートの場合、split_id (含まれている場合) は null になります。 |
domain_id |
インプレッションが発生したドメインの ID。 | ||
deal_id |
配信されたインプレッションが関連付けられている取引の ID。 販売者と交渉した取引の詳細については、「Deal Buyer Access Service」を参照してください。 | ||
deal_name |
配信されたインプレッションが関連付けられている取引の名前。 | ||
supply_type |
インプレッションが発生した供給 (在庫) タイプ: -ウェブ - モバイル Web - モバイル アプリ |
||
media_type_id |
int | はい |
media_typeの ID。 |
media_type |
文字列 | いいえ | 配信されたクリエイティブの一般的な表示スタイル: -バナー -間隙 -ビデオ -テキスト -拡張 -皮膚 |
指標
| 列 | 種類 | 式 | 説明 |
|---|---|---|---|
imps |
int | 該当なし | 合計インプレッション数。 |
clicks |
int | 該当なし | クリックの合計数。 |
ctr |
double | clicks/imps | クリックスルー率 – クリック数とインプレッションの比率 (パーセンテージで表されます) |
average_viewable_duration |
double | 表示可能な期間/表示可能な Imps の合計 | IAB の視認性基準に従ってクリエイティブが表示された平均秒数。 |
total_viewable_duration |
int | 該当なし | IAB の視認性基準に従ってクリエイティブが表示された合計秒数。 |
video_completion_rate |
double | ビデオの完了率 = ビデオの完了数/合計インプレッション数 | 合計インプレッション数に対するビデオの完了率をパーセンテージで表します。 |
video_completions |
int | 該当なし | 再生時間全体で再生されたビデオ クリエイティブの合計数 |
view_measurable_imps |
int | 該当なし | 視認性のために測定されたインプレッションの合計数 |
view_measurable_rate |
double | 測定可能な Imps/Imps を表示する | 総インプレッション数のうち視認性を測定したインプレッションの割合。 |
view_rate |
double | 表示されたインプ/測定可能なインプの表示 | 視認性を測定したインプレッションの総数のうち、表示可能だったインプレッションの割合。 |
viewable_completion_rate |
double | 表示可能なビデオインプレッションと完成したビデオインプレッション数/測定可能なビデオインプレッション | 総インプレッション数に対するビュー内ビデオの完了率をパーセンテージで表します。 |
viewdef_view_rate |
double | 該当なし | 表示可能なインプレッションの割合 (メンバー レベルのカスタム定義の構成に従って、視認性を測定したインプレッションの総数に対する割合) |
viewdef_viewed_imps |
int | 該当なし | メンバー レベルのカスタム定義の構成に従って、表示可能だった測定されたインプレッションの数 (詳細については、Xandr アカウントの担当者にお問い合わせください) |
viewed_imps |
int | 該当なし | 対話型広告局 (IAB) によって定義された表示可能と見なされたインプレッションの合計数: 少なくとも 1 秒間は、クリエイティブのピクセルの 50% (または 242,500 ピクセル以上のクリエイティブの場合は 30%) を画面上のビューアーに表示できる必要があります。 |
例
JSON 形式のレポート要求を作成する
JSON ファイルには、 report_type"engagement_report_for_buyers"と、取得する列 (ディメンションとメトリック) と report_interval が含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (年、月、日) を定義し、データを返す形式 (csv、excel、または html) を指定することもできます。 JSON ファイルに含めることができるフィールドの詳細については、「 Report Service」を参照してください。
$ cat engagement_report_for_buyers
{
"report":
{
"report_type":"engagement_report_for_buyers",
"columns":[
"line_item_id",
"line_item_name",
"creative_name",
"viewable_completion_rate",
"average_viewable_duration",
"ctr",
"clicks",
"imps"
],
"report_interval":"last_7_days",
"format":"csv"
}
}
POST レポート サービスへの要求
$ curl -b cookies -c cookies -X POST -d @engagement_report_for_buyers 'https://api.appnexus.com/report'
{
"response":{
"status":"OK",
"report_id":"097f59fc3ab7d02c5d60db42081d9b69"
}
}
GET レポート サービスからのレポートの状態
レポート ID を使用して GET 呼び出しを行って、レポートの状態を取得します。
execution_statusが"ready"されるまで、このGET呼び出しを行い続けます。 次の手順で説明するように、 レポート ダウンロード サービスを使用してレポート データをファイルに保存します。
$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=097f59fc3ab7d02c5d60db42081d9b69'
{
"response":{
"status":"OK",
"report":{
"name":null,
"created_on":"2021-05-25 19:19:53",
"json_request":"{\"report\":{\"report_type\":\"engagement_report_for_buyerss\",\"columns\":[\"line_item_id\",
\"line_item_name\",\"creative_name\",\"viewable_completion_rate\",\"average_viewable_duration\",\"ctr\",\"clicks\",\"imps\"],
\"report_interval\":\"last_7_days\"}}",
"url": "report-download?id=b97897a7864dd8f34e7457226c7af592"
},
"execution_status":"ready"
}
}
GET レポート ダウンロード サービスからのレポート データ
レポート データをファイルにダウンロードするには、レポート ID を使用して別の GET 呼び出しを行いますが、今回は レポート ダウンロード サービスに呼び出します。 サービスとレポート ID は、前のGET応答の [url] フィールドにあります。 保存するファイルを特定するときは、最初のPOSTで指定した"format"のファイル拡張子を使用してください。
注:
ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTP エラー コードとメッセージが含まれます。 応答ヘッダーを公開するには、呼び出しで -i または -v を使用します。
$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/engagement_report_for_buyers.csv