3.1.1. 広告枠を管理する

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

広告枠一覧を取得する

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

[引数]
show_deleted : 削除済みの広告枠も表示する場合は1を指定します。

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

order_by : 検索結果のソート対象属性を指定します。name(広告枠名)、site_url(サイトURL)、site_name(サイト名)が指定できます。

order_dir : 検索結果のソート順を指定します。asc(昇順)、desc(降順)が指定できます。

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

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

[戻り値]

zones:
zone:
id : 広告枠ID

zone_type : 枠のタイプ。
    定数一覧の「モバイル版広告枠の種類」を参照して下さい。


name : 広告枠名。

encoding : 文字コード。
   
定数一覧の「モバイル版の広告枠で指定可能な文字 コード一覧」を参照して下さい。

site_name : サイト名

site_url : サイトURL

user_id : 所有者ユーザID

user_name : 所有者ユーザ名

created_user_id : 広告枠を作成したユーザID

created_user_name : 広告枠を作成したユーザ名

mp_category_id : この広告枠が所属するカテゴリ。
   
定数一覧の「モバイル版の広告枠で指定可能な文字 コード一覧」を参照して下さい。

mp_allow_cpc_ad : クリック型オークションを受け付けるかかどうか。
  • "true" : 受け付ける。
  • "false" : 受け付けない。
mp_allow_cpm_ad : インプレッション型オークションを受け付けるかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_text_ad : マーケットプレイス経由で配信される広告のうち、テキスト広告の配信を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_banner_ad : マーケットプレイス経由で配信される広告のうち、バナー広告の配信を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_adult_ad : この広告枠に対して、アダルト広告の掲載を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。

広告枠の詳細

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

[引数]
zone_id[※] : 対象枠のid

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

zone_type : 枠のタイプ。
   
定数一覧の「モバイル版広告枠の種類」を参照して下さい。

name : 広告枠名。

encoding : 文字コード。
   
定数一覧の「モバイル版の広告枠で指定可能な文字 コード一覧」を参照して下さい。

site_name : サイト名


site_url : サイトURL


site_description : サイト詳細情報。

user_id : 所有者ユーザID。

user_name : 所有者ユーザ名


created_user_id : 広告枠を作成したユーザID

created_user_name : 広告枠を作成したユーザ名

mp_category_id : この広告枠が所属するカテゴリ。
   
定数一覧の「モバイル版の広告枠で指定可能な文字 コード一覧」を参照して下さい。

mp_allow_cpc_ad : クリック型オークションを受け付けるかかどうか。
  • "true" : 受け付ける。
  • "false" : 受け付けない。
mp_allow_cpm_ad : インプレッション型オークションを受け付けるかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_text_ad : マーケットプレイス経由で配信される広告のうち、テキスト広告の配信を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_banner_ad : マーケットプレイス経由で配信される広告のうち、バナー広告の配信を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_adult_ad : この広告枠に対して、アダルト広告の掲載を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。

広告枠の張付けタグの取得


[URL]
http://api.adlantis.jp/api/mobile/zone/code

[引数]
zone_id[※] : 対象枠のid

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

name : 広告枠名。

php_code : PHP用広告枠タグ(CGI版広告枠に限る)

jps
_cdoe : JSP用広告枠タグ(CGI版広告枠に限る)

perl
_code : Perl用広告枠タグ(CGI版広告枠に限る)

html
_code : HTMLページ用広告枠タグ(画像専用版広告枠に限る)

xhtml_code : XHTMLページ用広告枠タグ(画像専用版広告枠に限る)

広告枠の作成

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

[引数]
zone_type[※] : 枠のタイプ。
    定数一覧の「モバイル版広告枠の種類」を参照して下さい。

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

title_color : タイトルカラー : RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない

text_color : テキストカラー : RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない。

align : コンテンツを寄せる方向。一般枠の場合は必須。
    定数一覧の「モバイル版広告枠で指定可能な寄せ方向」を参照して下さい。

site_name[※] : サイト名 : 50文字以内

site_url[※] : サイトURL : 255文字以内

site_description[※] : サイト概要 : 255文字以内

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

encoding[※] : 文字コード。画像専用枠の場合は"utf8"で固定になります。
   
定数一覧の「モバイル版の広告枠で指定可能な文字 コード一覧」を参照して下さい。

mp_category_id[※] : この広告枠が所属するカテゴリ。
   
定数一覧の「モバイル版の広告枠で指定可能な文字 コード一覧」を参照して下さい。

mp_allow_cpc_ad[※] : クリック型オークションを受け付けるかかどうか。
    mp_allow_cpc_adか mp_allow_cpm_adのうち、どちらか片方はtrueである必要があります。
  • "true" : 受け付ける。
  • "false" : 受け付けない。
