4.1.5. クリエイティブを管理する

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

テキスト広告を作成する

[URL]
キャンペーンへ追加する場合 : http://api.adlantis.jp/api/pc/campaign/create_ad
デフォルトの自社広告を作成する場合 : http://api.adlantis.jp/api/pc/zone/default_ad/create

[メソッド]
POST

[引数]
campaign_id[※] : キャンペーンID。キャンペーンにクリエイティブを追加する場合は必須。

zone_ids : クリエイティブを登録する広告枠ID。カンマ区切りで複数指定可能。キャンペーンへクリエイティブを追加する場合は必須。

zone_id : 広告枠ID。デフォルトの自社広告を作成する場合には必須。

ad_type[※] : 広告の種類。「1」で固定。

title
[※] : タイトル文字列。

text
[※] : 本文文字列。

url
[※] : リンク先URL。

short_url
[※] : 表示URL。

name : 広告名。

priority_flg : 配信優先度の設定。
  • 0 : 優先度を指定して配信する。
  • 1 : AdLantisによる自動化配信。
priority_order : 配信の優先度設定。1 〜 5までの数値を指定する。優先度を指定して配信する設定(priority_flg = 0)のみ有効。
    指定しない場合は5が設定される。

start_date : 広告の配信開始日(yyyy/MM/dd)。

start_hour : 広告の配信開始時刻(hh)。start_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。

end_date : 広告の配信終了日(yyyy/MM/dd)。

end_hour : 広告の配信終了時刻(hh)。end_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。

[戻り値]
ad:
ad-id : 作成したクリエイティブのID。

ad-type : 作成したクリエイティブの種類。「1」で固定。

バナー広告を作成する

[URL]
キャンペーンへ追加する場合 : http://api.adlantis.jp/api/pc/campaign/create_ad
デフォルトの自社広告を作成する場合 : http://api.adlantis.jp/api/pc/zone/default_ad/create

[メソッド]
POST

[引数]
campaign_id[※] : キャンペーンID。キャンペーンにクリエイティブを追加する場合は必須。

zone_ids : クリエイティブを登録する広告枠ID。カンマ区切りで複数指定可能。キャンペーンへクリエイティブを追加する場合は必須。

zone_id : 広告枠ID。デフォルトの自社広告を作成する場合には必須。

ad_type[※] : 広告の種類。「2」で固定。

url[※] : リンク先URL。

external_image_flg : 画像をアップロードするか、外部画像URLを指定するか決める。
  • 0 : 画像をアップロードする。
  • 1 : 外部画像URLを指定する。
banner_image : バナーの画像ソースファイルへのパス。画像をアップロードする(external_image_flgが0の)場合は必須。

external_image_url : 画像の外部URL。外部画像URLを指定する(external_image_flgが1の)場合は必須。

alt
[※]: 画像が表示できないときの代替テキスト。

name : 広告名。

priority_flg : 配信優先度の設定。
  • 0 : 優先度を指定して配信する。
  • 1 : AdLantisによる自動化配信。
priority_order : 配信の優先度設定。1 〜 5までの数値を指定する。優先度を指定して配信する設定(priority_flg = 0)のみ有効。
    指定しない場合は5が設定される。

target_window
: 広告をクリックした際に開くウィンドウの位置。指定しない場合はデフォルトで「キャンペーンの設定を引き継ぐ」になります。
  • top : 同一ウィンドウで開く。
  • blank : 新しいウィンドウに開く。
  • campaign : キャンペーンの設定を引き継ぐ。
start_date : 広告の配信開始日(yyyy/MM/dd)。

start_hour : 広告の配信開始時刻(hh)。start_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。

end_date : 広告の配信終了日(yyyy/MM/dd)。

end_hour : 広告の配信終了時刻(hh)。end_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。

[戻り値]
ad:
ad-id : 作成したクリエイティブのID。

ad-type : 作成したクリエイティブの種類。「2」で固定。

一行テキスト広告を作成する

[URL]
キャンペーンへ追加する場合 : http://api.adlantis.jp/api/pc/campaign/create_ad
デフォルトの自社広告を作成する場合 : http://api.adlantis.jp/api/pc/zone/default_ad/create

