転送元 - アドエビス

Prev Next
This content is currently unavailable in English. You are viewing the default (Ja - 日本語) version.

本ページでは、アドエビスからデータを取得するための設定(転送設定)について説明します。
接続に関する設定については、接続情報 - アドエビスを参照ください。

アドエビスAPIを利用して、アドエビスの管理画面の各分析画面に相当するレポートを取得します。

利用上の注意・制約

データ取得期間

1回の転送で指定できるデータ取得期間は、最長1年です。
1年を超える期間を指定すると、アドエビスAPIがエラー(DURATION_OVER)を返し、転送が失敗します。

データの反映タイミング

アドエビスでは、機能によってデータの反映時間が異なります。また、媒体シンクを利用している場合は、過去のデータが上書きされます。
取得するタイミングや取得し直す期間については、AD EBiS サポートサイト - [設定]アドエビスAPI ご利用方法を参照ください。

過去のデータを取得し直す場合は、データ取得期間の開始日をカスタム変数で指定します。
取得し直した期間のデータが転送先で重複しないよう、転送先の設定に注意してください。

設定項目

STEP1 基本設定

項目名 必須 デフォルト値 説明
データ取得期間の開始日 ✓ - 取得する期間の開始日をYYYY-MM-DD形式で入力します。
カスタム変数を利用できます。
データ取得期間の終了日 ✓ - 取得する期間の終了日をYYYY-MM-DD形式で入力します。
カスタム変数を利用できます。
開始日から終了日までは、最長1年です。
レポートタイプ ✓ カテゴリ分析 取得するレポートを、以下から選択します。
  • カテゴリ分析
  • 詳細分析
  • 期間分析
  • コンバージョン属性
コンバージョン属性では、コンバージョンの日付で期間を絞り込みます。
各レポートで取得する列は、取得対象を参照ください。
対象チャネル ✓ 広告 集計するチャネルを、以下から選択します。
  • 広告:広告クリックのみを集計します。
  • 全トラフィック:広告クリック・自然検索・外部リンク・ダイレクトを集計します。
集計単位 ✓ 日 レポートタイプで期間分析を選択した場合に表示されます。
集計する単位を、日・月・曜日・時間帯から選択します。
集計軸 ✓ アドエビス項目で集計 集計の軸を選択したうえで、行を分ける項目を選択します。
  • アドエビス項目で集計:カテゴリや広告グループなど、アドエビスの項目で集計します。
  • 媒体項目で集計:媒体キャンペーンや媒体広告グループなど、広告媒体側の項目で集計します。
選択できる項目は、集計軸で選択できる項目を参照ください。
フィルタ - - 取得するデータを絞り込む条件を設定できます。
詳しくは、フィルタの設定を参照ください。
ソート指定 - - 並べ替えに使う項目と、順序(昇順・降順)を選択できます。順序の初期値は昇順です。

集計軸で選択できる項目

集計軸では、集計の軸(アドエビス項目で集計・媒体項目で集計)を選んだうえで、行を分ける項目を選択します。
選択できる項目は、レポートタイプ・集計軸・対象チャネルの組み合わせによって異なります。

各項目は、画面の選択肢に「ad_id - 広告ID」の形式で表示されます。
以下の表では、ad_idのような項目名で記載します。

レポートタイプ・集計軸・対象チャネルを切り替えると、選択できる項目がすべて選択された状態に戻ります。
一部の項目だけを使う場合は、切り替えたあとに選び直してください。

カテゴリ分析

1つ以上の項目を選択する必要があります。

集計軸 選択できる項目
アドエビス項目で集計 category・ad_group1・ad_group2・agency
媒体項目で集計 sync_category・media_side_campaign・media_side_group・agency

詳細分析

一部の項目は、必ず含まれます。
必ず含まれる項目は、選択欄の上に表示され、外せません。

集計軸 対象チャネル 必ず含まれる項目 選択できる項目
アドエビス項目で集計 広告 ad_id・ad_name category・ad_group1・ad_group2・ad_note・ad_date・agency・terminal_type・landing_page_domain・landing_page_url
アドエビス項目で集計 全トラフィック category・ad_id・ad_name ad_group1・ad_group2・ad_note・ad_date・agency・terminal_type・landing_page_domain・landing_page_url
媒体項目で集計 広告 media_side_ad_id・media_side_ad_name sync_category・media_side_campaign・media_side_group・agency・terminal_type・landing_page_domain・landing_page_url
媒体項目で集計 全トラフィック sync_category・media_side_ad_id・media_side_ad_name media_side_campaign・media_side_group・agency・terminal_type・landing_page_domain・landing_page_url

期間分析

集計軸 選択できる項目
アドエビス項目で集計 date・category・ad_group1・ad_group2・ad_id・ad_name・ad_note・ad_date・agency・terminal_type・landing_page_domain・landing_page_url
媒体項目で集計 date・sync_category・media_side_campaign・media_side_group・media_side_ad_id・media_side_ad_name・agency・terminal_type・landing_page_domain・landing_page_url

コンバージョン属性

集計軸によらず、選択できる項目はありません。
1件のコンバージョンが1行になります。

フィルタの設定

フィルタでは、1行に1つの条件を設定します。
複数の行を追加できます。

項目名 必須 説明
項目 ✓ 絞り込みに使う項目を選択します。
選択できる項目は、レポートタイプ・集計軸・対象チャネルによって異なります。
値 ✓ 絞り込む値をJSON形式で入力します(例:["sample"])。
項目ごとの値の書き方は、アドエビス公式ドキュメント - アドエビスAPIの各レポートのfiltersを参照ください。
条件 - 値との比較方法を、以下から選択できます。
  • 次を含む
  • 次を含まない
  • 次に完全一致
  • 次で始まる
