4.2.1. キャンペーンを管理する

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

キャンペーン一覧を取得する

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

[引数]
s : キャンペーンの配信ステータス。
   
定数一覧の「キャンペーン及びクリエイティブのステータス」を参照。

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

q : キーワード

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

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

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

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

[戻り値]
campaigns:
campaign:
id : キャンペーンID

name : キャンペーン名

category_id : カテゴリID。
    定数一覧の「AdLantis AdExchangeで使用するカテゴリ」を参照。

budget : 予算金額。

start_date : キャンペーンの開始日時。

end_date: キャンペーンの終了日時。

client_id : クライアントID。

client_name : クライアント名。

agent_id : 代理店ユーザーID。

agent_name : 代理店ユーザー名。

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

キャンペーンの詳細情報を取得する

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/details

[引数]
campaign_id[※] : 対象キャンペーンのid

[戻り値]
campaign:
name : キャンペーン名。

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

client_id : クライアントのID。

client : クライアント名。

agent_id : 代理店ID。

agent : 代理店名。

charge_username : 担当者名。

client_url : クライアントURL。

category_id : キャンペーンのカテゴリ。
    定数一覧の「AdLantis AdExchangeで使用するカテゴリ」を参照。

budget : 合計予算額。

start_date : キャンペーンの開始日時。

end_date: キャンペーンの終了日時。

has_freq_setting : ユーザー毎のクリエイティブ表示頻度設定。
  • true:  設定あり
  • false: 設定なし

freq_limit : 指定した期間に1ユーザーへ広告を表示する最大数。1 〜 9までの値を入力して下さい。
has_freq_setting が true の時のみ有効。

freq_span : フリークエンシーが有効な期間を秒数で指定する。1分(60)単位で最大1ヶ月(2592000)まで指定可能。
has_freq_setting が true の時のみ有効。

入稿可能な広告枠の一覧を取得する

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/zones

[引数]
q:キーワードで結果を絞り込みます。検索対象は枠名、枠のサイト名、枠のサイト記述になります。

category_id:カテゴリID。
    定数一覧の「AdLantis AdExchangeで使用するカテゴリ」を参照。

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

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

[戻り値]
zones:
zone:
name : 広告枠名。

site_name:サイト名

site_url:サイトURL

site_description: サイトの概要

impression:対象広告枠の前日のインプレッション 数。若しくは広告枠 の設定で指定している対外向けのインプレッション数。

click:対象広告枠の前日 のクリック数。若しくは広告枠の設定で指定している対外向けのクリック数。

ctr: 対象広告枠の前日のクリック率。若しくは広告枠の設定で指定している対外向けのクリック率。

max_auction_cpm:枠のクリッ ク単価の最高入札額。クリック課金で出品している場合のみ表示される。

max_auction_cpc:枠のインプレッション単価の最高 入札額。クリック課金で出品している場合のみ表示される。

キャンペーン作成

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/create

[引数]
name[※] : キャンペーン名 : 50文字以内

budget[※] キャンペーンの予算額。

daily_max_budgetキャンペーンの一日上限合計。

client_id(+) : 既存のクライアントのIDを指定する。clientとどちらか片方は必須。

client(+) : クライアント名を指定する。client_idとどちらか片方は必須。

charge_username : 担当者名。

client_url[※]  : クライアントURL。

category_id : キャンペーンのカテゴリ。
定数一覧の「AdLantis AdExchangeで使用するカテゴリ」を参照。

start_date : キャンペーンの開始日。YYYY/MM/DD形式(例: 2010/02/01)。期間指定型キャンペーンの場合には必須。

start_hour : キャンペーンの開始時間。0 〜 23までの整数。期間指定型キャンペーンの場合には必須。

end_date : キャンペーンの終了日。YYYY/MM/DD形式(例: 2010/02/01)。期間指定型キャンペーンの場合には必須。

end_hour : キャンペーンの終了時間。0 〜 23までの整数。期間指定型キャンペーンの場合には必須。

has_freq_setting : ユーザー毎のクリエイティブ表示頻度設定。
  • true:  設定あり
  • false: 設定なし

freq_limit : 指定した期間に1ユーザーへ広告を表示する最大数。1 〜 9までの値を入力して下さい。
has_freq_setting が true の時のみ有効。

freq_span : フリークエンシーが有効な期間を秒数で指定する。1分(60)単位で最大1ヶ月(2592000)まで指定可能。
has_freq_setting が true の時のみ有効。



[戻り値]
campaign:
  id: キャンペーンID 

キャンペーン変更

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/update

[引数]
campaign_id[※] : 更新対象のキャンペーンID

※ 以下、入力された項目のみ更新される。

name : キャンペーン名 : 50文字以内

budget キャンペーンの予算額。

daily_max_budgetキャンペーンの一日上限合計。