[メソッド]
POST

[引数]
campaign_id[※] : キャンペーンID。キャンペーンにクリエイティブを追加する場合は必須。

zone_ids : クリエイティブを登録する広告枠ID。カンマ区切りで複数指定可能。キャンペーンへクリエイティブを追加する場合は必須。

zone_id : 広告枠ID。デフォルトの自社広告を作成する場合には必須。

ad_type[※] : 広告の種類。「3」で固定。

text
[※] : 本文文字列。

url
[※] : リンク先URL。

name : 広告名。

priority_flg : 配信優先度の設定。
  • 0 : 優先度を指定して配信する。
  • 1 : AdLantisによる自動化配信
priority_order : 配信の優先度設定。1 〜 5までの数値を指定する。優先度を指定して配信する設定(priority_flg = 0)のみ有効。
    指定しない場合は5が設定される。

target_window : 広告をクリックした際に開くウィンドウの位置。指定しない場合はデフォルトで「キャンペーンの設定を引き継ぐ」になります。
  • top : 同一ウィンドウで開く。
  • blank : 新しいウィンドウに開く。
  • campaign : キャンペーンの設定を引き継ぐ。

start_date : 広告の配信開始日(yyyy/MM/dd)。

start_hour : 広告の配信開始時刻(hh)。start_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。

end_date : 広告の配信終了日(yyyy/MM/dd)。

end_hour : 広告の配信終了時刻(hh)。end_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。

[戻り値]
ad:
ad-id : 作成したクリエイティブのID。

ad-type : 作成したクリエイティブの種類。「3」で固定。

Flash広告を作成する

[URL]
キャンペーンへ追加する場合 : http://api.adlantis.jp/api/pc/campaign/create_ad
デフォルトの自社広告を作成する場合 : http://api.adlantis.jp/api/pc/zone/default_ad/create

[メソッド]
POST

[引数]
campaign_id[※] : キャンペーンID。キャンペーンにクリエイティブを追加する場合は必須。

zone_ids : クリエイティブを登録する広告枠ID。カンマ区切りで複数指定可能。キャンペーンへクリエイティブを追加する場合は必須。

zone_id : 広告枠ID。デフォルトの自社広告を作成する場合には必須。

ad_type[※] : 広告の種類。「4」で固定。

url[※] : リンク先URL。

external_image_flg : SWF画像をアップロードするか、外部画像URLを指定するか決める。
  • 0 : SWF画像をアップロードする。
  • 1 : 外部SWF画像URLを指定する。
banner_image : SWF画像ソースファイル。画像をアップロードする(external_image_flgが0の)場合は必須。

external_image_url : 画像の外部URL。外部画像URLを指定する(external_image_flgが1の)場合は必須。

alt_flg: 代替テキスト/バナーの指定
  • 0 : テキスト
  • 1: バナー
  • 3: 外部バナーURL
  • 以外: 指定なし
alt: 画像が表示できないときの代替テキスト。外部代替テキストを指定する(alt_flgが0の)場合は必須。

alt_banner_image: 代替バナー画像ソースファイル。外部代替画像を指定する(alt_flgが1の)場合は必須。

external_alt_image_url : 画像の外部URL。外部代替画像URLを指定する(alt_flgが3の)場合は必須。

name : 広告名。

priority_flg : 配信優先度の設定。
  • 0 : 優先度を指定して配信する。
  • 1 : AdLantisによる自動化配信。
priority_order : 配信の優先度設定。1 〜 5までの数値を指定する。優先度を指定して配信する設定(priority_flg = 0)のみ有効。
    指定しない場合は5が設定される。

start_date : 広告の配信開始日(yyyy/MM/dd)。

start_hour : 広告の配信開始時刻(hh)。start_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。

end_date : 広告の配信終了日(yyyy/MM/dd)。

end_hour : 広告の配信終了時刻(hh)。end_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。


[戻り値]
ad:
ad-id : 作成したクリエイティブのID。

ad-type : 作成したクリエイティブの種類。「4」で固定。

HTML広告を作成する

[URL]
キャンペーンへ追加する場合 : http://api.adlantis.jp/api/pc/campaign/create_ad
デフォルトの自社広告を作成する場合 : http://api.adlantis.jp/api/pc/zone/default_ad/create

