カスタマイズ
基本機能
プレイリスト
広告
広告機能を利用するときは、optionとしてgoogleのima3.jsを読み込む必要があります。
<!-- Option/Advertising -->
<script src="//imasdk.googleapis.com/js/sdkloader/ima3.js"></script>
仕様
| パラメーター名 | 型 | 値 | 設定 | デフォルト値 |
|---|---|---|---|---|
| advertising | object | admessage,cuetext,skipmessage,skiptext,skipoffset,tag,autoplayadsmuted,schedule | 任意 | - |
説明
ビデオグプレーヤーに広告を設定します。
advertising.object
仕様
| パラメーター名 | 型 | 値 | 設定 | デフォルト値 |
|---|---|---|---|---|
| admessage | string | text | 任意 | この動画はxx秒後に終わります |
| cuetext | string | text | 任意 | 広告 |
| skipmessage | string | text | 任意 | 広告終了までxx秒 |
| skiptext | string | text | 任意 | スキップ |
| skipoffset | number | number | 任意 | null |
| tag | string | url | 任意 | - |
| autoplayadsmuted | boolean | true,false | 任意 | true |
| schedule | string,object | xml,json | 任意 | - |
説明
| パラメーター名 | 説明 |
|---|---|
| admessage | 広告の再生中にシークバーに表示されるテキストを設定します。 |
| cuetext | 視聴者が広告にマウスを重ねるときに表示されるテキストを設定します。 |
| skipmessage | ※VASTのみ。 シークバー右上に表示されるカスタマイズされたカウントダウンメッセージを提供するために使用します。 |
| skiptext | ※VASTのみ。カウントダウンが終了した後にスキップボタンのテキストを設定します。 |
| skipoffset | ※VASTのみ。スキップボタンが押せるまでの時間を指定します。値がnullの場合は、スキップボタンは非表示になります。 |
| tag | ※googleIMAのみ。ここにURLが指定されている場合は、advertising.scheludeは無効になります。 |
| autoplayadsmuted | ※VASTのみ。モバイルデバイスで表示されたときにミュートされるインラインプレイヤーの場合、広告をミュートにできます。trueはミュート、falseは音声あり。 |
| schedule | XMLまたはJSONブロックから広告スケジュールを読み込みます。このオプションが設定されているとadvertising.tagは無効になります。 |
advertising.schedule.object
仕様
| パラメーター名 | 型 | 値 | 設定 | デフォルト値 |
|---|---|---|---|---|
| schedule | object | preroll,midroll,postroll | 任意 | - |
説明
| パラメーター名 | 説明 |
|---|---|
| preroll | 動画本編の前に広告が表示されます。 |
| midroll | 動画本編の途中に広告が表示されます。複数設定できます。 |
| postroll | 動画本編の後に広告が表示されます。 |
advertising.schedule.adbreak.object
仕様
| パラメーター名 | 型 | 値 | 設定 | デフォルト値 |
|---|---|---|---|---|
| adbreak.client | string | vast,googleima | 必須 | null |
| adbreak.tag | string | url | 必須 | この動画はxx秒後に終わります |
| adbreak.offset | string,number | %,number | 任意 | 50% |
説明
| パラメーター名 | 説明 |
|---|---|
| adbreak.client | 広告を表示するために使用される広告クライアントを選択します。 |
| adbreak.tag | 表示するタグのURLを設定します。 |
| adbreak.offset | ※midrollのみ。"xx％"：コンテンツのxx％後に広告が再生されます。number：指定した秒数が経過すると広告が再生されます。 |
コードサンプル
<script>
const options = {
playlist: [
{
advertising: {
admessage: "この動画はxx秒後に終わります",
cuetext: "広告",
skipmessage: "広告終了までxx秒",
skiptext: "スキップ",
skipoffset:5,
tag: "https://sample1.jp/ads",
autoplayadsmuted: true
},
...
},
],
};
const options2 = {
playlist: [
{
advertising: {
admessage: "この動画はxx秒後に終わります",
cuetext: "広告",
skipmessage: "広告終了までxx秒",
skiptext: "スキップ",
schedule: {
preroll: {
client: "vast",
tag: "https://sample1.jp/ads"
},
midroll: [
{
client: "vast",
tag: "https://sample1.jp/ads2",
offset: "3"
},
{
client: "vast",
tag: "https://sample1.jp/ads3",
offset: "50%"
}
],
postroll:{
client: "vast",
tag: "https://sample1.jp/ads4"
}
}
},
...
},
],
};
const player = videogplayer('video_tag_id', options);
</script>