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

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

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

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

[メソッド]
GET

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

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

order_by : 検索結果の順序を指定できます。
name : キャンペーン名

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

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

[戻り値]
campaigns:

campaign:

id : キャンペーンID

name : キャンペーン名

delivery_network :

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

bid_type : 課金種類
    定数一覧の「キャンペーンの課金種類」を参照。

cpc/cpm : 単価。

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/targeting/campaign/details

[メ ソッド]
GET

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

[戻り値]
campaign:

delivery_network : 配信対象とするネットワーク。
   
定数一覧の「ターゲティングキャンペーンのネットワーク設定」を参照。

name : キャンペーン名

targetting_keywords : キーワードターゲット。

targetting_urls : URLターゲット。

client_id : クライアントのID。

client : クライアント名。

charge_username : 担当者名。

client_url : クライアントURL。

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

bid_type : 課金種類。
    定数一覧の「キャンペーンの課金種類」を参照。

cpc : クリック単価。

cpm : インプレッション単価。

budget : 合計予算額。

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

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

daily_max_budget : 一日の上限予算額。

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/targeting/campaign/create

[メ ソッド]
POST

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

delivery_network[※] : 配信対象とするネットワークの指定。
    定数一覧の「ター ゲティングキャンペーンのネットワーク指定」を参照 して下さい。

targeting_keywords(+) : キーワードターゲットの指定。URLターゲット若しくはこちらのいずれかを指定する必要がある。

targeting_urls(+) : URLターゲットの指定。キーワードターゲット若しくはこちらのいずれかを指定する必要がある。

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

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

charge_username : 担当者名。

client_url[※] : クライアントURL。メディアの指定したURLフィルタとの比較対象になります。

category_id[※] : キャンペーンのカテゴリを指定する。
    定数一覧の「AdLantis AdExchangeで使用するカテゴリ」を参照 して下さい。

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

cpc(+) : クリック単価(クリック課金型の場合は必須)。

cpm(+) : インプレッション単価(インプレッション課金型の場合は必須)。

budget[※] : 合計予算額。

start_date(+) : キャンペーンの開始日。YYYY/MM/DD形式(例: 2010/02/01)。

start_hour(+) : キャンペーンの開始時間。0 〜 23までの整数。

end_date(+) : キャンペーンの終了日。YYYY/MM/DD形式(例: 2010/02/01)。

end_hour(+) : キャンペーンの終了時間。0 〜 23までの整数。

daily_max_budget(+) : 一日の上限予算額。合計予算額よりも大きな値を指定する必要がある。

tag_ids(+) ユーザー分析タグ文字列、コンマで区切り。それぞれのタグのフォーマットは "タグID:期間(週単位)"。
 (例)tag_ids=5:12,10:8,10:3  => タグID5の3ヶ月(12週間)、タグID10の2ヶ月(8週間)、タグID10の3週間

[戻り値]
success:
message: キャンペーンを作成しました

キャンペーンを更新する

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

[メ ソッド]
POST

[引数]
campaign_id[※] : 更新するキャンペーンのID。

以下任意入力 入力された項目のみを更新する

delivery_network : 配信対象とするネットワークの指定。
    定数一覧の「ターゲティングキャンペーンのネットワーク指定」を参照。

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

targeting_keywords : キーワードターゲットの指定。キーワード若しくはURLターゲットで最低一つは値が入力されている必要があります。

targeting_urls : URLターゲットの指定。キーワード若しくはURLターゲットで最低一つは値が入力されている必要があります。

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

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

charge_username : 担当者名。

client_url : クライアントURL。メディアの指定したURLフィルタとの比較対象になります。

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

bid_type : 課金種類。
   
定数一覧の「キャンペーンの課金種類」を参照。

cpc : クリック単価(クリック課金型の場合は必須)。

cpm : インプレッション単価(インプレッション課金型の場合は必須)。

budget : 合計予算額。現在消化している金額よりも大きい値を指定する必要があります。

start_date : キャンペーンの開始日。YYYY/MM/DD形式(例: 2010/02/01)。

start_hour: キャンペーンの開始時間。0 〜 23までの整数。