mp_allow_cpm_ad[※] : インプレッション型オークションを受け付けるかどうか。
    mp_allow_cpc_adか mp_allow_cpm_adのうち、どちらか片方はtrueである必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_text_ad[※] : マーケットプレイス経由で配信される広告のうち、テキスト広告の配信を許可するかどうか。
    画像専用枠の場合はパラメータの有無に関わらず"false" に設定されます。テキスト若しくはバナーのうち少なくとも一つは許可する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_banner_ad[※] : マーケットプレイス経由で配信される広告のうち、バナー広告の配信を許可するかどうか。
    画像専用枠の場合はパラメータの有無に関わらず"true"に設定されます。テキスト若しくはバナーのうち少なくとも一つは許可する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_adult_ad[※] : この広告枠に対して、アダルト広告の掲載を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
[戻り値]
zone:
zone_id: 作成された広告枠のID

広告枠の変更

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

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

zone_id[※] : 対象広告枠のID。

title_color : タイトルカラー : RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない。

text_color : テキストカラー : RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない

align : コンテンツを寄せる方向。
   
定数一覧の「モバイル版広告枠で指定可能な寄せ方向」を参照して下さい。

site_name : サイト名 : 50文字以内。

site_url : サイトURL。255文字以内。

site_description : サイト詳細。255文字以内。

name : 広告枠名50文字以内

encoding : 文字コード。画像専用枠の場合は"utf8"で固定になります。
   
定数一覧の「モバイル版の広告枠で指定可能な文字 コード一覧」を参照して下さい。

mp_category_id : この広告枠が所属するカテゴリ。
   
定数一覧の「モバイル版の広告枠で指定可能な文字 コード一覧」を参照して下さい。

mp_allow_cpc_ad[※] : クリック型オークションを受け付けるかかどうか。
  • "true" : 受け付ける。
  • "false" : 受け付けない。
mp_allow_cpm_ad[※] : インプレッション型オークションを受け付けるかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_text_ad[※] : マーケットプレイス経由で配信される広告のうち、テキスト広告の配信を許可するかどうか。
    画像専用枠の場合はパラメータの有無に関わらず"false" に設定されます。テキスト若しくはバナーのうち少なくとも一つは許可する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_banner_ad[※] : マーケットプレイス経由で配信される広告のうち、バナー広告の配信を許可するかどうか。
    画像専用枠の場合はパラメータの有無に関わらず"true"に設定されます。テキスト若しくはバナーのうち少なくとも一つは許可する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_adult_ad[※] : この広告枠に対して、アダルト広告の掲載を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
[戻り値]
success:
message: "枠情報が更新されました"

広告枠の削除

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

[引数]
zone_id[※] : 対象枠のid

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

デフォルトの自社広告の一覧を取 得する

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

[引数]
zone_id[※] : 対象枠のid

[戻り値]
default_ads:
default_ad:
type: 広告の種類。

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

softbank_url : 
softbankク リックURL

docomo_url :
docomoクリックURL

others_url : 
othersクリックURL

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

name : 広告名。

start
_date : クリエイティブの配信開始日時。

end
_date : クリエイティブの配信終了日時。

priority_flg : 「true」の場合、配 信優先度を指定する

priority_order : 配信優先度。1 〜 5までの数値。

external
_image_url : 外部画像URL(バナー広告で外部画像を参照する場合)。

alt : 代替テキスト
バナー広告のみ


デフォルトの自社広告を新規作成する

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

[引数]
zone_id[※] : 対象枠のid

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

それ以外のパラメータについては、「3.5. クリエイティブを管理する」を参照して下さい。


[戻り値]
default_ad:
id: 新規に作成された広告のID
type: 広告の種類

デフォルトの自社広告を更新する

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

[引数]
ad_id[※] : 対象広告のid。

ad_type[※] : 広告の種類。

それ以外のパラメータについては、「3.5. クリエイティブを管理する」を参照して下さい。

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

デフォルトの自社広告を削除する

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

[引数]
ad_id[※] : 対象広告のid。
ad_type[※] : 広告の種類。
それ以外のパラメータは、クリエイティブを作成する際のパラメータを参考にして下さい。

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

デフォルトの自社広告を配信開始する

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

[引数]
ad_id[※] : 対象広告のid。
ad_type[※] : 広告の種類。

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

デフォルトの自社広告を配信停止する

[URL]
http://api.adlantis.jp/api/mobile/zone/default_ad/stop

[引数]
ad_id[※] : 対象広告のid。
ad_type[※] : 広告の種類。

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

Comments