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

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

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

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

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

zone_name
: キャンペーンが入稿されている広告枠名で結果を絞り込みます。

site_url
: サイトURLによって結果を絞り込みます。

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

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

agent: 代理店名

client: 広告主名

order_by: 検索結果の順序を指定できます。
name : キャンペーン名(デフォルト)
agent : 代理店名
client : 広告主名

order_dir:  検索結果の昇順、降順
   desc: 降順
        asc:  昇順

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

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

[戻り値]
campaigns:

campaign:

id : キャンペーンID

name : キャンペーン名

bid_type : 課金種類

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

budget : 予算金額

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

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

user_id : 所有者ユーザID

user_name : 所有ユーザー名

created_user_id : 作成者ユーザーID

created_user_name : 作成者ユーザー名

agent:代理店名

client:広告主名

キャ ンペーン詳細

[URL]
http://api.adlantis.jp/api/mobile/campaign/details

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

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

name : キャンペーン名

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

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

budget : 予算金額。

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

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

user_id : 所有者ユーザID。

user_name : 所有ユーザー名。

created_user_id : 作成者ユーザーID。

created_user_name : 作成者ユーザー名。

has_freq_setting : ユーザー毎のクリエイティブ表示頻度設定。

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

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

キャンペーン作成

[URL]
http://api.adlantis.jp/api/mobile/campaign/create

[引数]
name[※] : 枠名 : 50文字以内

budget[※] : 合計の予算額。

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

user_id: グループ管理者のみ指定可能。作成する広告枠を所有するユーザーIDを指定。

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

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

client[※] : クライアント名。

agent[※] : 広告代理店名。

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

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

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

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

target_au : auに対して配信を行うか。期間指定型キャンペーンの場合に指定する。
    target_au/target_softbank /target_docomo/target_othersのうち最低一つはtrueにする必要がある。
  • 1 : auに対して配信を行う。
  • 0 : auに対して配信を行わない。
target_softbank : Softbankに対して配信を行うか。期間指定型キャンペーンの場合に指定する。
    target_au/target_softbank/target_docomo/target_othersのう ち最低一つはtrueにする必要がある。
  • 1 : Softbankに対して配信を行う。
  • 0 : Softbankに対して配信を行わない。
target_docomo : DoCoMoに対して配信を行うか。期間指定型キャンペーンの場合に指定する。
    target_au/target_softbank /target_docomo/target_othersのう ち最低一つはtrueにする必要がある。
  • 1 : DoCoMoに対して配信を行う。
  • 0 : DoCoMoに対して配信を行わない。
target_others : その他のキャリアに対して配信を行うか。期間指定型キャンペーンの場合に指定する。
    target_au/target_softbank/target_docomo/target_othersのう ち最低一つはtrueにする必要がある。
  • 1 : その他のキャリアに対して配信を行う。
  • 0 : その他のキャリアに対して配信を行わない。
max_action_num : 一日のクリック/インプレッション上限値

delivery_optimization : 配信比率設定
  • 0 : 手動設定(クリエイティブ単位で優先度を直接指定)
  • 1 : 自動設定
has_block_num : CPC/CPMの配信比率指定
  • true : あり
  • false : なし
has_freq_setting : ユーザー毎のクリエイティブ表示頻度設定。

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

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

zone_ids : 入稿する広告枠。文字列。カンマ区切りで指定する

block_num_softbank : zone_idsに指定した広告枠IDの順でカンマ区切りで指定する。
    1000以内の数値で、期間指定型キャ ンペーンの場合に指定する。

block_num_others : zone_idsの広告枠順でカンマ区切りで指定する。
    1000以内の数値で、期間指定型キャンペーンの場合に指定する。

block_num_docomo : zone_idsの広告枠順でカンマ区切りで指定する。
    1000以内の数値で、期間指定型キャンペーンの場合 に指定する。

block_num_au : zone_idsの広告枠順でカンマ区切りで指定する。
    1000 以内の数値で、期間指定型キャンペーンの場合に指定する。

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

キャ ンペーン変更

[URL]
http://api.adlantis.jp/api/mobile/campaign/update

[引数]
campaign_id[※] : 更新対象のキャンペーンID
(その他の値はキャンペーン作成を参照してください)

[戻り値]
campaign:

campaign_id: キャンベーンID

キャ ンペーン削除

[URL]
http://api.adlantis.jp/api/mobile/campaign/delete

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

[戻り値]
                campaign:
                    campaign_id: キャンベーンID

キャ ンペーンの配信開始

[URL]
http://api.adlantis.jp/api/mobile/campaign/start

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

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

キャンペーンの配信停止

[URL]
http://api.adlantis.jp/api/mobile/campaign/pause

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

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

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

[URL]
http://api.adlantis.jp/api/mobile/campaign/zones

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

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

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

