Digital Platform API - オフライン属性レポート

  • [アーティクル]

オフライン 属性レポートは、対象ユーザーのストア内購入に影響を与える広告申込情報のパフォーマンスを分析するために使用されます。 オフライン属性レポートには、広告申込情報でオフライン販売属性が有効になっているクライアントのみがアクセスできます。

レポートを取得する手順については、 Report Service または以下の 例 を参照してください。 このレポートでは、URL の一部として広告主 ID を指定する必要があります。例:

 https://api.appnexus.com/report?advertiser_id=ADVERTISER_ID

時間枠

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

  • カスタム
  • last_7_available_days
  • last_14_available_days
  • last_30_available_days
  • last_365_days

データ保持期間

このレポートには毎日の時間粒度があり、過去 120 日間のデータを取得できます。

注:

  • カスタム時間枠のレポートを実行するには、レポート要求の フィールド start_date と end_date フィールドを設定します。 これらのフィールドの詳細については、「 Report Service」を参照してください。
  • NCS データでは売上が発生したタイム ゾーンが使用されるため、特定のタイム ゾーンを選択することはできません。

Dimensions

Column 種類 フィルター。 例 説明
day date "2021-10-10" NCS がレポートを生成した日。 このディメンションに表示される日付は、 に表示される analysis_start_date日付と一致します。
insertion_order_id string はい "5533431" 挿入順序の ID。
insertion_order_name string はい "My IO" 挿入順序の名前。
line_item_id string はい "14545960" 明細の ID。
line_item_name string はい "NCS Line Item" 行項目の名前。
flight_id string "12396335" フライトの ID。
flight.start_date date "2021-04-16 00:00:00 UTC" フライトの開始日。
flight.end_date date "2021-04-30 23:59:59 UTC" フライトの終了日。
split_id string はい "1234" 分割の ID。
split_name string はい "my split" 分割の名前。
analysis_end_date date "2021-10-10" 各コーホートについて報告される購入間隔の最終日。
analysis_rejection_reason string "DMA minimum not met, Retailer minimum not met" 測定の要件のうち、どの要件が満たされなかったかを示すエラー。
analysis_start_date date "2021-10-03" 各コーホートについて報告される購入間隔の最初の日。
frequency_type string "weekly" この明細または分割に対して選択されたレポート頻度。
lookback_hours string "flight_lifetime" この行項目または分割に対して選択されたルックバック ウィンドウ。
product_id string "10096" 報告される製品または製品の説明に使用される製品選択 ID。
product string "BAKING SUPPLIES \| MARS INCORPORATED \| M&M MARS" 報告される製品または製品の説明に使用される製品の選択名。

指標

Column 種類 説明
imps int 配信されたインプレッションの合計数。
clicks int 記録されたクリックの合計数。
booked_revenue int 広告主から受け取った収益。
media_cost int このインベントリの購入メンバーに対するコスト。
total_cost int 報告された期間に発生したコストの合計金額。 これには一般に、予算コスト (メディア コスト、データ コスト、パートナー料金、サービス手数料、手数料) と、プラットフォームでパブリッシャーの支払いを追跡する場合のパブリッシャー収益の 2 種類のコストが含まれます。
imps_viewed int 対話型広告局 (IAB) で定義されているように表示可能と見なされるインプレッション: 少なくとも 1 秒間は、クリエイティブのピクセルの 50% (または 242,500 ピクセル以上のクリエイティブの場合は 30%) が画面にレンダリングされる必要があります。
all_outlet_adjusted_number_of_trips int 分析の開始日と終了日の間に行われた世帯別の店舗への旅行の数。 NCS には米国内の一部の店舗 (アウトレット) のデータしかないため、米国内のすべての店舗で発生した売上を考慮して売上メトリックを調整します。
all_outlet_adjusted_penetration% int 分析の開始日と終了日における製品、カテゴリ、またはブランドの侵入率。 NCS には米国内の一部の店舗 (アウトレット) のデータしかないため、米国内のすべての店舗で発生した売上を考慮して売上メトリックを調整します。

注: 侵入はブランドまたはカテゴリの人気を測定します。 特定のブランドまたは商品カテゴリを特定の期間に少なくとも 1 回購入したユーザーの数を、関連する市場の総人口のサイズで割ることによって計算されます。
all_outlet_adjusted_total_spend int 分析の開始日と終了日時に製品、カテゴリ、またはブランドに対して世帯が費やしたドルの数。 NCS には米国内の一部の店舗 (アウトレット) のデータしかないため、米国内のすべての店舗で発生した売上を考慮して売上メトリックを調整します。
video_completions int ビデオ クリエイティブの場合、ビデオ クリエイティブが完了まで表示された回数。

