Digital Platform API - キュレーター分析レポート
注:
このレポートはキュレーターのみが利用できます。
キュレーター分析レポートは、キュレーションされたマーケットプレース内で需要から供給に資金がどのように流れているかについて、キュレーターに洞察を提供します。
レポートを取得する手順については、 レポート サービス または以下の 例 を参照してください。
時間枠
JSON 要求のフィールドは report_interval
、次のいずれかに設定できます。
- last_hour
- 今日
- yesterday
- month_to_date
- last_month
- 有効 期間
データ保持期間
このレポートのデータは 1100 日間保持されます。
注:
カスタム時間枠のレポートを実行するには、レポート要求の フィールド start_date
と end_date
フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。
45 日前より前に発生した日付を含む時間範囲
を に"lifetime"
設定して report_interval
Curator Analytics レポートを作成すると、レポートは (含まれているメトリックに関係なく) "リソース集中型" レポートの特別なキューに追加されます。 その結果、レポートの完了に通常より時間がかかる場合があります。 さらに、これらのリソースを集中的に使用するレポートは、要求されるデータの量が原因で、完了する前に失敗する可能性があります。 レポートの完了に失敗した場合は、通知を受け取ります。 レポート要求が失敗した場合、または削除された場合は、次のことができます。
- 後でレポートを再実行します。
- 以外
curator_analytics
のレポートの種類を使用します。 - レポートの構成方法 (可能な場合) を変更して、45 日前より前の日付を含めないようにします。
Dimensions
Column | 種類 | フィルター。 | 例 | 説明 |
---|---|---|---|---|
bidder_id |
int | はい | 456 |
トランザクションで購入した入札者の ID |
bidder_name |
文字列 | いいえ | "That Bidder" |
トランザクションで購入した入札者の名前 |
billing_currency |
string | はい | "USD" |
通貨Xandrはでキュレーターに請求します |
brand_id |
int | はい | 1234 |
キュレーションされた取引で配信されたクリエイティブに関連付けられているブランド ID |
brand_name |
文字列 | いいえ | "That Brand" |
キュレーションされた取引で配信されたクリエイティブに関連付けられているブランド名 |
buyer_member |
文字列 | いいえ | "That Buyer (789)" |
メンバー ID を角かっこで囲んでトランザクションで購入した購入者のメンバー名 |
buyer_member_id |
int | はい | 789 |
取引で購入した購入者のメンバー ID |
buyer_member_name |
文字列 | いいえ | "That Buyer" |
取引で購入した購入者のメンバー名 |
curated_deal |
文字列 | いいえ | "My Deal Name (123)" |
取引 ID を角かっこで囲んだ精選された取引名 |
curated_deal_advertiser_id |
int | はい | 123 |
キュレーションされた取引に関連付けられた取引明細を所有するキュレーター メンバー オブジェクトの広告主 ID |
curated_deal_advertiser_name |
文字列 | いいえ | "That Advertiser" |
キュレーションされた取引に関連付けられた取引明細を所有するキュレーター メンバー オブジェクトの広告主名 |
curated_deal_id |
int | はい | 123 |
キュレーションされた取引 ID |
curated_deal_insertion_order_id |
int | はい | 123 |
キュレーションされた取引に関連付けられた取引明細を所有するキュレーター メンバー オブジェクトの挿入順序 ID |
curated_deal_line_item_id |
int | はい | 123 |
キュレーションされた取引に関連付けられた取引明細を所有するキュレーター メンバー オブジェクトの明細 ID |
curated_deal_insertion_order_name |
文字列 | いいえ | "IO Name" |
キュレーションされた取引に関連付けられた取引明細を所有するキュレーター メンバー オブジェクトの挿入順序名 |
curated_deal_line_item_name |
文字列 | いいえ | "My Curated LI" |
キュレーションされた取引に関連付けられた取引明細を所有するキュレーター メンバー オブジェクトの明細項目名 |
curated_deal_name |
文字列 | いいえ | "My Deal Name" |
キュレーションされた取引名 |
curator_margin_type |
int | 不要 | "Percent" |
余白の種類 (キュレーターに行項目に関連付けられている余白がある場合)。 使用可能な値: - "Unknown" - "Percent" - "CPM" |
curator_margin_type_filterable |
int | はい | 1 |
フィルター可能な余白の種類 (キュレーターに行項目に関連付けられている余白がある場合)。 使用可能な値:0 (不明)1 (パーセント)2 (CPM) |
curator_member |
文字列 | いいえ | "My Account (123)" |
メンバー ID が角かっこで囲まれたキュレーター アカウントのメンバー名 |
curator_member_id |
int | はい | 123 |
キュレーター アカウントのメンバー ID |
curator_member_name |
文字列 | いいえ | "My Account" |
キュレーター アカウントのメンバー名 |
day |
date | はい | "2020-02-01" |
オークションの日 |
device_type |
string | はい | "desktops & laptops" |
インプレッションが配信されたデバイスの種類。 使用可能な値は次のとおりです。 - "desktops & laptops" - "tablets" - "mobile phones" - "tv" - "game consoles" - "set top box" - "media players" - "other devices" |
geo_country |
string | はい | "US" |
印象が行われた国。 Xandr が広告がレンダリングされたことを示さなかったインプレッションリクエスト (つまり、非トランザクション) の場合、国情報は提供されません。 |
hour |
date | はい | "2020-02-01 06:00:00" |
オークションの時間。 注: 100 日を超えるインプレッションの場合、1 時間ではなく日が返されます。 |
media_type |
文字列 | いいえ | "banner" |
この印象に役立つクリエイティブに関連付けられているメディアの種類。 使用可能な値は次のとおりです。 - "banner" - "pop" - "interstitial" - "video" - "text" - "expandable" - "skin" - "facebook" - "image and text" - "high impact" - "native" - "audio" - "Unknown" |
member_currency |
string | はい | "USD" |
キュレーターメンバーの座席に関連付けられている通貨 |
member_id |
int | はい | 789 |
キュレーター アカウントのメンバー ID |
mobile_application_id |
string | はい | "343200656" (iOS) または"com.rovio.angrybirds" (Android) |
このインプレッションで配信されたクリエイティブに関連付けられているモバイル アプリケーション ID |
mobile_application_name |
文字列 | いいえ | "Angry Birds" |
このインプレッションで配信されたクリエイティブに関連付けられているモバイル アプリケーション名 |
month |
date | はい | "2020-02" |
オークションの月 |
placement |
文字列 | いいえ | "Ivillage 160x600 (456)" |
厳選されたトランザクションがプレースメントの ID を角かっこで囲んで処理した販売者のプレースメント名 |
placement_group_id |
int | はい | 4321 |
キュレーションされたトランザクションが処理された販売者の配置グループ ID |
placement_group_name |
文字列 | いいえ | "Placement Group Name" |
キュレーションされたトランザクションが処理された販売者の配置グループ名 |
placement_id |
int | はい | 456 |
キュレーションされたトランザクションが処理された販売者の配置 ID |
placement_name |
文字列 | いいえ | "Ivillage 160x600" |
キュレーションされたトランザクションが処理された販売者の配置名 |
publisher_id |
int | はい | 321 |
キュレーションされたトランザクションが処理された販売者の発行元 ID |
publisher_name |
string | はい | "Newscorp" |
キュレーションされたトランザクションが処理された販売者の発行元名 |
seller_deal |
文字列 | いいえ | "That Seller Deal (6543)" |
販売者の取引 ID を角かっこで囲んだキュレーション取引に含まれている販売者取引名 注:該当する場合は、すべてのキュレーション取引に販売者取引が含まれるわけではないので |
seller_deal_id |
int | はい | 6543 |
キュレーション取引に含まれている販売者取引 ID 注:該当する場合は、すべてのキュレーション取引に販売者取引が含まれるわけではないので |
seller_deal_name |
文字列 | いいえ | "That Seller Deal" |
キュレーションされた取引に含まれている販売者の取引名 注:該当する場合は、すべてのキュレーション取引に販売者取引が含まれるわけではないので |
seller_deal_type_id |
int | いいえ | 2 |
キュレーションされた取引に含まれている販売者取引の種類の ID (該当する場合)。 使用可能な値は次のとおりです。1 (公開オークション)2 (プライベート オークション) |
seller_deal_type_name |
string | はい | "Private Marketplace" |
該当する場合は、キュレーション取引に含まれる販売者取引の種類の名前。 使用可能な値は次のとおりです。 - "---" (公開オークション)- "Private Marketplace " (プライベート オークション) |
seller_member_id |
int | はい | 4567 |
キュレーションされた取引が行われる販売者のメンバー ID |
seller_member_name |
文字列 | いいえ | "That Seller" |
キュレーションされた取引が行われる販売者のメンバー名 |
site_domain |
文字列 | いいえ | "bestsiteever.com" |
キュレーションされたトランザクションが処理されたサイト ドメイン/アプリ |
size |
string | はい | "320x50" |
クリエイティブのサイズ |
video_context |
string | はい | "pre-roll" |
キュレーションされたトランザクションが処理されるビデオ形式の種類。 使用可能な値は次のとおりです。 - "unknown" - "pre-roll" - "mid-roll" - "post-roll" - "outstream" |
video_content_duration |
string | はい | "Short-Form" |
秒単位のコンテンツの長さ (2 つのオプション: short (480s 未満)、long (480s 以上))。 |
content_delivery_type |
string | はい | "VOD" |
ストリーミング コンテンツ配信の種類。 |
video_content_genre |
string | はい | "Action" |
広告が再生されるプログラムのメインジャンル。 |
video_program_type |
string | はい | "Movie" |
広告が再生されるプログラムの上位レベルの分類。 |
video_content_rating |
string | はい | "Children(7+)" |
コンテンツのレーティングの種類。 |
指標
注:
クリックメトリックは、Microsoft Invest を通じて購入したインプレッションに対して利用できます。 ビデオ メトリックは、DSP を通じて購入したインプレッションで利用できます。
Column | 型 | 例 | 式 | 説明 |
---|---|---|---|---|
curator_margin |
お 金 | 2.57676 |
curator_margin | キュレーターが取引に対して行う利益 注: 割合として取得すると、キュレーターマージンはキュレーター収益から計算されます。 |
curator_net_media_cost |
お 金 | 20.6138056 |
curator_revenue - curator_margin - curator_tech_fees | キュレーターが交換販売者に送信する支出額、キュレーターの手数料、マージン (該当する場合)。 これは、売り手の総収益と同じです。これには販売者手数料が含まれます。 |
curator_revenue |
お 金 | 25.767257 |
curator_revenue | 購入者がキュレーターに送付する支出額(該当する場合は購入者手数料の純額)。 これは、買い手のメディアコストと同じであり、買い手手数料を除きます。 |
curator_tech_fees |
お 金 | 2.5767257 |
curator_tech_fees | Xandr がトランザクションのキュレーターに請求する料金 |
curator_total_cost |
お 金 | 23.1905313 |
curator_revenue - curator_margin | キュレーターが交換業者と交換業者に送る支出額、キュレーターマージンの純額、キュレーター手数料の総額 |
imps |
int | 2340 |
Imps | 配信されたインプレッションの数 |
viewdef_viewed_imps |
int | 1638 |
viewdef_viewed_imps | 購入者の視認性の定義に従って、表示可能であった測定されたインプレッションの数 |
viewdef_view_rate |
double | 0.70 |
viewdef_view_rate | 購入者の視認性の定義に従って、表示可能であった測定されたインプレッションの数を、測定されたインプレッション数で割った値 |
viewed_imps |
int | 1872 |
viewed_imps | IAB Viewability 定義に従って表示可能だった測定されたインプレッションの数。これは、1 秒間にピクセルの 50% が表示されている場合にインプレッションが表示可能であることを示します |
view_measurable_imps |
int | 172 |
view_measurable_imps | 視認性のために測定されたインプレッションの合計数。 |
clicks |
int | 7 |
クリック | すべてのインプレッションに対するクリックの合計数。 Microsoft Invest では、すべてのメディアの種類からのクリックがサポートされています。 外部 DSP の場合、ネイティブ メディアとビデオ メディアの種類からのクリックのみがサポートされます。 |
ctr |
double | 0.3 |
clicks/imps | クリック数と Imps の比率。 |
buyer_cpc |
お 金 | 3.68 |
curator_revenue/クリック数 | キュレーター収益をクリック数で割った。 |
video_errors |
int | 45 |
video_errors | エラーが発生した回数の合計。 |
video_starts |
int | 2335 |
video_starts | ビデオ クリエイティブの最初のセグメントがダウンロードされ、開始された合計回数。 |
video_start_rate |
double | 0.99786 |
video_starts/imps | ビデオ開始と Imps の比率。 |
video_skips |
int | 12 |
video_skips | ユーザーがビデオをスキップした回数の合計。 |
video_skip_rate |
double | 0.0051282 |
video_skips/imps | ビデオ スキップと Imps の比率。 |
video_25_pcts |
int | 2100 |
video_25_pcts | ビデオが再生時間全体の 25% を完了した合計回数。 |
video_50_pcts |
int | 2000 |
video_50_pcts | ビデオが再生時間全体の 50% を完了した合計回数。 |
video_75_pcts |
int | 1900 |
video_75_pcts | ビデオが再生時間全体の 75% を完了した合計回数。 |
video_completions |
int | 1800 |
video_completions | ビデオが再生された再生時間の合計回数。 |
video_completion_rate |
double | 0.76923 |
video_completions/imps | ビデオ補完と Imps の比率。 |
buyer_cost_per_video_complete |
お 金 | 0.014315 |
curator_revenue/video_completions | キュレーター収益をビデオコンプリートで割った。 |
buyer_cpm |
お 金 | 11.01164 |
curator_revenue/imps * 1000 | キュレーター収益は、CPM として表される Imps で割った値です。 |
例
JSON 形式のレポート要求を作成する
JSON ファイルには、 report_type
"curator_analytics"
と、取得する columns
(ディメンションとメトリック) が report_interval
含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (year
、、) を定義し、month
day
データを返す形式 (csv
、、excel
またはhtml
) を指定することもできます。 JSON ファイルに含めることができるフィールドの詳細については、 レポート サービスに関するページを参照してください。
$ cat curator_analytics
{
"report": {
"columns": [
"hour",
"buyer_member_name",
"curated_deal",
"imps",
"curator_revenue",
"curator_margin"
],
"format": "csv",
"report_interval": "today",
"report_type": "curator_analytics"
}
}
POST
レポート サービスへの要求
$ curl -b cookies -X POST -d @curator_analytics 'https://api.appnexus.com/report'
{
"response":{
"status":"OK",
"report_id":"6b177543a9411ffa67b09bdf5e76cac1"
}
}
GET
レポート サービスからのレポートの状態
レポート ID を GET
使用して呼び出しを行って、レポートの状態を取得します。 が "ready"
になるまでこのGET
呼び出しをexecution_status
続けます。 次の手順で説明するように、 レポート ダウンロード サービスを使用してレポート データをファイルに保存します。
$ curl -b cookies 'https://api.appnexus.com/report?id=6b177543a9411ffa67b09bdf5e76cac1'
{
"response":{
"status":"OK",
"report":{
"name":null,
"created_on":"2020-08-25 13:03:37",
"json_request":"{\"report\":{\"report_type\":\"curator_analytics\",\"columns\":[\"hour\",\"buyer_member_name\",\"curated_deal\",\"imps\",\"curator_revenue\",\"curator_margin\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"member_id\":\"123456\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1598400000,\"start_date\":1598313600,\"user_id\":\"987654\"}",
"url": "report-download?id=6b177543a9411ffa67b09bdf5e76cac1"
},
"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=6b177543a9411ffa67b09bdf5e76cac1' > /tmp/curator_analytics.csv
注:
XLSX および Excel ファイルとしてダウンロードする場合、レポートごとに 100,000 行の制限があります。