[メソッド]
POST

[引数]
campaign_id[※] : キャンペーンID。キャンペーンにクリエイティブを追加する場合は必須。

zone_ids : クリエイティブを登録する広告枠ID。カンマ区切りで複数指定可能。キャンペーンへクリエイティブを追加する場合は必須。
        全ての広告枠の幅と高さが、後述のwidth,height両方と一致する必要がある。

zone_id : 広告枠ID。デフォルトの自社広告を作成する場合には必須。

ad_type[※] : 広告の種類。「7」で固定。但しデフォルトの自社広告として作成する場合「6で固定。

code[※] : HTMLコード(管理画面では「広告コード」に相当する)。自社広告ではcodeではなくbodyを利用している

url[※] : リンク先URL。

name : 広告名。

priority_flg : 配信優先度の設定。
  • 0 : 優先度を指定して配信する。
  • 1 : AdLantisによる自動化配信。
priority_order : 配信の優先度設定。1 〜 5までの数値を指定する。優先度を指定して配信する設定(priority_flg = 0)のみ有効。
    指定しない場合は5が設定される。

width
[※] : クリエイティブの幅(単位:ピクセル)

height[※] : クリエイティブの高さ(単位:ピクセル)

start_date : 広告の配信開始日(yyyy/MM/dd)。

start_hour : 広告の配信開始時刻(hh)。start_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。

end_date : 広告の配信終了日(yyyy/MM/dd)。

end_hour : 広告の配信終了時刻(hh)。end_dateを指定して、このパラメータを指定しない場合は、00(0時)が設定されたことになります。


[戻り値]
ad:
ad-id : 作成したクリエイティブのID。

ad-type : 作成したクリエイティブの種類。「6」で固定。

一覧アクションにおけるクリエイティブ別属性

[共通属性]
name : 広告名。

url : クリック先URL。

start_date : クリエイティブの配信開始日時。YYYY/MM/DD HH:mm:ss形式。

end_date : クリエイティブの配信終了日時。YYYY/MM/DD HH:mm:ss形式。

priority_flg : 配信優先度の設定。
  • 0 : 優先度を指定して配信する。
  • 1 : AdLantisによる自動化配信。 priority_order : 配信の優先度設定。1 〜 5までの数値。
preview : プレビュー用のHTMLデータを出力する。

target_window : 広告をクリックした際に開くウィンドウの位置。
    指定しない場合はデフォルトで「キャンペーンの設定を引き継ぐ」になります。
    但し、仕様上テキスト広告の場合は新しいウィンドウ、Flash広告の場合は同一ウィンドウで固定になります。
  • top : 同一ウィンドウで開く。
  • blank : 新しいウィンドウに開く。
  • campaign : キャンペーンの設定を引き継ぐ。
status : ステータス。
    
定数一覧の「キャンペーン及びクリエイティブのステータス」を参照して下さい。

[テキスト広告]
title : タイトル文字列。

text : 本文文字列。

[一行テキスト広告]
text : 本文文字列。

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

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

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

width : 画像の横サイズ。

height : 画像の縦サイズ。

public_filename : 画像へのフルパス。

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

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

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

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

width : 画像の横サイズ。

height : 画像の縦サイズ。

public_filename : 画像へのフルパス。

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

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

alt_flg: 代替テキスト/バナーの指定
  • 0 : テキスト
  • 1: バナー
  • 3: 外部バナーURL
  • 以外: 指定なし
alt: 画像が表示できないときの代替テキスト。外部代替テキストを指定する(alt_flgが0の)場合は必須。

alt_banner_image: 代替バナー画像ソースファイル。外部代替画像を指定する(alt_flgが1の)場合は必須。
        file_url : アップロードされた代替バナーのURL
 
filename : アップロードされたファイル名(暗号化済み)。

width : 画像の横サイズ。

height : 画像の縦サイズ。

public_filename : 画像へのフルパス。

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

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

external_alt_image_url : 画像の外部URL。外部代替画像URLを指定する(alt_flgが3の)場合は必須。


[HTML広告]
code : HTMLコード


Comments