例

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

JSON ファイルには、 report_type"offline_attribution"と、取得する列 (ディメンションとメトリック) と が report_interval 含まれている必要があります。 また、特定のディメンションをフィルター処理し、粒度 (year、、) を定義し、monthdayデータを"format"返す対象 ("csv"、、"excel"または"html") を指定することもできます。 JSON ファイルに含めることができるフィールドの詳細については、 レポート サービスに関するページを参照してください。

$ cat report-request.json

{
    "report": {
        "report_type": "offline_attribution",
        "format": "csv",
        "report_interval": "last_365_days",
        "columns": [
            "month",
            "member_id",
            "line_item_id",
            "split_id",
            "all_outlet_adjusted_total_spend",
            "imps",
            "analysis_rejection_reason"
        ],
        "orders": [
            "member_id",
            "line_item_id",
            "split_id"
        ],
        "filters": [{
            "line_item_id": [14545960, 14545978]
        }]
    }
}

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

この例では、広告主 660 のレポートの実行を要求します。

$ curl -b cookies -c cookies -X POST -d @offline_attribution 'https://api.appnexus.com/report?advertiser_id=660'

{
    "response":{
        "status":"OK",
        "report_id":"07af1282c9485adcef49c95fa5d7496b"
    }
}

レポート ID を使用してレポート データを取得する

標準応答には、レポート データと、データをファイルに保存するために使用できるダウンロード URL が含まれます。 レポート データを含まないダウンロード URL のみを取得する場合は、クエリ文字列を渡します "without_data" 。

$ curl -b cookies -c cookies 'https://api.appnexus.com/report?id=07af1282c9485adcef49c95fa5d7496b'

{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2011-11-16 23:51:14",
            "cache_hit": false,
            "fact_cache_hit": false,
            "json_request": "{\"report\":{\"report_type\":\"offline_attribution\",\"format\":\"csv\",\"report_interval\":\"last_365_days\",\"columns\":[\"month\",\"member_id\",\"line_item_id\",\"split_id\",\"all_outlet_adjusted_total_spend\",\"imps\",\"analysis_rejection_reason\"],\"orders\":[{\"order_by\":\"member_id\",\"direction\":\"ASC\"},{\"order_by\":\"line_item_id\",\"direction\":\"ASC\"},{\"order_by\":\"split_id\",\"direction\":\"ASC\"}],\"filters\":[{\"line_item_id\":[14545960,14545978]},{\"member_id\":\"958\"}],\"grouping\":{\"additional_grouping_sets\":[],\"unselected_implicit_groupings\":[],\"additional_groups_on_bottom\":true},\"timezone\":\"UTC\",\"reporting_decimal_type\":\"decimal\",\"use_cache\":true},\"extraction_version\":\"refactored\",\"end_date\":1622678400,\"start_date\":1591142400,\"user_id\":\"46052\"}",
            "header_info": "Report type: offline_attributions\nReport ID: 5dd162b83a0417e13859e5e243844329\n",
            "data": "day,campaign,booked_revenue,imps,clicks,click_thru_pct,site_domain\u000d\u000a2011-11-12,ExampleCampaign - 1
             (123456),.000000,24,0,.000000000000000000%,aaaa.com\u000d\u000a2011-11-13,ExampleCampaign - 2 (789012),.000000,9,0,
             .000000000000000000%,bbbb.net\u000d\u000a2011-11-12,ExampleCampaign - 3 (345678),.000000,2,0,.000000000000000000%,
             ccc.com\u000d\u000a2011-11-13,ExampleCampaign - 3 (345678),.000000,2,0,.000000000000000000%,cccc.de\u000du000a
             2011-11-14,ExampleCampaign - 3 (345678),.000000,10,0,.000000000000000000%,dddd.com\u000d\u000a2011-11-13,
             ExampleCampaign - 4 (901234), 2.574900,22,3,13.636363636363636364%,aaaa.com\u000d\u000a2011-11-15,ExampleCampaign - 3
             (345678),8.583000,2431,10,.411353352529823118%,abab.com\
             ...
            "url": "report-download?id=495d03a7667bac467bb488043ae336e9"
        },
        "execution_status": "ready"
    }
}

ダウンロード URL を使用してレポート データをファイルに保存する

応答の フィールドを "url" 使用して、レポート データをファイルに保存します。 別の GET 呼び出しを行い、保存する場所とファイルを特定するだけです。 最初POSTの要求で指定した の"format"拡張子を持つファイルを必ず使用してください。

$ curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=495d03a7667bac467bb488043ae336e9' > /tmp/site_domain.csv