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

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


キャンペーン一覧を取得する
[URL]
http://api.adlantis.jp/api/pc/campaign/list

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

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

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

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

ステータスが指定されていない場合、「配信中」のキャンペーンを絞り込みます。
       100を指定した場合、全てのステータスのキャンペーン絞り込みます。

order_by: 検索結果の順序を指定できます。
  • name : キャンペーン名(デフォルト)
  • agent : 代理店名。
  • client : 広告主名
order_dir:  検索結果の昇順、降順。下記の値が使用できます。
  • desc: 降順
  • asc:  昇順
per_page: 結果を返す際、一ページ毎に最大何個まで表示するかを指定します。

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

[戻り値]

list:
 
         current_page : 現在のページ番号

         
total_pages : ページ総数

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

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

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

name : キャンペーン名

bid_type : 課金種類。
      • 1 . クリック課金
      • 2 . インプレッション課金
      • 3 . 期間指定広告(他社広告)
      • 5 . 期間指定広告(自社広告)
    定数一覧の「キャンペーンの課金種類」を参照して下さい。

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

budget : 予算金額。

start-date : キャンペーンの開始日時 。

end-date : キャンペーンの終了日時。

max_action_num : 一日のクリック/インプレッション上限値

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

param_match_keyword_1 : キーワード1

param_match_keyword_2 : キーワード2

param_match_keyword_3 : キーワード3

link_target: ターゲットの設定
  • 1 : 新しいウィンドウで開く
  • 2 : 同一ウィンドウで開く
user-id : 所有者ユーザID。

user-name : 所有ユーザー名。

created-user-id : 作成者ユーザーID。

created-user-name : 作成者ユーザー名。

キャンペーン作成

[URL]
http://api.adlantis.jp/api/pc/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までの整数。期間指定型キャンペーンの場合には必須。

max_action_num : 一日のクリック/インプレッション上限値

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

param_match_keyword_1 : キーワード1

param_match_keyword_2 : キーワード2

param_match_keyword_3 : キーワード3

link_target : ターゲットの設定
  • 1 : 新しいウィンドウで開く
  • 2 : 同一ウィンドウで開く

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

block_num :  zone_idsに指定した広告枠IDの順でカンマ区切りで指定する。
    このパラメータは期間指定型キャ ンペーンの場合にのみ指定するもので、1000以下の数値を指定する必要があります。

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

キャンペーン変更

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

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

それ以外は作成時と同様のパラメータで、指定したパラメータの値のみ更新を行います。


[戻り値]
campaign:

campaign_id: キャンベーンID

キャンペーン削除

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

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

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

キャンペーンの配信開始

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

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

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


キャンペーンの配信停止

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

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

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

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

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

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

[戻り値]
zones:
zone:
id : 広告枠のID。
                                block_num : 配信比率の値。0(0%)〜 1,000(100%)までの数値

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

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

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

zone_id
[※] : 対象枠のid。

block_num :  このパラメータは期間指定型キャンペーンの場合にのみ有効かつ必須で、1000以下の数値を指定する必要があります。


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

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

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

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

zone_id
[※] : 対象枠のid。

block_num : 変更後の配信比率の値。0(0%)〜 1,000(100%)までの数値を指定する。
    期間指定型キャンペーンの場合は必須。
(他のキャンペーンも含め 100%を超えるとエラーになる)

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

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

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

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

zone_id[※] : 対象枠のid

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

広告の変更

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

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

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

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

各種クリエイティブのパラメータについては
クリエイティブを管理するを参照してください。


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

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

広告の削除

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

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

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

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

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

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

広告の配信開始

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

[
引数]

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

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

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

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

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

広告の配信停止


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

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

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

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

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

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

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

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

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

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

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

それ以外のデータについては、クリエイティブを管理する
    「一覧アクションにおけるクリエイティブ別属性」を参照して下さ い。


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

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

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

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

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

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

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

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

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

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

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

              [戻り値]
 
zones:

zone:

id : 広告枠のID。

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


 [URL]
                http://api.adlantis.jp/api/pc/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/pc/campaign/delete_ad_zones

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

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

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

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

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

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

Comments