3.2.2. キャンペーンレポートを取得する

[※]のついているものは必須パラメータです。

キャンペーン別レポートを取得する

[URL]
http://api.adlantis.jp/api/mobile/ad_exchange/auction/campaign/report/list

[引数]
s : ステータスで結果を絞り込みます。
    定数一覧の「キャンペーン及びクリエイティブのステータス」を参照して下さい。

keyword_col:キーワードの検索対象(campaign_name:キャンペーン名、client:代理店名、agent:広告主名、上記以外:上記のいずれにマッチする)

q : キーワード

order_by : 検索結果の順序を指定できます。

order_dir: desc(降順)、asc(昇順)

per_page : 結果を返す際、一ページ毎に最大何個まで表示するかを指定します。

page : 表示する結果のページ番号です。

sd[※] : レポートを取得する期間の開始日。

ed[※] : レポートを取得する期間の終了日。

[戻り値]
list:
total:
impression : 対象期間の合計インプレッション数。

click : 対象期間の合計クリック数。

cost:対象期間の合計消化金額。

campaigns:
campaign:

id : キャンペーンID。

name : キャンペーン名。

status: キャンペーンのステータス。

impression : 対象期間のインプレッション数。

click : 対象期間のクリック数。

ctr : 対象期間のクリック率

cost : 対象期間の消化金額。

conversion:対象期間の成果数。

cvr : 対象期間の成果率

キャンペーン×日別レポートを取得する

[URL]
http://api.adlantis.jp/api/mobile/ad_exchange/auction/campaign/report/matrix

[引数]
campaign_id[※] : レポートを取得する広告枠IDを指定します。

sd[※] : レポートを取得する期間の開始日。

ed[※] : レポートを取得する期間の終了日。

daily[※] : 結果を日別に出力するかどうか。
  • 1 : 日別に出力する。
  • それ以外の数値 : 合計を出力する。
report_format[※] : "campaign"で固定。

[戻り値]
日別に出力する場合

campaign_stats:
campaign_stat:

        target_date : レポートを取得する対象日。

impression : 対象日におけるインプレッション数。

click : 対象日におけるクリック数。

ctr :対象日におけるクリック率。

cost:対象日における消化金額。

conversion  : 対象日における成果数。

cvr:対象日における成果率。

au(softbank/docomo/others)_imp : au/Softbank/DoCoMo/その他のキャリアのインプレッション数。

au(softbank/docomo/others)_click : au/Softbank/DoCoMo/その他のキャリアのクリック数。

au(softbank/docomo/others)_ctr : au/Softbank/DoCoMo/その他のキャリアのクリック率。

au(softbank/docomo/others)_cost : au/Softbank/DoCoMo/その他のキャリアの消化金額。

au(softbank/docomo/others)_conv : au/Softbank/DoCoMo/その他のキャリアの成果数。

au(softbank/docomo/others)_cvr : au/Softbank/DoCoMo/その他のキャリアの成果率。

合計を出力する場合

campaign_stat:
campaign_id : キャンペーンID。

start-date : レポートを取得する期間の開始日。

end-date : レポートを取得する期間の終了日。

au(softbank/docomo/others)_imp : au/Softbank/DoCoMo/その他のキャリアのインプレッション数。

au(softbank/docomo/others)_click : au/Softbank/DoCoMo/その他のキャリアのクリック数。

au(softbank/docomo/others)_ctr : au/Softbank/DoCoMo/その他のキャリアのクリック率。

au(softbank/docomo/others)_cost : au/Softbank/DoCoMo/その他のキャリアの消化金額。

au(softbank/docomo/others)_conv : au/Softbank/DoCoMo/その他のキャリアの成果数。

au(softbank/docomo/others)_cvr : au/Softbank/DoCoMo/その他のキャリアの成果率。

impression : 合計のインプレッション数。

click : 対象期間における合計クリック数。

ctr : 対象期間における平均クリック率。

cost:対象期間における合計消化金額。

conversion  : 対象期間における合計成果数。

cvr:対象期間における平均成果率。

ecpm: 対象期間における1000件あたりの収益額。

キャンペーン×クリエイティブ別レポートを取得する

[URL]
http://api.adlantis.jp/api/mobile/ad_exchange/auction/campaign/report/matrix

[引数]
campaign_id[※] : レポートを取得する広告枠IDを指定します。