条件を指定できる項目は、各レポートのfiltersを参照ください。

クロスデバイス

フィルタでcross_deviceに[true]を指定すると、取得する列が増えます。
詳しくは、クロスデバイスの列を参照ください。

クロスデバイスの分析期間外を含む場合

データ取得期間にクロスデバイスの分析期間外の日が含まれると、アドエビスAPIがエラーとなり、転送が失敗します。

取得対象

日時の項目は、日本標準時(JST)として取得します。

値がNULLになる場合

アドエビスAPIが空の値を返した列は、型によらずNULLになります。
日時の列は、日時の形式でない値が返った場合もNULLになります。
数値の列は、数値でない値が返った場合にNULLになります。

カテゴリ分析・詳細分析・期間分析の場合

選択した集計軸の項目の組み合わせごとに、集計値を1行で取得します。

日別のデータを取得する場合

カテゴリ分析と詳細分析では、データ取得期間全体で集計するため、日ごとには行が分かれません。
日ごとの推移を取得する場合は、レポートタイプで期間分析を選択し、集計単位で日を選択してください。

集計軸の列

以下の列を取得します。
すべてstring型で取得します。

  • 集計軸で選択した項目
    • 項目によっては、IDや名前の列も取得します。たとえばcategoryを選択すると、category_id・media_idも取得します。
    • 一部の項目は、項目名の列ではなく、IDと名前の列で取得します。たとえばad_group1を選択すると、ad_group1_id・ad_group1_nameを取得します。
    • 詳細分析でad_dateを選択すると、ad_start_date(出稿開始日)・ad_end_date(出稿終了日)を取得します。
  • 詳細分析の場合は、以下の列
    • アドエビス項目で集計の場合:optional_media_side_ad_id(媒体広告ID)
    • 媒体項目で集計の場合:optional_ad_id(広告ID)
  • 期間分析の場合は、集計単位に応じた列(日:date、月:month、曜日:day_of_week、時間帯:hour)
    • 集計軸でdateを選択している場合は、dateの列も取得します。
  • 対象チャネルが全トラフィックの場合は、channel(チャネル種別)

指標の列

各指標の意味は、AD EBiS サポートサイト - 各項目についてを参照ください。

カラム名 デフォルトのデータ型 補足事項
impression double 表示回数
count_access long クリック数
ctr double CTR
count_session long セッション数
count_pv long 総PV
per_page_view double 平均PV
count_return long 直帰数
per_return double 直帰率
total_stay_time long 総滞在時間
total_stay_time_average long 平均滞在時間
total_latency_time long 総潜伏期間
latency_time_average long 平均潜伏期間
cv_data json CV(CV別)・CVR(CV別)
cv_total long CV(合計)
cvr_total double CVR(合計)
count_indirect_2〜count_indirect_5 long 間接効果2〜5
count_indirect_other long 間接効果6-10
indirect_total long 間接効果(合計)
direct_rate double 直間比率(直接)
indirect_rate double 直間比率(間接)
count_first long 初回接触
rcv double 再配分CV
amount long 売上金額
ramount double 再配分売上
cost double 広告コスト
cpc double CPC
cpa long CPA
tcpa long TCPA
roas double ROAS
troas double TROAS

クロスデバイスの列

フィルタでcross_deviceを指定した場合は、以下の列も取得します。

カラム名 デフォルトのデータ型 補足事項
cv_total_cross_linked_before long CV(合計) 紐づけ前
cv_total_cross_difference long CV(合計) 差分
cv_total_cross_rate double CV(合計) 比率
count_first_cross_linked_before long 初回接触 紐づけ前
count_first_cross_difference long 初回接触 差分
count_first_cross_rate double 初回接触 比率
rcv_cross_linked_before double 再配分CV 紐づけ前
rcv_cross_difference double 再配分CV 差分
rcv_cross_rate double 再配分CV 比率
ramount_cross_linked_before double 再配分売上 紐づけ前
ramount_cross_difference double 再配分売上 差分
ramount_cross_rate double 再配分売上 比率

コンバージョン属性の場合

1件のコンバージョンを1行として取得します。
コンバージョンの情報と、コンバージョンに至るまでの接触履歴を取得します。

コンバージョンの列

カラム名 デフォルトのデータ型 補足事項
terminal_type string デバイス
conv_id string 対象コンバージョン
cv_name string CV名
cv_access_time timestamp CV時間
tracking_data string ユーザーID
member_name string ユーザー名
amount long 売上金額
other1〜other5 string CV属性:項目1〜5
cv_contact_latency_time_average long 潜伏期間
count_contact long 接触回数
click_id json クリックID(対象チャネルが全トラフィックの場合のみ)

接触履歴の列

接触履歴は、contact_<contact>_<field>の形式の列で取得します。
たとえば、直接効果の広告IDはcontact_direct_ad_idです。

<contact>は接触の種類で、以下の11種類です。

  • direct:直接効果
  • indirect2〜indirect10:間接効果2〜10
  • first:初回接触

<field>は接触ごとの項目で、集計軸によって異なります。

集計軸 項目
アドエビス項目で集計 channel・access_time・category・ad_group1・ad_group2・ad_id・ad_name・media_side_ad_id・agency・landing_page_domain・landing_page_url・content_category・device
媒体項目で集計 channel・access_time・sync_category・media_side_campaign・media_side_group・ad_id・media_side_ad_id・media_side_ad_name・agency・landing_page_domain・landing_page_url・content_category・device

access_time(発生日時)の列はtimestamp型、それ以外の列はstring型で取得します。