広告セット

広告セットとは、再生中のアセットの広告体験を制御する広告設定です。

広告セットルートは広告セット名を作成、削除、変更し、アセットに広告セットを割り当てます。その他すべての広告挙動はBacklot UIで定義します。

広告セットの作成

[POST] /v2/ad_sets 
{
  properties
}
   

広告セットに広告を追加

[POST] /v2/ad_sets/ad_set_id/ads 
{
  properties
}
   

広告セットの一覧

[GET] /v2/ad_sets
   

広告セットの取得

[GET] /v2/ad_sets/ad_set_id
   

広告セットの修正

[PATCH] /v2/ad_sets/ad_set_id
{
  properties
}
   

広告セットの削除

[DELETE] /v2/ad_sets/ad_set_id
   

広告セットから広告を削除

[DELETE] /v2/ad_sets/ad_set_id/ads/ad_id
   

ルート属性

次の表はルートに表示されるすべて属性を示しています。

ルート属性 説明
ad_id 広告のID。

タイプ:文字列

デフォルト:なし

例: da1c1a4bd90c48c39d7ce3e8347bd758

ad_set_id

広告セットのID。広告ルール一覧を取得するために、/v2/ad_setsルートに対してGETを実行してください。

タイプ:文字列

デフォルト:なし

例:/ad_sets/IzNnllMjphu2XF3_UgPROoCi9B2BwtSg

プロパティ

次の表は広告セットと関連付けることができるすべてのプロパティを示しています。

プロパティ 説明 必須?
default

もし‘true’なら、この広告セットは、コンテンツライブラリに追加された動画に自動的に適用されます。このフィールドを‘true’と設定できる広告セットは1つだけです。

タイプ:文字列

有効値: true | false

例:"true"

はい
id 広告セットのユニークな識別子。

例:"Erk3j4k98dh34kshdjf892kjvmF7Diew"

はい
name 広告セット名。

タイプ:文字列

例:"asset"

はい

次の表は広告と関連付けられるすべてのプロパティを示しています。

プロパティ 説明 必須?
ad_source

広告ソース。

タイプ:文字列

有効値: assets | ad_network_id.広告ソースをご覧ください。

デフォルト: video

例:"video"

はい
ad_type

広告のタイプ。

タイプ:文字列

有効値: preroll | postroll | midroll | cuepoint

デフォルト: asset

例:"preroll"

 
click_url

ユーザーが広告をクリックする際リダイレクトされるURL。

タイプ:文字列

デフォルト:なし

例:"http://www.myclickurl.com"

はい
duration

ミリ秒の単位で広告の長さを表示。

タイプ:文字列

デフォルト:なし

条件:ad_sourceは“assets”に設定

例:"My Movie"

条件付き
embed_code

広告として使われるアセットの識別子。

タイプ:整数

デフォルト:なし

条件:ad_sourceは“assets”に設定

例:"01M2F0MTr3SWBB9dfAPT5xEsg8Gpy-jP"

条件付き
id ユニークに広告を広告セットと関連付ける文字列。

タイプ:文字列

有効 値: assets | ad_network_id

デフォルト: video

例:"video"

はい
name

広告として使われるアセットの識別子。

タイプ:整数

デフォルト:なし

条件:ビデオの場合、必須。

例:"10000"

条件付き
plays_before

広告は最初のx再生後表示されます。

タイプ:整数

デフォルト:なし

例:"3"

はい
plays_between

広告は、x再生の度に、最初に表示されます。

タイプ:DateTime

デフォルト:なし

例:"3"

いいえ
position

動画の再生中に広告が再生される時を表示します。

タイプ:文字列

デフォルト:なし

条件:ad_sourceは“midroll”に設定

例:"3000"

条件付き
position_type

は、位置をミリ秒で計測するか、動画の長さのパーセンテージで計測するかを表します。

タイプ:文字列

有効値: milliseconds | percent

デフォルト:なし

条件:ad_sourceは“midroll”に設定

例:

条件付き
tag_url

広告タグを含むXMLファイルへのURL。

タイプ:文字列

デフォルト:なし

条件:サードパーティーの広告に適用

例:"http://cdn.mycdn.com/mytag2.xml"

条件付き
tracking_pixel_url

広告の再生時には、必ずこのURLがPing送信されます。

タイプ:文字列

デフォルト:なし

例:"http://www.mytrackingpixel.com"

いいえ

この例は広告セットを作成します。

[POST] /v2/ad_sets
{
  "name": "My new Ad Set",
  "default": true
}
    

Backlot は次のようなレスポンスを返します。

{
    "default": "true",
     "id": "ed4a4c6abdfc4ab8aa3e7b8a05f31ec6",
     "ads": [  ],
     "name": "My new Ad Set"
} 	   
    

Sorting 試行する

この例は広告を広告セットに追加します。

[POST] /v2/ad_sets/ed4a4c6abdfc4ab8aa3e7b8a05f31ec6/ads
    {
      "ad_source": "assets",
      "ad_type": "preroll",
      "embed_code": "01M2F0MTr3SWBB9dfAPT5xEsg8Gpy-jP",
      "plays_before": 0,
      "plays_between": 1,
      "click_url": "http://www.myclickurl.com",
      "tracking_pixel_urls": ["http://www.mytrackingpixel.com"]
    }
    

Backlot は次のようなレスポンスを返します。

{
 "click_url": "http://www.myclickurl.com",
 "ad_type": "preroll",
 "id": "da1c1a4bd90c48c39d7ce3e8347bd758",
 "tracking_pixel_urls": [   "http://www.mytrackingpixel.com"  ],
 "ad_source": "assets",
 "embed_code": "xkdG43NjrlM92YJ1HzaqiWQ3SZpO5da7",
 "name": "bleebleblobble 2.mov",
 "duration": "5038"
}
    

Sorting 試行する

広告ソース

AdTech
AdTechオーバーレイ
Adap.tv
Adify インストリーム
Adifyオーバーレイ
Atlas
BrightRoll インストリーム
BrightRoll オーバーレイ
CBS Interactive
Dart Enterprise (VAST)
Dart Enterprise オーバーレイ(VAST)
Dev Ad ディスプレイ
Dev Ad ディスプレイオーバーレイ
Dev Ad マネージャー
DoubleClick
DoubleClickオーバーレイ
EyeWonder
Freewheel
Freewheel OPFモジュール
Freewheelオーバーレイ
Freewheelコマーシャルブレイク
Googleアドセンスエンドキャップ
Googleアドセンスオーバーレイ
Googleアドセンスビデオ
HIRO-Media
LightningCast
LiveRail
LiveRail (VAST) インストリーム
LiveRail (VAST) オーバーレイ
Ooyala インストリーム
Open AdStream
Open AdStreamオーバーレイ
OpenX インストリーム
OpenX オーバーレイ
ScanScout
ScanScout (モバイル)
SpotXchange
TV2N
The Video Network
The Video Platform
Tremor Media - Acudeo
Tremor Media - Acudeo Lite
VASTに準拠したインストリーム
VASTに準拠したオーバーレイ
Videoplaza
Yahoo
YuMe オーバーレイ
YuMe ビデオ
アセット

この記事はお役にたちましたか?