デジタル プラットフォーム API - キュレーター セグメントのパフォーマンス レポート

注:

このレポートは、キュレーターのみが利用できます。

キュレーター セグメント パフォーマンス レポートは、キュレーターに、対象セグメントがキュレーションされた取引の全体的なパフォーマンスにどのように貢献しているかについての洞察を提供します。 このレポートには、トランザクションされたインプレッションに貢献したすべてのターゲット セグメント (含むと除外) に関するデータが表示されます。 キュレーターの場合、これにはキュレーションされたすべての取引アクティビティが含まれます。

レポートを取得する手順については、「 Report Service 」または次の 例 を参照してください。

時間枠

JSON 要求の report_interval フィールドは、次のいずれかに設定できます。

• last_hour
• last_48_hours
• 今日
• yesterday
• last_7_days
• month_to_date
• quarter_to_date
• last_month
• last_30_days

データ保持期間

このレポートのデータは、429 日間保持されます。

カスタムの時間枠でレポートを実行するには、レポート要求の start_date フィールドと end_date フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。

Dimensions

列	種類	フィルター?	例	説明
bidder_id	int	はい	456	トランザクションで購入した入札者の ID
bidder_name	文字列	いいえ	"That Bidder"	トランザクションで購入した入札者の名前
buyer_member_id	int	はい	789	トランザクションで購入した購入者のメンバー ID
buyer_member_name	文字列	いいえ	"That Buyer"	トランザクションで購入した購入者のメンバー名
curated_deal_id	int	はい	123	キュレーションされた取引 ID
cureated_deal_name	文字列	いいえ	"My Deal Name"	キュレーションされた取引名
curated_line_item_id	int	はい	123	キュレーションされた取引に関連付けられている取引明細項目を所有するキュレーター メンバー オブジェクトの品目 ID
curated_line_item_name	文字列	いいえ	"My Curated LI"	キュレーションされた取引に関連付けられている取引明細行品目を所有するキュレーター メンバー オブジェクトの品目名
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"
device_type_id	int	はい	1	インプレッションが配信されたデバイス タイプ ID。 使用可能な値は次のとおりです。 0 (その他のデバイス) 1 (デスクトップ & ノート PC) 2 (携帯電話) 3 (tablets) 4 (tv) 5 (ゲーム機) 6 (メディア プレーヤー) 7 (セットトップボックス)
device_type_name	string	はい	"desktops & laptops"	インプレッションが配信されたデバイス タイプ名。 使用可能な値は次のとおりです。 - "desktops & laptops" - "tablets" - "mobile phones" - "tv" - "game consoles" - "set top box" - "media players" - "other devices"
geo_country_code	string	はい	"US"	インプレッションが行われた国コード。 Xandr が広告がレンダリングされたという兆候を受け取らなかった (つまり、取引されていない) インプレッション要求の場合、国/地域の情報は提供されません。
geo_country_name	文字列	いいえ	"United States"	インプレッションが行われた国/地域名。 Xandr が広告がレンダリングされたという兆候を受け取らなかった (つまり、取引されていない) インプレッション要求の場合、国/地域の情報は提供されません。
hour	date	はい	"2020-02-01 06:00:00"	オークションの時間 注: 100 日よりも前のインプレッションの場合は、時間ではなく日が返されます。
media_type	文字列	いいえ	"banner"	このインプレッションで配信されたクリエイティブに関連付けられているメディア タイプ。 使用可能な値は次のとおりです。 - "banner" - "pop" - "interstitial" - "video" - "text" - "expandable" - "skin" - "facebook" - "image and text" - "high impact" - "native" - "audio" - "Unknown"
media_type_id	int	はい	1	このインプレッションで配信されたクリエイティブに関連付けられたメディア タイプ ID。 使用可能な値は次のとおりです。 1 (banner) 2 (pop) 3 (interstitial) 4 (video) 5 (text) 6 (展開可能) 8 (skin) 9 (facebook) 10 (画像とテキスト) 11 (強い影響) 12 (ネイティブ) 13 (オーディオ)
media_type_name	文字列	いいえ	"banner"	このインプレッションで配信されたクリエイティブに関連付けられているメディア タイプ名。 使用可能な値は次のとおりです。 - "banner" - "pop" - "interstitial" - "video" - "text" - "expandable" - "skin" - "facebook" - "image and text" - "high impact" - "native" - "audio" - "Unknown"
month	date	はい	"2020-02"	オークションの月
segment_id	int	はい	123456	インプレッションをターゲットとしたセグメントの ID。 注: このレポートを実行するキュレーターには、取引ライン アイテム オブジェクトに割り当てたセグメントのみが表示されます。 たとえば、このレポートを取得しているキュレーターには、購入しているサード パーティの販売者の取引に関連付けられたセグメントは表示されません。
segment_name	文字列	いいえ	"That Segment"	インプレッションをターゲットとしたセグメントの名前。 注: このレポートを実行するキュレーターには、取引ライン アイテム オブジェクトに割り当てたセグメントのみが表示されます。 たとえば、このレポートを取得しているキュレーターには、購入しているサード パーティの販売者の取引に関連付けられたセグメントは表示されません。
segment_owner_id	int	はい	789	対象のセグメントを所有するセグメント所有者のメンバー ID
segment_owner_name	文字列	いいえ	"That Segment Owner"	対象セグメントを所有するセグメント所有者のメンバー名
seller_member_id	int	はい	4567	キュレーションされたトランザクションが配信された販売者のメンバー ID
seller_member_name	文字列	いいえ	"That Seller"	キュレーションされたトランザクションが提供された販売者のメンバー名
supply_strategy	string	はい	"Deals"	キュレーターのインプレッションのソースに使用されるさまざまな供給チャネルを区別します。 注: 現在、キュレーターに関連するのは "Open Exchange" と "Deals" のみです。
supply_type_id	int	はい	0	レンダリングされた広告のサプライ タイプの ID。 使用可能な値は次のとおりです。 0 (web) 1 (mobile_web) 2 (mobile_app)
supply_type_name	string	はい	"web"	レンダリングされた広告のサプライ タイプの名前。 使用可能な値は次のとおりです。 - "web" - "mobile_web" - "mobile_app"
targeting_type	string	はい	"Inclusion"	セグメントが含まれるか除外されることによって、ライン アイテムのターゲティングに貢献したか。 使用可能な値は次のとおりです。 - "Inclusion" - "Exclusion"

