キー値分析レポートには、お客様のネットワークで定義されたターゲティング キーと値に関連付けられた情報が表示されます。
キー/値ターゲティングを使用したインプレッションは、キー名の kw_ プレフィックスを含むプレースメント タグによって記録されたインプレッションについてのみ配信および報告されます。 たとえば、 keyname=value1 を含むプレースメント タグは配信されないため、ログに記録されません。一方、 kw_keyname=value1 を含む配置タグは配信され、ログに記録されます。 これは、/tt、/ttj、/fpt、/jpt、/pt、/ptv、/ssptv、/mtj、/map、/mob、/prebid/amp、/vmap、/ssvmap タグ タイプを使用したGETベースのクエリ文字列広告呼び出しに適用されます。
注:
AppNexus 販売者タグ
販売者タグを使用する場合は、kw_ プレフィックスを省略します。 AST では、(ut/v3) リクエストの本文に キーワード (keyword) オブジェクトが含まれているため、プレフィックスは必要ありません。 Prebid (ut/v3/prebid、openrtb2/prebid、prebid/lfv) および OpenRTB (openrtb2) からの他の POST ベースのリクエスト本文広告呼び出しについても同様です。
キー/バリュー ターゲットからのインプレッションのすべてがレポートに反映されるわけではありません。 含めるには、ターゲットは次の基準を満たしている必要があります。
- キーは事前定義する必要があります。 詳細については、UI のター ゲティング キーと値の事前定義 ページを参照してください。
- 値は事前定義する必要があります または 値は、少なくとも 1 つのライン アイテムまたはキャンペーンでターゲットとする必要があります。
- 値は、数値の範囲 (より大きいまたはより小さい) ではありません。
- 値にワイルドカードは含まれません。
時間枠
JSON 要求の report_interval フィールドは、次のいずれかに設定できます。
- 今日
- yesterday
- last_24_hours
- last_48_hours
- last_7_days
- last_month
- month_to_date
- quarter_to_date
注:
カスタムの時間枠でレポートを実行するには、レポート要求の start_date フィールドと end_date フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。
45 日以上前の日付
範囲フィールドをカスタム (終了日が今日から 45 日以上) に設定してキー バリュー分析レポートを作成した場合、そのレポート (含まれているメトリックに関係なく) は "リソース集中型" レポート用の特別なキューに追加されます。 その結果、レポートの完成に通常より時間がかかる場合があります。 また、このリソースを大量に消費するレポートは、要求されるデータの量が原因で、完了する前に失敗する可能性があります。 レポートを完了できなかった場合は、通知が届きます。 レポート要求が失敗した場合は、次の操作を実行できます。
- 後でレポートを再実行します。
- [キー値分析] 以外のレポートの種類を使用する。
- レポートの構成方法を変更して (可能であれば)、45 日より前の日付を含めないようにします。
45 日前を超える日付を含む Key Value Analytics レポートを頻繁に要求する場合は、API を介してこれらのレポートを実行し、データをキャッシュし、一括レポート フィードまたはログ レベルのデータ フィード - アーカイブを使用することを検討する必要がある場合があります。 これらの問題を回避するためにレポートを変更する方法の詳細については、UI の [ディメンション、メトリック、フィルター処理、グループ化 ] ページを参照してください。
データ保持期間
このレポートのデータの保持期間は次のとおりです。
- 時間単位のリテンション期間: 100 日
- 1 日あたりのリテンション期間: 500 日
Dimensions
| 列 | 種類 | フィルター? | 例 | 説明 |
|---|---|---|---|---|
month |
date | 不要 | "2010-02" |
オークションの月。 |
day |
date | 不要 | "2010-02-01" |
オークション当日。 |
hour |
date | 不要 | "2010-02-01 06:00:00" |
オークションの時間。 メモ: 過去 100 日を超えるインプレッションの場合は、時刻ではなく日が返されます。 |
buyer_member_id |
int | はい | 123 |
購入メンバーの ID。 インプレッションが購入されていない場合、このフィールドには 229 = PSA、 0 = Blank、または 319 = Default のいずれかの値が表示されます。 |
buyer_member_name |
文字列 | いいえ | "My Network" |
購入メンバーの名前。 メモ: 名前は "Default" または "Default Error" の場合があります。これは、インプレッションの購入者が存在せず、既定のクリエイティブが提供されたことを意味します。 |
buyer_member |
文字列 | いいえ | "My Network (123)" |
非推奨です (2016 年 10 月 17 日現在)。 |
seller_member_id |
int | はい | 456 |
販売メンバーの ID。 |
seller_member_name |
文字列 | いいえ | "That Seller" |
販売メンバーの名前。 |
seller_member |
文字列 | いいえ | "That Seller (456)" |
非推奨です (2016 年 10 月 17 日現在)。 |
placement_id |
int | はい | 1212 |
配置の ID。 メモ: 100 日を超えるインプレッションの場合、プレースメントは -1 を placement_id として 1 つの行に集計されます。 |
placement_name |
文字列 | いいえ | "lvillage 160x600" |
プレースメントの名前。 メモ: 100 日を超えるインプレッションの場合、プレースメントは "All placement data older than 100 days" を placement_nameとして 1 つの行に集約されます。 |
placement |
文字列 | いいえ | "lvillage 160x600 (1212)" |
非推奨です (2016 年 10 月 17 日現在)。 |
advertiser_id |
int | はい | 789 |
広告主の ID。 値が 0 の場合は、インプレッションが外部購入者によって購入されたか、既定または PSA が表示された場合です。 |
advertiser_name |
文字列 | いいえ | "AdvertiserA" |
広告主の名前。 |
advertiser |
文字列 | いいえ | "AdvertiserA (789)" |
非推奨です (2016 年 10 月 17 日現在)。 |
line_item_id |
int | はい | 1122 |
品目の ID。 |
line_item_name |
文字列 | いいえ | "Line Item 1" |
明細行品目の名前。 |
line_item |
文字列 | いいえ | "Line Item 1 (1122)" |
非推奨です (2016 年 10 月 17 日現在)。 |
campaign_id |
int | はい | 222 |
キャンペーンの ID。 |
campaign_name |
文字列 | いいえ | "Default Campaign" |
キャンペーンの名前。 |
campaign |
文字列 | いいえ | "Default Campaign (789)" |
非推奨です (2016 年 10 月 17 日現在)。 |
split_id |
Int | はい | 342 |
このデータ セットのインプレッションを購入した分割の ID。 分割は、拡張広告申込情報にのみ適用されます。 キャンペーンを含むレポートでは、 split_id (含まれている場合) が null されます。 |
split_name |
string | はい | "Mobile Split A" |
このデータ セットのインプレッションを購入した分割の名前。 分割は、拡張広告申込情報にのみ適用されます。 キャンペーンを含むレポートでは、 split_name (含まれている場合) が nullされます。 |
publisher_id |
int | はい | 555 |
発行元の ID。 |
publisher_name |
文字列 | いいえ | "PublisherA" |
発行元の名前。 |
publisher |
文字列 | いいえ | "PublisherA (555)" |
非推奨です (2016 年 10 月 17 日現在)。 |
geo_country |
string | はい | "US" |
対象の国/地域のコード。 |
imp_type |
string | はい | "Blank" |
インプレッションのタイプ。 有効な値については、「 imp_type_id」を参照してください。 |
imp_type_id |
int | はい | 1 |
インプレッションの種類の ID。 使用可能な値 (かっこ内の関連付けられた型): - 1 ("Blank"): クリエイティブは提供されません。- 2 ("PSA"): 有効な入札額がなく、既定のクリエイティブが提供されていなかったために提供された公共サービス広告。- 3 ("Default Error"): タイムアウトの問題で提供される既定のクリエイティブ。- 4 ("Default"): 有効な入札単価がなかったために提供されたデフォルトのクリエイティブ。- 5 ("保持"): 発行元のサイトで提供される広告主のクリエイティブ。- 6 ("転売"): パブリッシャーのインプレッションが第三者の購入者に販売されました。- 7 ("RTB"): サードパーティのインベントリで提供される広告主のクリエイティブ。- 8 ("PSA エラー"): タイムアウトの問題または既定のクリエイティブがないために配信された公共サービスアナウンス。- 9 ("外部インプレッション"): インプレッション トラッカーからのインプレッション。- 10 ("外部クリック"): クリック トラッカーからのクリック。メモ: RTB オークションはレポートに含まれません。 imp_type_id
=
7 のインプレッションは報告されません。 |
creative_id |
int | はい | 444 |
クリエイティブの ID。 注: - 100 日を超えるインプレッションの場合、クリエイティブは 0 を creative_idとして 1 つの行に集約されます。- 外部クリックまたはインプレッション トラッカーの場合、 creative_id は "External Clicks" または "External Imps"になります。 |
creative_name |
文字列 | いいえ | "Q1 2017 728x90" |
クリエイティブの名前。 - 100 日を超えるインプレッションの場合、クリエイティブは "All creative data older than 100 days" を creative_nameとして 1 つの行に集約されます。- 外部クリックまたはインプレッション トラッカーの場合、creative_nameは "External Clicks" または "External Imps"になります。 |
creative |
文字列 | いいえ | "Q1 2017 728x90 (444)" |
非推奨です (2016 年 10 月 17 日現在)。 |
size |
string | はい | "728x90" |
配信されるプレースメント/クリエイティブのサイズ。 |
advertiser_currency |
string | はい | "USD" |
広告主が使用する通貨。 |
insertion_order_id |
int | はい | 321 |
インプレッションを購入したキャンペーンに関連付けられた広告掲載オーダーの ID。 |
campaign_group_id |
int | はい | 432 |
インプレッションのキャンペーン グループ ID。 |
site_id |
int | はい | 765 |
サイトの ID。 メモ: 過去 100 日を超えるインプレッションの場合、 site_id は 0になります。 |
site_name |
文字列 | いいえ | "Site 1" |
サイトの名前。 |
site |
文字列 | いいえ | "Site 1 (765)" |
非推奨です (2016 年 10 月 17 日現在)。 |
publisher_currency |
金銭 | はい | "EUR" |
発行元が使用する通貨。 |
key_name |
string | はい | "fruit" |
ターゲティング キーの名前。 |
key_value |
string | はい | "apple" |
ターゲティング キーに関連付けられた値。 |
key_name_label |
string | はい | "fruit eaten by customer" |
キーのラベル。 ラベルは、キー名のよりわかりやすいバージョンにすることができます。 |
key_value_label |
string | はい | "green or red apples" |
値のラベル。 ラベルは、キー値のよりわかりやすいバージョンにすることができます。 |
指標
| 列 | 型 | 例 | 式 | 説明 |
|---|---|---|---|---|
imps |
int | 234123 |
imps | インプレッションの合計数。 |
clicks |
int | 545 |
クリック数 | クリックの合計数。 |
ctr |
double | 0.2327836 |
クリック数/インプ | クリックスルー率 – インプレッションに対するクリック数の比率を割合で表します。 |
booked_revenue |
金銭 | 150.00 |
booked_revenue | 直接の広告主を通じて予約された合計収益。 |
reseller_revenue |
金銭 | 100.00 |
reseller_revenue | 直接パブリッシャーを通じて再販されたインプレッションの合計収益。 |
revenue |
金銭 | 250.00 |
booked_revenue + reseller_revenue | 合計収益。 |
rpm |
金銭 | 1.25 |
収益 / 1000 INPS | インプレッション 1,000 回あたりの収益 (デフォルト、PSA、エラーを含む)。 これらのインプレッション タイプの詳細については、「 imp_type_id」を参照してください。 |
booked_revenue_dollars |
金銭 | 500.00 |
booked_revenue_dollars | このネットワークがインプレッションで獲得した金額。 |
imps_blocklisted |
int | 20 |
imps_blocklisted | サイトがブロックリストに含まれていたために提供されなかったインプレッションの数。 |
total_conversions |
int | 5 |
total_conversions | 表示後とクリック後のコンバージョンの合計数。 |
conversions_rate |
double | 0.000221877080097626 |
total_conversions / imps | インプレッションに対するコンバージョン率。 |
cpm |
金銭 | 1.66051685393258 |
(コスト/インプ) x 1000 | インプレッション 1,000 回あたりのコスト。 |
post_view_convs |
int | 2 |
post_view_convs | 記録された視聴後のコンバージョンの合計数。 |
post_view_convs_rate |
double | 0.00013 |
post_view_convs / imps | インプレッションに対するポストビュー コンバージョンの割合。 |
post_click_convs |
int | 3 |
post_click_convs | 記録されたクリック後のコンバージョンの合計数。 |
post_click_convs_rate |
double | 0.0002 |
post_click_convs / imps | インプレッションに対するクリック後のコンバージョンの割合。 |
imps_master_creative |
int | 1276 |
imps_master_creative | ページレベルのロードブロッキングにおけるマスター クリエイティブからのインプレッションの合計数。 メモ: このメトリックはアルファ テスト段階であり、すべてのお客様が利用できるわけではありません。 |
例
JSON レポート要求を作成する
JSON ファイルには、取得する列 (ディメンションとメトリック) とreport_intervalだけでなく、"key_value_analytics"のreport_typeを含める必要があります。 また、特定のディメンションでフィルター処理したり、粒度 (year、 month、 day) を定義したり、データを返す "format" ("csv"、 "excel"、 "html") を指定したりすることもできます。 JSON ファイルに含めることができるフィールドの詳細については、「 レポート サービス」を参照してください。
$ cat key_value_analytics
{"report":
{
"report_type":"key_value_analytics",
"columns":[
"hour",
"seller_member_id",
"key_name",
"key_name_label",
"key_value",
"key_value_label",
"imps",
"clicks",
"revenue",
"ctr"
],
"report_interval":"last_48_hours",
"format":"csv"
}
}
POST
リクエストをレポート サービスに送信します
POST レポート ID を取得するための JSON 要求。
$ curl -b cookies -X post -d @key_value_analytics "https://api.appnexus.com/report?advertiser_id=123"
{
"response":{
"status":"OK",
"report_id":"09b6979a6a4c3805bdac8921378d3622"
}
}
GET レポート サービスからのレポートの状態
レポート ID を使用して GET 呼び出しを行い、レポートの状態を取得します。
execution_statusが"ready"されるまで、このGET呼び出しを続けます。 次に、次の手順で説明するように、 レポート ダウンロード サービスを使用して、レポート データをファイルに保存します。
$ curl -b cookies 'https://api.appnexus.com/report?id=09b6979a6a4c3805bdac8921378d3622'
{
"response":{
"status":"OK",
"report":{
"name":null,
"created_on":"2016-12-11 19:15:48",
"json_request": "{\"report\":{\"report_type\":\"key_value_analytics\",
\"columns\":[\"hour\",\"seller_member_id\",
\"key_name\",\"key_name_label\",\"key_value\",\"key_value_label\",
\"imps\",\"clicks\",\"revenue\",\"ctr\"],
\"report_interval\":\"last_48_hours\",\"format\":\"csv\",\"filters\":[{\"advertiser_id\":\"123\"}]}}",
"url":"report-download?id=b97897a7864dd8f34e7457226c7af592"
},
"execution_status":"ready"
}
}
GET レポート ダウンロード サービスからのレポート データ
レポート データをファイルにダウンロードするには、レポート ID を使用して別の GET 呼び出しを行います。今回は レポート ダウンロード サービスに対して呼び出します。 サービス ID とレポート ID は、前回のGET呼び出しへの応答の url フィールドにあります。 保存するファイルを特定する際は、初期 POSTで指定したファイル形式の拡張子を使用してください。
注:
ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTP エラー コードとメッセージが含まれます。 呼び出しで -i または -v を使用して、応答ヘッダーを公開します。
curl -b cookies 'https://api.appnexus.com/report-download?id=b97897a7864dd8f34e7457226c7af592' > /tmp/key_value_analytics.csv
注:
XLSX および Excel ファイルとしてダウンロードする場合、レポートごとに 100,000 行の制限があります。