end_date: キャンペーンの終了日。YYYY/MM/DD形式(例: 2010/02/01)。

end_hour : キャンペーンの終了時間。0 〜 23までの整数。

daily_max_budget : 一日の上限予算額。合計予算額よりも大きな値を指定する必要がある。


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

キャ ンペーンを削除する

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

[メ ソッド]
POST

[引数]
                campaign_id[※] : 削除するキャンペーンのID。

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

キャンペーンの配信を開始する

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

[メソッド]
POST

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

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

キャ ンペーンの配信を停止する

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

[メ ソッド]
POST

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

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

キャンペーンの配信を再開する

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

[メソッド]

POST

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

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


ユーザ分析タグを取得する

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/targeting/campaign/user_analysis_tags
 
[メソッド]
         GET
 
[引数]
        campaign_id[※] : 対象キャンペーンのid

[戻り値]
        
user_analysis_tags:
    user_analysis_tag:

        id : タグID

        name : タグ名

        weeks : 期間(週単位)
        

 ユーザ分析タグを追加する

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/targeting/campaign/add_user_analysis_tag
 
[メソッド]
         POST
 
[引数]
        campaign_id[※] : 対象キャンペーンのid

tag_ids[※] :ユーザー分析タグ文字列、コンマで区切り。それぞれのタグのフォーマットは "タグID:期間(週単位)"。
 (例)tag_ids=5:12,10:8,10:3  => タグID5の3ヶ月(12週間)、タグID10の2ヶ月(8週間)、タグID10の3週間
[戻り値]
success:
message : ユーザ分析タグを追加しました

ユーザ分析タグを削除する

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/targeting/campaign/delete_user_analysis_tag
 
[メソッド]
         GET
 
[引数]
        campaign_id[※] : 対象キャンペーンのid

tag_ids[※] :ユーザー分析タグ文字列、コンマで区切り。

[戻り値]
success:
message : ユーザ分析タグを削除しました
 

類似ユーザボリュームを取得する

[URL]
http://api.adlantis.jp/api/pc/ad_exchange/targeting/campaign/similar_user_volume

[メソッド]

GET

[引数]
keywords[※] :キーワード: 文字列、改行区切り

hosturls[※] :URL: 文字列、改行で区切り

tag_ids :ユーザー分析タグ文字列、コンマで区切り。それぞれのタグのフォーマットは "タグID:期間(週単位)"。
            (例)tag_ids=5:12,10:8,10:3  => タグID5の3ヶ月(12週間)、タグID10の2ヶ月(8週間)、タグID10の3週間

conv_tag_ids :コンバージョンタグ文字列、コン マで区切り。それぞれのタグのフォーマットは "タグID:期間(週単位)"。
            (例)conv_tag_ids =5:12,10:8,10:3  => タグID5の3ヶ月(12週間)、タグID10の2ヶ月(8週間)、タグID10の3週間

min_similarity_rate : 最小類似率(1 ~ 10)

max_similarity_rate : 最大類似率(1 ~ 10)

[戻り値]
volumes:
keywords:
keyword : キーワード又はURL。

value : リーチするユーザー数。

tags:
key : オリジナルキー

tag-id:タグID

number-of_weeks: 期間(週単位)

value : リーチするユーザー数。

クリエイティブ

広告を作成する

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

[メソッド]
        POST

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

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

ad_type : クリエイティブ種類

広告を変更する

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

[メソッド]
        POST

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

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

クリエイティブの種類ごとの設定引数は
4.1.5. クリエイティブを管理する参照してください


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

広告を削除する

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

[メソッド]
        GET

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

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

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

広告の一覧

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

[メソッド]
        GET

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

[戻り値]
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 : 画像が表示されなかった時の代替テキスト。

        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/targeting/campaign/start_ad

[メソッド]
GET

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

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

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

[備考]
クリエイティブのステータスが、"承認済み”もしくは”停止中”の場合のみ、
ステータスを変更できます。
クリエイティブを配信する広告枠が、パートナーに承認されている必要があります。

広告の配信を停止する

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

[メソッド]
GET

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

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

Comments