client_id(+) : 既存のクライアントのIDを指定する。clientとどちらか片方は必須。

client(+) : クライアント名を指定する。client_idとどちらか片方は必須。

charge_username : 担当者名。

client_url  : クライアントURL。

category_id : キャンペーンのカテゴリ。
定数一覧の「AdLantis AdExchangeで使用するカテゴリ」を参照。

start_date : キャンペーンの開始日。YYYY/MM/DD形式(例: 2010/02/01)。期間指定型キャンペーンの場合には必須。

start_hour : キャンペーンの開始時間。0 〜 23までの整数。期間指定型キャンペーンの場合には必須。

end_date : キャンペーンの終了日。YYYY/MM/DD形式(例: 2010/02/01)。期間指定型キャンペーンの場合には必須。

end_hour : キャンペーンの終了時間。0 〜 23までの整数。期間指定型キャンペーンの場合には必須。

has_freq_setting : ユーザー毎のクリエイティブ表示頻度設定。
  • true:  設定あり
  • false: 設定なし

freq_limit : 指定した期間に1ユーザーへ広告を表示する最大数。1 〜 9までの値を入力して下さい。
has_freq_setting が true の時のみ有効。

freq_span : フリークエンシーが有効な期間を秒数で指定する。1分(60)単位で最大1ヶ月(2592000)まで指定可能。
has_freq_setting が true の時のみ有効。



[戻り値]
                success:
                    message: "キャンペーンの変更が完了しました"

キャンペーン削除

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/delete

[引数]
campaign_id[※] : キャンペーンのID

[戻り値]
                success:
                    message: "キャンペーンを削除しました"

キャンペーンの配信開始

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/start

[引数]
campaign_id[※] :キャンペーンのID : 数値

[戻り値]
success:
message: "キャンペーンを配信開始しました"


キャンペーンの配信停止

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/pause

[引数]
campaign_id[※] :キャンペーンのID : 数値

[戻り値]
success:
message: "キャンペーンを停止しました"

キャンペーンの配信再開

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/rewind

[引数]
campaign_id[※] :キャンペーンのID : 数値

[戻り値]
success:
message: "キャンペーンを配信再開しました"

キャンペーンが入稿されている枠一覧

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/zones

[引数]
campaign_id[※] :キャンペーンのID : 数値

[戻り値]
zones:
zone:
zone_id : 広告枠のID。

bid_type : 課金種類

    定数一覧の「キャ ンペーンの課金種類」を参照 して下さい。

cpc : CPC単価


cpm : CPM単価。

daily_max_budget : 一日の上限予算。

キャンペーンに広告枠を追加

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/add_zone

[引数]
campaign_id[※] : 対象キャンペーンのid

zone_id
[※] : 対象枠のid。

zone_bid_type[※] : 課金種類。
    定数一覧の「キャ ンペーンの課金種類」を参照 して下さい。

zone_cpc : クリック単価。課金種類がクリック型の場合は必須。

zone_cpm : インプレッション単価課金種類がインプ レッション型の場合は必須。

zone_daily_max_budget : 対象広告枠一日の上限予算。

[戻り値]
success:
message: "広告枠を追加しました"

[備考]
・クリック/インプレッション単価ともに、現在の最低入札額以下の金額の場合、落札できません。
・対象広告枠の一日の予算上限額が、キャンペーンの合計予算額を上回る設定もできません。

キャンペーンの広告枠単価を変更

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/update_zone

[引数]
campaign_id[※] : 対象キャンペーンのid

zone_id
[※] : 対象枠のid。

zone_bid_type[※] : 課金種類
定数一 覧の「キャンペーンの課金種類」を参照して下さい。

zone_cpc: クリック単価(クリック課金の場合必須)

zone_cpm : インプレッション単価(インプレッション課金の場合必須)

zone_daily_max_budget :枠の一日の上限予算
[戻り値]
success:
message: "広告枠単価を変更しました"

[備考]
・クリック/イ ンプレッション単価ともに、現在の最低入札額以下の金額の場合、落札できません。
・対象 広告枠の一日の予算上限額が、キャンペーンの合計予算額を上回る設定もできません。

キャンペーンから広告枠を削除

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/delete_zone

[引数]
campaign_id[※] : 対象キャンペーンのid

zone_id[※] : 対象枠のid

[戻り値]
success:
message: "広告枠を削除しました"

キャンペーンに登録されている広告の一覧

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/ads

[
引数]
        campaign_id[※] :キャンペーンのID : 数値

[戻り値]
ads:
ad:
id : 広告ID。

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

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

name : 広告/クリエイティブ名。

url : クリック先URL。

priority_flg : 配信優先度の設定。
  • 0 : 優先度を指定して配信する。
  • 1 : AdLantisによる自動化配信。
priority_order : 配信の優先度設定。1 〜 5までの数値。