[URL]
http://api.adlantis.jp/api/mobile/campaign/add_zone

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

zone_id
[※] : 対象枠のid。

block_num_au : auに対する配信比率の指定を行う。0(0%)〜 1,000(100%)までの数値を指定する。
    期間指定型キャンペーンの場合は必須。

block_num_softbank : Softbankに対する配信比率の指定を行う。0(0%)〜 1,000(100%)までの数値を指定する。
    期 間指定型キャンペーンの場合は必須。

block_num_docomo : DoCoMoに対する配信比率の指定を行う。0(0%)〜 1,000(100%)までの数値を指定する。
    期 間指定型キャンペーンの場合は必須。

block_num_others : その他のキャリアに対する配信比率の指定を行う。0(0%) 〜 1,000(100%)までの数値を指定する。
    期間指定型キャンペーンの場合には必須。

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


キャンペーンの広告枠配信比率を変更

[URL]
http://api.adlantis.jp/api/mobile/campaign/update_zone

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

zone_id
[※] : 対象枠のid。

block_num_au : auに対する配信比率の指定を行う。0(0%)〜 1,000(100%)までの数値を指定する。
    期間指定型キャンペーンの場合は必須。

block_num_softbank : Softbankに対する配信比率の指定を行う。0(0%)〜 1,000(100%)までの数値を指定する。
    期間指定型キャンペーンの場合は必須。

block_num_docomo : DoCoMoに対する配信比率の指定を行う。0(0%)〜 1,000(100%)までの数値を指定する。
    期間指定型キャンペーンの場合は必須。

block_num_others : その他のキャリアに対する配信比率の指定を行う。0(0%) 〜 1,000(100%)までの数値を指定する。
    期間指定型キャンペーンの場合には必須。


[戻り値]
success:
message: "広告枠配信比率を変更しました"

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

[URL]
http://api.adlantis.jp/api/mobile/campaign/delete_zone

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

zone_id[※] : 対象枠のid

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

広告の変更

[URL]
http://api.adlantis.jp/api/mobile/campaign/update_ad

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

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

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

上記以外のパラメータについては、「3.5. クリエイティブを管理する」に記載されている
作成時のパラメータの中から更新したいものを渡して下さい。

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

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

広告の削除

[URL]
http://api.adlantis.jp/api/mobile/campaign/delete_ad

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

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

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

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

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

広告の配信開始

[URL]
http://api.adlantis.jp/api/mobile/campaign/start_ad

[
引数]

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

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

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

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

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

広告の配信停止

[URL]
http://api.adlantis.jp/api/mobile/campaign/pause_ad

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

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

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

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

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

キャンペーンに登録しているクリエイティブ一覧

[URL]
http://api.adlantis.jp/api/mobile/campaign/ads

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

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

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

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

name : 広告名。

allow_au : auに対して配信するかどうか。
  • true : auに対して配信する。
  • false : auに対して配信しない
allow_softbank : Softbankに対して配信するかどうか。
  • true : Softbankに対して配信する。
  • false : Softbankに対して配信しない
allow_docomo : DoCoMoに対して配信するかどうか。
  • true : DoCoMoに対して配信する。
  • false : DoCoMoに対して配信しない
allow_others : その他のキャリアに対して配信するかどうか。
  • true : その他のキャリアに対して配信する。
  • false : その他のキャリアに対して配信しない
au_url : auのクリック先URL。

softbank_url : Softbankのクリック先URL。

docomo_url : DoCoMoのクリック先URL。

others_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
: 本文(二行目)の文言。

has_title_link : タイトルに対してリンクを貼るかどうか。
  • true : タイトルに対してリンクを貼る。
  • false : タイトルに対してリンクを貼らない。
has_text_link : 本文に対してリンクを貼るかどうか。
  • true : 本文に対してリンクを貼る。
  • false : 本文に対してリンクを貼らない。


- 以下バナー及びアニメーション広告の場合 -

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

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

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

width : 画像の横サイズ。

height : 画像の縦サイズ。

public_filename : 画像へのフルパス。

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

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

クリエイティブのプレビューコードを取得する

 
            [URL]
                http://api.adlantis.jp/api/mobile/campaign/preview_ad

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

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

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

            [戻り値]
ad:
preview : htmlエスケープされたプレビューコード。

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

 
             [URL]
                 http://api.adlantis.jp/api/mobile/campaign/ad_zones

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

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

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

              [戻り値]
 
zones:

zone:

id : 広告枠のID。

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


 [URL]
                http://api.adlantis.jp/api/mobile/campaign/add_ad_zones

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

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

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

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

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

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

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

[URL]
http://api.adlantis.jp/api/mobile/campaign/delete_ad_zones

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

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

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

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

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

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

Comments