4.1.1. 広告枠を管理する

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

広告枠一覧を取得する

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

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

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

width : 広告枠の幅(px)で結果を絞り込みます。

height : 広告枠の高さ(px)で結果を絞り込みます。

order_by : 検索結果のソート対象属性を指定します。下記の値が指定できます。
  • name(広告枠名)
  • site_url(サイトURL)
  • site_name(サイト名)
  • width(広告枠の幅)
  • height(広告枠の高さ)
order_dir : 検索結果のソート順を指定します。asc(昇順)、desc(降順)が指定できます。

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

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

[戻り値]

list:  
zones:
zone:
id : 広告枠ID

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


name : 広告枠名。

site_name : サイト名

site_url : サイトURL

user_id : 所有者ユーザID

user_name : 所有者ユーザ名

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

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

width : 広告枠の横幅(pixel単位)。

height : 広告枠の高さ
(pixel単位)

deleted : 「削除済み」かどうか。削除済みの場合は「1」、そうでない場合は「0」。

mp_category_id : この広告枠が所属するカテゴリ。
    
定数一覧の「Adlantis AdExchangeで使用するカテゴリ」を参照して下さい。

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

total : レコード総数(検索条件に一致した広告枠の総数)
          current_page : 現在のページ番号
          total_pages : ページ総数
/list


広告枠の詳細

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

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

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

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


name : 広告枠名。

site_name : サイト名


site_url : サイトURL


site_description : サイト詳細情報。

user_id : 所有者ユーザID。

user_name : 所有者ユーザ名


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

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

width : 広告枠の横幅(pixel単位)。

height : 広告枠の高さ
(pixel単位)

mp_category_id : この広告枠が所属するカテゴリ。
    
定数一覧の「Adlantis AdExchangeで使用するカテゴリ」を参照して下さい。

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

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

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

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

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

name : 広告枠名。

encrypted_zone_id : 暗号化済み広告枠ID。

import_javascript_code : 広告の呼び出しを行う際に、広告枠に共通で使用されるライブラリを呼び出すタグ。

zone_javascript_code : 広告枠毎のタグ。

広告枠の作成

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

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

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

title_color [※]: テキスト広告のタイトル色。規定サイズ広告枠の場合のみ必須。
    RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない

text_color [※]: テキスト広告のテキスト色。規定サイズ広告枠の場合のみ必須。
    
RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない。

url_color [※] : テキスト広告のリンク色。規定サイズ広告枠の場合のみ必須。
    
RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない。

bg_color [※] : テキスト広告の背景色。規定サイズ広告枠の場合のみ必須。
    RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない。

border_color [※]: テキスト広告のボーダー色。規定サイズ広告枠の場合のみ必須。
    RGB指定(例、"0000FF"): 指定が無い場合は引数を指定しない。

align :テキスト を寄せる方向。一行テキスト広告枠の場合のみ必須項目。
    定数一覧の「PC版広告枠で指定可能な寄せ方向」を参照して下さい。

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

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

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

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

width : 広告枠の横幅(pixel単位)。
   
このパラメータはフリーサイズ広告枠のみ有効且つ必須項目です。

height : 広告枠の高さ
(pixel単位)
    このパラメータはフリーサイズ広告枠のみ有効且つ必須項目です。

mp_category_id[※] : この広告枠が所属するカテゴリ。
    
定数一覧の「Adlantis AdExchangeで使用するカテゴリ」を参照して下さい。

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_oneline_ad : マーケットプレイス経由で配信される広告のうち、一行テキスト広告の配信を許可するかどうか。
    一行
テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_text_ad : マーケットプレイス経由で配信される広告のうち、テキスト広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_banner_ad : マーケットプレイス経由で配信される広告のうち、バナー広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_flash_ad : マーケットプレイス経由で配信される広告のうち、Flash広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_html_ad : マーケットプレイス経由で配信される広告のうち、HTML広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_adult_ad[※] : この広告枠に対して、アダルト広告の掲載を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
[戻り値]
zone:
zone_id : 作成された広告枠のID。
encrypted_zone_id : 暗号化済み広告枠ID。

広告枠の変更

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

[引数]

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

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

