4.1.2. 広告枠別レポートを取得する

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

広告枠別レポートを取得する

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

[メソッド]
GET

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

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

q : キーワードで広告枠を絞り込みます。検索対象は広告枠名、サイト名、サイトの説明になります。

zone_ids : 文字列。 広告枠IDの一覧をコンマ区切りで指定します。

order_by : 検索結果のソート対象属性を指定します。下記の値が指定できます。
  • name(広告枠名)
order_dir : 検索結果のソート順を指定します。asc(昇順)、desc(降順)が指定できます。

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

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

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

                    total_pages :
ページ総数

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

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

                        ctr : 対象期間のCTR。

                        cost : 対象期間の合計収益。

                        ecpm : 対象期間のeCPM。

                    zones :
                        zone :
                            id : 広告枠ID

                            name : 広告枠名

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

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

                            ctr :  対象期間のCTR。

                            cost : 対象期間の収益。

                            ecpm : 対象期間のecpm。

広告枠×日別レポートを取得する

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

[メ ソッド]
GET

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

report_format[※] : "zone"で固定。

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

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

daily[※] : 結果を日別に出力するかどうか。
  • 1 : 日別に出力する。
  • それ以外 : 合計を出力する。
[戻り値]
- 日別表示の場合 -

zone_stats :
zone_stat :
target_date : レポート表示対象日。

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

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

cost : 期間内の合計収益。

ctr : 期間内のCTR。

ecpm : 期間内のeCPM。

campaign:
指定した広告枠へ対象日に配信された、アドサーバーのキャンペーンに関するレポート。
小要素はtotalと全て同じ。

exchange:
指定した広告枠へ対象日に配信された、AdLantis AdExchangeに関するレポート。
小要素はtotalと全て同じ。

default:
指定した広告枠へ対象日に配信された、デフォルトの自社広告に関するレポート。
小要素はtotalと全て同じ。

- 合計表示の場合 -

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

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

cost : 期間内の合計収益。

ctr : 期間内のCTR。

ecpm : 期間内のeCPM。

campaign:
指定した広告枠へ対象日に配信された、アドサーバーのキャンペーンに関するレポート。
小要素はtotalと全て同じ。

exchange:
指定した広告枠へ対象日に配信された、AdLantis AdExchangeに関するレポート。
小要素はtotalと全て同じ。

default:
指定した広告枠へ対象日に配信された、デフォルトの自社広告に関するレポート。
小要素はtotalと全て同じ。

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

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

[メソッド]
GET

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

report_format[※] : "zone_campaign"で固定。

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

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

daily[※] : 結果を日別に出力するかどうか。
  • 1 : 日別に出力する。
  • それ以外 : 合計を出力する。
[戻り値]
- 日別表示の場合 -

zone_stats:
zone_stat:
        campaign_id : キャンペーンID。

campaign_name : キャンペーン名。

status : キャンペーンのステータス。
    定数一覧の「キャンペーン及びクリエイティブのステータス」を参照して下さい。

stats:
stat:
target_date : レポート表示対象日。

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

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

cost : 期間内の合計収益。

ctr :期間内の CTR。

conversion : 期間内の合計成果数。

cvr : 期間内のCVR。

- 合計表示の場合 -

zone_stat:
zone_stat:
campaign_name : キャンペーン名。

status : キャンペーンのステータス。
    定数一覧の「キャンペーン及びクリエイティブのステータス」を参照して下さい。

stats:
start_date : レポート表示対象開始日。

end_date : レポート表示対象終了日。

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

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

cost : 期間内の合計収益。

ctr :期間内の CTR。

conversion : 期間内の合計成果数。

cvr : 期間内のCVR。

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

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

[メソッド]
GET

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

report_format[※] : "zone_campaign_creative"で固定。

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

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

daily[※] : 結果を日別に出力するかどうか。
  • 1 : 日別に出力する。
  • それ以外 : 合計を出力する。
[戻り値]
- 日別表示の場合 -

zone_stats:
zone:
type : "Zone"で固定。

campaigns:
campaign:
type : "Campaign"で固定。

campaign_id : キャンペーンID。

ads:
ad:
ad_id : クリエイティブID。

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

stats:
stat:
ad_id : クリエイティブID。

target_date : レポート表示対象日。

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

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

cost : 期間内の合計収益。

ctr :期間内のCTR。

conversion : 期間内の合計成果数。

cvr : 期間内の成果率。


- 合計表示の場合 -

zone_stat:
zone:
type : "Zone"で固定。

campaigns:
campaign:
type : "Campaign"で固定。

campaign_id : キャンペーンID。

ads:
ad:
ad_id : クリエイティブID。

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

stats:
stat:
ad_id : クリエイティブID。

start_date : 表示期間の開始日。

end_date : 表示期間の終了日。

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

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

cost : 期間内の合計収益。

ctr :期間内の CTR。

conversion : 期間内の合計成果数。

cvr : 期間内の成果率。




Comments