sd[※] : レポートを取得する期間の開始日

ed[※] : レポートを取得する期間の終了日

daily[※] : 結果を日別に出力するかどうか。
  • 1 : 日別に出力する。
  • それ以外の数値 : 合計を出力する。
report_format[※] : "campaign_creative"で固定。

[戻り値]
日別に出力する場合

campaign_stats:
campaign_stat:
ad_type : クリエイティブの種類。
    定数一覧の「モバイル版クリエイティブの種類」を参照 して下さい。

ad_id : クリエイティブID。

target_date : レポートを取得する対象日。

impression : 対象日におけるインプレッション数。

click : 対象日におけるクリック数。

ctr : 対象日におけるクリック率。

cost:対象日における消化金額。

conversion : 対象日における成果数。

cvr:対象日における成果率。

au(softbank/docomo/others)_imp : au/Softbank/DoCoMo/その他のキャリアのインプレッション数。

au(softbank/docomo/others)_click : au/Softbank/DoCoMo/その他のキャリアのクリック数。

au(softbank/docomo/others)_ctr : au/Softbank/DoCoMo/その他のキャリアのクリック率。

au(softbank/docomo/others)_cost : au/Softbank/DoCoMo/その他のキャリアの消化金額。

au(softbank/docomo/others)_conv : au/Softbank/DoCoMo/その他のキャリアの成果数。

au(softbank/docomo/others)_cvr : au/Softbank/DoCoMo/その他のキャリアの成果率。

合計を出力する場合

campaign_stats:
campaign_stat:
ad_type : クリエイティブの種類。
    定数一覧の「モバイル版クリエイティブの種類」を参照 して下さい。

ad_id : クリエイティブID。

start-date : レポートを取得する期間の開始日。

end-date : レポートを取得する期間の終了日。

impression : 対象日における合計のインプレッション数。

click : 対象日における合計のクリック数。

ctr : 対象日における全体のクリック率。

cost:対象日における全体の消化金額。

conversion : 対象日における全体の成果数。

cvr:対象日における全体の成果率。

au(softbank/docomo/others)_imp : au/Softbank/DoCoMo/その他のキャリアのインプレッション数。

au(softbank/docomo/others)_click : au/Softbank/DoCoMo/その他のキャリアのクリック数。

au(softbank/docomo/others)_ctr : au/Softbank/DoCoMo/その他のキャリアのクリック率。

au(softbank/docomo/others)_cost : au/Softbank/DoCoMo/その他のキャリアの消化金額。

au(softbank/docomo/others)_conv : au/Softbank/DoCoMo/その他のキャリアの成果数。

au(softbank/docomo/others)_cvr : au/Softbank/DoCoMo/その他のキャリアの成果率。

キャンペーン×広告枠別レポートを取得する

[URL]
http://api.adlantis.jp/api/mobile/ad_exchange/auction/campaign/report/matrix

[引数]
campaign_id[※] : レポートを取得する広告枠IDを指定します。

sd[※] : レポートを取得する期間の開始日

ed[※] : レポートを取得する期間の終了日

daily[※] : 結果を日別に出力するかどうか。
  • 1 : 日別に出力する。
  • それ以外の数値 : 合計を出力する。
report_format[※] : "campaign_zone"で固定。

[戻り値]

日別に出力する場合

campaign_stats:
campaign_stat:
zone_id : 広告枠ID。

target-date : レポートを取得する対象日。

impression : 対象日におけるインプレッション数。

click : 対象日におけるクリック数。

ctr : 対象日におけるクリック率。

cost:対象日における消化金額。

conversion : 対象日における成果数。

cvr:対象日における成果率。

au(softbank/docomo/others)_imp : au/Softbank/DoCoMo/その他のキャリアのインプレッション数。

au(softbank/docomo/others)_click : au/Softbank/DoCoMo/その他のキャリアのクリック数。

au(softbank/docomo/others)_ctr : au/Softbank/DoCoMo/その他のキャリアのクリック率。

au(softbank/docomo/others)_cost : au/Softbank/DoCoMo/その他のキャリアの消化金額。

au(softbank/docomo/others)_conv : au/Softbank/DoCoMo/その他のキャリアの成果数。

au(softbank/docomo/others)_cvr : au/Softbank/DoCoMo/その他のキャリアの成果率。

合計を出力する場合