start_date : 配信開始日。YYYY/MM/DD HH:mm:ss形式。

end_date : 配信終了日。YYYY/MM/DD HH:mm:ss形式。

- 以下テキスト/一行テキスト広告の場合 -

title : タイトル行の文言(テキスト)

text : 本文の文言(テキスト)/広告の文言(一行)

short_url : テキストの下に表示する広告枠(テキスト)

target_window: リンクを開く際のターゲット設定。
  • top : 同一ウィンドウで開く。
  • blank : 新しいウィンドウで開く。
- 以下バナー及びflash広告の場合 -

external_image_flg : 画像(flash)をアップロードするか、外部画像URLを指定するか決める。
  • false(0) : 画像をアップロードして作成されたクリエイティブ。
  • true(1)  : 外部画像URLを指定して作成されたクリエイティブ。
external_image_url : 画像の外部URL(外部画像参照時のみ)

alt : 画像が表示されなかった時の代替テキスト。

banner_image :
filename : アップロードされたファイル名(暗号化済み)。

width : 画像の横サイズ(アップロード時のみ)。

height : 画像の縦サイズ(アップロード時のみ)。

public_filename : 画像へのフルパス。

size : 画像のファイルサイズ(単位はbyte)。

content_type : ファイルをアップロードした際に設定された、ファイルのコンテンツタイプ(アップロード時のみ)。

広告を作成する

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/create_ad

[
引数]
        
クリエイティブ引数 : 4.1.5. クリエイティブを管理する 参照してください

       
zone_ids : 広告枠。文字列。複数を指定する場合、カンマで区切り
       
[戻り値]
ad:
id : クリエイティブのID

広告の変更

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/update_ad

[
引数]
        campaign_id[※] :キャンペーンのID : 数値

ad_id[※] :クリエイティブのID : 数値

ad_type[※] : クリエイティブの種類 : 数値

[広告タイプ別の引数]
        クリエイティブ引数 : 4.1.5. クリエイティブを管理する 参照してください


[戻り値]
success:
message : 広告の変更が完了しました

広告の削除

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/delete_ad

[引数]
campaign_id[※] :キャンペーンのID : 数値

ad_id[※] :クリエイティブのID : 数値

ad_type[※] : クリエイティブの種類 : 数値

[戻り値]
        success:
                    message : 広告を削除しました

広告の配信開始

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/start_ad

[
引数]

campaign_id[※] : キャンペーンのID : 数値

ad_id[※] : クリエイティブのID : 数値

ad_type[※] : クリエイティブの種類 : 数値

[戻り値]
success:
    message: 広告配信を開始しました

[備考] ステータスを「配信中」にするためには、対象クリエイティブが
     以下の条件を全て満たす必要があります。
  • 広告枠に登録済みである
  • 管理者/パートナーの承認を受けている
  • 配信期間が指定されている場合、期間内であ

広告の配信停止


[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/pause_ad

[引数]
campaign_id[※] :キャンペーンのID : 数値

ad_id[※] : クリエイティブのID : 数値

ad_type[※] : クリエイティブの種類 : 数値

[戻り値]
        
success:
            message: 広告配信を停止しました



クリエイティブに登録されている広告枠一覧

 
             [URL]
                 http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/ad_zones

             [引数]
campaign_id[※] :キャンペーンのID : 数値

ad_id[※] :クリエイティブのID : 数値

ad_type[※] : クリエイティブの種類 : 数値

              [戻り値]
 
zones:

zone:

id : 広告枠のID。

[備考]
クリエイティブに広告枠が一つも登録されていない場合、
     id=0が戻り値として与えられる。

クリエイティブに枠を登録する


 [URL]
                http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/add_ad_zones

[引数]
campaign_id[※] : キャンペーンのID : 数値

ad_id[※] : クリエイティブのID : 数値

ad_type[※] : クリエイティブの種類 : 数値

zone_ids[※] : 対象枠のid。一度に複数追加したい場合はカンマ「,」区切りでidを渡して下さい。

[戻り値]
ad:
ad_id:クリエイティ ブのID。

ad_type: クリエイティブの種類。

[備考]
バナー広告などの、サイズが存在するクリエイティブの場合、
広告枠のサイズと完全に一致する必要があります。

     zone_idsには、指定したキャンペーンに登録されているもののみ利用可能です。

クリエイティブに枠を削除する

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/auction/campaign/delete_ad_zones

[引数]
campaign_id[※] : キャンペーンのID : 数値

ad_id[※] : クリエイティブのID : 数値

ad_type[※] : クリエイティブの種類 : 数値

zone_ids[※] : 対象枠のid。一度に複数追加したい場合はカンマ「,」区切りでidを渡して下さい。

[戻り値]
ad : 
ad_id:クリエイティブのID : 数値

ad_type: クリエイティブの種類 : 数値

Comments