指標

列	型	例	説明
targeted_curator_media_cost	金銭	31.513709	キュレーターがエクスチェンジの販売者に送信した支出 (セグメントによって対象となるインプレッションを介して取引された) の金額は、キュレーターの手数料とマージン (該当する場合) を差し引いたもの
targeted_curator_media_cost_ecpm	金銭	1.6654	キュレーターがエクスチェンジの販売者に送った支出額 (セグメントの対象となるインプレッションを通じて取引され、取引されたインプレッションに基づく eCPM として表される)、該当する場合はキュレーター料金およびマージンを差し引いた額
targeted_curator_revenue	金銭	48.4185	購入者がキュレーターに送った支出 (セグメントによって対象となるインプレッションを介して取引された) 金額は、購入者手数料を差し引いた金額 (該当する場合)
targeted_curator_revenue_ecpm	金銭	2.5588	購入者がキュレーターに送った支出額 (セグメントによってターゲットとなるインプレッションを介して取引され、ターゲット インプレッションに基づく eCPM として表される)、該当する場合は購入者手数料を差し引いた金額
targeted_impressions	int	18922	セグメントがターゲットとしたトランザクション済みインプレッション数
targeted_view_measured_impressions	int	17867	Xandr が対象とするセグメントの視認性を測定した取引インプレッション数
targeted_viewable_impressions	int	14135	セグメントがターゲットとした表示されたインプレッション数

例

JSON 形式のレポート要求を作成する

JSON ファイルには、取得するcolumns (サイズとメトリック) とreport_intervalだけでなく、"curator_segment_performance"のreport_typeを含める必要があります。 また、特定のディメンションをフィルター処理したり、粒度 (year、 month、 day) を定義したり、データを返す形式 (csv、 excel、 html) を指定したりすることもできます。 JSON ファイルに含めることができるフィールドの詳細については、「 レポート サービス」を参照してください。

$ cat curator_segment_performance

{
    "report": {
        "report_type": "curator_segment_performance",
        "columns": [
            "curated_deal_id",
            "cureated_deal_name",
            "segment_id",
            "segment_name",
            "targeting_type",
            "targeted_impressions",
            "targeted_curator_revenue"
        ],
        "report_interval": "today",
        "format": "csv"
    }
}

POST レポート サービスへの要求

$ curl -b cookies -X POST -d @curator_segment_performance 'https://api.appnexus.com/report'

{
    "response": {
        "status": "OK",
        "report_id": "a2c95fcff2d8759e69cec123364f9b32"
    }
}

GET レポート サービスからのレポートの状態

レポート ID を使用して GET 呼び出しを行い、レポートの状態を取得します。 execution_statusが"ready"されるまで、このGET呼び出しを続けます。 次に、次の手順で説明するように、 レポート ダウンロード サービスを使用して、レポート データをファイルに保存します。

$ curl -b cookies 'https://api.appnexus.com/report?id=a2c95fcff2d8759e69cec123364f9b32'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2020-09-04 12:46:08",
            "json_request": "{\"report\":{\"report_type\":\"curator_segment_performance\",\"columns\":[\"curated_deal_id\",\"cureated_deal_name\",\"segment_id\",\"segment_name\",\"targeting_type\",\"targeted_impressions\",\"targeted_curator_revenue\"],\"report_interval\":\"today\",\"format\":\"csv\",\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"filters\":[{\"curator_member_id\":\"12025\"}],\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1599264000,\"start_date\":1599177600,\"user_id\":\"123456\"}",
            "url": "report-download?id=a2c95fcff2d8759e69cec123364f9b32"
        },
        "execution_status": "ready"
    }
}

GET レポート ダウンロード サービスからのレポート データ

レポート データをファイルにダウンロードするには、レポート ID を使用して別の GET 呼び出しを行います。今回は レポート ダウンロード サービスに対して呼び出します。 サービスとレポート ID は、前のGET応答の url フィールドにあります。 保存するファイルを特定する際は、最初のPOSTで指定した"format"のファイル拡張子を使用してください。

注:

ダウンロード中にエラーが発生した場合、応答ヘッダーには HTTP エラー コードとメッセージが含まれます。 呼び出しで -i または -v を使用して、応答ヘッダーを公開します。

$ curl -b cookies 'https://api.appnexus.com/report-download?id=a2c95fcff2d8759e69cec123364f9b32' > /tmp/curator_segment_performance.csv

注:

XLSX および Excel ファイルとしてダウンロードする場合、レポートごとに 100,000 行の制限があります。