campaign_stats:
campaign_stat:
zone_id : 広告枠ID。

start-date : レポートを取得する期間の開始日。

end-date : レポートを取得する期間の終了日。

impression : 対象日における合計のインプレッション数。

click : 対象日における合計のクリック数。

ctr : 対象日における全体のクリック率。

cost:対象日における全体の消化金額。

conversion : 対象日における全体の成果数。

cvr:対象日における全体の成果率。

au(softbank/docomo/others)_imp : au/Softbank/DoCoMo/その他のキャリアのインプレッション数。

au(softbank/docomo/others)_click : au/Softbank/DoCoMo/その他のキャリアのクリック数。

au(softbank/docomo/others)_ctr : au/Softbank/DoCoMo/その他のキャリアのクリック率。

au(softbank/docomo/others)_cost : au/Softbank/DoCoMo/その他のキャリアの消化金額。

au(softbank/docomo/others)_conv : au/Softbank/DoCoMo/その他のキャリアの成果数。

au(softbank/docomo/others)_cvr : au/Softbank/DoCoMo/その他のキャリアの成果率。

キャンペーン×広告枠×クリエイティブ別レポートを取得する

[URL]
http://api.adlantis.jp/api/mobile/ad_exchange/auction/campaign/report/matrix

[引数]
campaign_id[※] : レポートを取得する広告枠IDを指定します。

sd[※] : レポートを取得する期間の開始日

ed[※] : レポートを取得する期間の終了日

daily[※] : 結果を日別に出力するかどうか。
  • 1 : 日別に出力する。
  • それ以外の数値 : 合計を出力する。
report_format[※] : "campaign_zone_creative"で固定。

[戻り値]
- 日別に出力する場合 -
campaign_stats:
campaign:
zones:
zone:
zone_id : 広告枠ID。

ads:
ad:
ad_type : クリエイティブの種類。
    定 数一覧の「モバイル版クリエイティブの種類」を参照 して下さい。

ad_id : クリエイティブID。

stats:
stat:
          target_date : レポートを取得する対象日。

impression : 対象日におけるインプレッション数。

click : 対象日におけるクリック数。

ctr : 対象日におけるクリック率。

cost:対象日における消化金額。

conversion : 対象日における成果数。

cvr:対象日における成果率。

au(softbank/docomo/others)_imp : 
    au/Softbank/DoCoMo/その他のキャリアのインプレッション数。

au(softbank/docomo/others)_click : 
    au/Softbank/DoCoMo/その他のキャリアのクリック数。

au(softbank/docomo/others)_ctr : au/Softbank/DoCoMo/その他のキャリアのクリック率。

au(softbank/docomo/others)_cost : 
    au/Softbank/DoCoMo/その他のキャリアの消化金額。

au(softbank/docomo/others)_conv : 
    au/Softbank/DoCoMo/その他のキャリアの成果数。

au(softbank/docomo/others)_cvr : 
 au/Softbank/DoCoMo/その他のキャリアの成果率。


- 合計を出力する場合 -

campaign_stat:
campaign
zones:
zone:
zone_id : 広告枠ID。
ads:
ad:
ad_type : クリエイティブの種類。
    定数一覧の「モバイル版クリエイティブの種類」を参照 して下さい。

ad_id : クリエイティブID。

stats:
stat:
start-date : レポートを取得する期間の開始日。

end-date : レポートを取得する期間の終了日。

impression : 対象日における合計のインプレッション数。

click : 対象日における全体のクリック数。

ctr : 対象日における全体のクリック率。

cost:対象日における全体の消化金額。

conversion : 対象日における全体の成果数。

cvr:対象日における全体の成果率。

au(softbank/docomo/others)_imp : 
    au/Softbank/DoCoMo/その他のキャリアのインプレッション数。

au(softbank/docomo/others)_click : 
    au/Softbank/DoCoMo/その他のキャリアのクリック数。

au(softbank/docomo/others)_ctr : 
    au/Softbank/DoCoMo/その他のキャリアのクリック率。

au(softbank/docomo/others)_cost : 
    au/Softbank/DoCoMo/その他のキャリアの消化金額。

au(softbank/docomo/others)_conv : 
    au/Softbank/DoCoMo/その他のキャリアの成果数。

au(softbank/docomo/others)_cvr : 
    au/Softbank/DoCoMo/その他のキャリアの成果率。
Comments