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

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

キャンペーン別レポート(一覧)を取得する

     注:キャンペーンの一覧が表示されます

[URL]
http://api.adlantis.jp/api/pc/campaign/report/list

[引数]
ct : 課金種類で結果を絞り込みます。
    定数一覧の「キャ ンペーンの課金種類」を参照 して下さい。

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

zone_name : 入稿されている広告枠名。

q : キーワードで結果を絞り込みます。検索対象はキャンペーン名、代理店名、広告主名になります。

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

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

[戻り値]
list:
                      current_page : 現在のページ番号

                      total_pages : ページ総数

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

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

campaigns:

campaign:

id : キャンペーンID。

name : キャンペーン名。

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

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

ctr : 対象期間のCTR。

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

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

注:指定したキャンペーンの日別情報

[URL]
http://api.adlantis.jp/api/pc/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:対象日における成果率。

- 合計を出力する場合 -

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

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

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

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

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

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

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

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

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

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

[URL]
http://api.adlantis.jp/api/pc/campaign/report/matrix

[引数]
campaign_id[※] : レポートを取得するキャンペーンIDを
                指定します。

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

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

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

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

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

ad_id : クリエイティブID。

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

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

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

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

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

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

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

- 合計を出力する場合 -

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

ad_id : クリエイティブID。

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

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

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

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

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

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

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

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

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

[URL]
http://api.adlantis.jp/api/pc/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:対象日における成果率。

- 合計を出力する場合 -

campaign_stats:
campaign_stat:
zone_id : 広告枠ID。

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

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

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

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

ctr : 対象期間におけるCTR。

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

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

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

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

[URL]
http://api.adlantis.jp/api/pc/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 : クリエイティブの種類。
    定数一覧の「PC版クリエイティブの種類」を参照 して下さい。

ad_id : クリエイティブID。

stats:
stat:

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

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

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

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

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

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

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

- 合計を出力する場合 -

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

ad_id : クリエイティブID。

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

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

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

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

ctr : 対象期間におけるCTR。

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

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

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


Comments