title_color : テキスト広告のタイトル色。規定サイズ広告枠の場合のみ有効。RGB指定 (例、"0000FF")

text_color : テキスト広告のテキスト色。規定サイズ広告枠の場合のみ
有効RGB指定 (例、"0000FF")

url_color : テキスト広告のリンク色。規定サイズ広告枠の場合のみ
有効RGB指定 (例、"0000FF")

bg_color : テキスト広告の背景色。規定サイズ広告枠の場合のみ
有効RGB指定 (例、"0000FF")

border_color : テキスト広告のボーダー色。規定サイズ広告枠の場合のみ
有効RGB指定 (例、"0000FF")

align : 一行テキスト広告枠で、文字を寄せる方向。
    定数一覧の「PC版広告枠で指定可能な寄せ方向」を参照して下さい。

    このパラメータは一行テキスト広告枠に対してのみ有効です。

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

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

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

name : 広告枠名50文字以内

width : 広告枠の横幅(pixel単位)。このパラメータはフリーサイズ広告枠のみ有効です。

height : 広告枠の高さ
(pixel単位)このパラメータはフリーサイズ広告枠のみ有効です。


mp_category_id : この広告枠が所属するカテゴリ。
    
定数一覧の「Adlantis AdExchangeで使用するカテゴリ」を参照して下さい。

mp_allow_cpc_ad : クリック型オークションを受け付けるかかどうか。
  • "true" : 受け付ける。
  • "false" : 受け付けない。
mp_allow_cpm_ad : インプレッション型オークションを受け付けるかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_oneline_ad : マーケットプレイス経由で配信される広告のうち、一行テキスト広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_text_ad : マーケットプレイス経由で配信される広告のうち、テキスト広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_banner_ad : マーケットプレイス経由で配信される広告のうち、バナー広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_flash_ad : マーケットプレイス経由で配信される広告のうち、Flash広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_html_ad : マーケットプレイス経由で配信される広告のうち、HTML広告の配信を許可するかどうか。
    一行テキスト広告 / テキスト広告 / バナー広告 / Flash広告 / HTML広告のうち、少なくとも一つは"true"に設定する必要があります。
  • "true" : 受け付ける
  • "false" : 受け付けない。
mp_allow_adult_ad : この広告枠に対して、アダルト広告の掲載を許可するかどうか。
  • "true" : 受け付ける
  • "false" : 受け付けない。
[戻り値]
success:
message: "枠情報が更新されました"

広告枠の削除

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

[引数]
zone_id : 対象広告枠のid。
zone_ids : 対象広告枠のid(複数)。カンマ区切りの整数を指定。

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

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

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

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

[戻り値]
default_ads:
default_ad:
id : 広告のID。

type : 広告の種類。


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

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

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

[引数]
zone_id[※] : 対象枠のid
ad_type[※] : 広告の種類。
    定数一覧の「PC版クリエイティブの種類」を参照して下さい。

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

[戻り値]
default-ad:
id: 新しく作成された広告のID
type: 新しく作成された広告の種類。

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

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

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

それ以外のパラメータは、クリエイティブを作成する際のパラメータを参考にして下さい。

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

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

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

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

それ以外のパラメータは、クリエイティブを作成する際のパラメータを参考にして下さい。

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

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

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

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

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

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

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

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

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

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

[URL]
http://api.adlantis.jp/api/pc/zone/ads_in_zone

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

[戻り値]
            zone:

                id : 広告枠のID

                name : 広告枠の名
            
                campaigns : 該当枠に入稿されるキャンペーン一覧

    id : キャンペーンID。
 
                    name : キャンペーン名。

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

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

                    total_impression : 消化すべき合計インプレッション数。

                    total_click : 消化すべき合計クリック数。

                    start_date : キャンペーンの配信開始日時(実際の配信開始日時若しくは設定している開始日時)。

                    end_date : キャンペーンの配信終了日時(設定している終了日時)。

                    delivery_rate : 対象広告枠に対する、このキャンペーンの配信比率。
  
    ads : 該当枠に入稿されるキャンペーンのクリエイティブ一覧

        id : 広告のID

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

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


default-ad :  該当枠に入稿されるデフォルト広告一覧

    id : デフォルト広告のID

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

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


Comments