VPAID 2 JavaScript クリエイティブを有効にする

IMA HTML5 SDK は VPAID 2 JavaScript クリエイティブに対応しています。サポートを有効にする場合、VPAID 2 仕様と IMA SDK による VPAID 2 のサポート方法には、注意すべき 2 つの大きな違いがあります。これらの違いはプレーヤーや SDK の実装コードには影響しませんが、IMA HTML5 SDK でレンダリングされたときにクリエイティブがエラーをスローしたり、期待どおりに動作しなかったりする可能性があるため、VPAID 2 JavaScript クリエイティブの作成者にとっては重要です。

前提条件

このガイドに沿って作業を進めるには、次のものを含むアプリから始めます。

  • IMA HTML5 SDK が統合された HTML5 動画プレーヤー。まだお持ちでない場合は、IMA SDK を設定するをご覧ください。
  • VPAID 2 JavaScript クリエイティブを指す VAST 広告タグ URL。

役立つ入門ガイド

VPAID 2 のサポートを有効にする

VPAID 2 JavaScript のサポートを有効にするには、AdDisplayContainer を初期化する前に次のメソッドを呼び出します。

google.ima.settings.setVpaidMode(google.ima.ImaSdkSettings.VpaidMode.ENABLED);
...
var adDisplayContainer = new google.ima.AdDisplayContainer(adContainerElement);
var adsLoader = new google.ima.AdsLoader(adDisplayContainer);
...

使用可能な VPAID モードは次のとおりです。

  • ENABLED - デフォルト設定の VPAID 広告を許可します。
  • INSECURE - 安全でないモードで VPAID 広告を許可します。詳細については、IFrame のセキュリティと動画プレーヤーのプロキシ要素をご覧ください。
  • DISABLED - VPAID 広告が再生されない。リクエストされた広告で VPAID クリエイティブが返された場合、エラーがスローされます。

VPAID モードの詳細については、ImaSdkSettings.VpaidMode の API ドキュメントをご覧ください。

VPAID 2 のサポートに関する注意点

IFrame のセキュリティ

デフォルトでは、IMA SDK は Friendly iframe（同じドメイン）またはページ内スクリプトの代わりにセキュア iframe を使用して、VPAID 2 JavaScript クリエイティブをレンダリングします。つまり、クリエイティブが親ページの DOM にアクセスすることを想定している場合、エラーが発生する可能性があります。代わりに Friendly iFrame で広告をレンダリングするには、次のように ImaSdkSettings.setVpaidMode(...) を使用します。

adsLoader.getSettings().setVpaidMode(google.ima.ImaSdkSettings.VpaidMode.INSECURE);

動画プレーヤーのプロキシ要素

セキュリティとモバイル機能の適切な動作のため、ENABLED モードでは、IMA HTML5 SDK は実際の動画要素を広告に提供しません。代わりに、通常の動画要素の機能の多くを模倣したプロキシ要素を提供します。サポートされている API メソッドのみを呼び出す広告クリエイティブの場合、クリエイティブのレンダリングの動作に変更はありません。VpaidMode.INSECURE モードでは、SDK はプロキシではなく動画プレーヤー要素を提供します。

動画プロキシ要素で使用できるメソッド、リスナー、属性は次のとおりです。

メソッド

  • addEventListener
  • canPlayType
  • load
  • play
  • pause
  • setattribute

addEventListener のイベントタイプ

  • abort
  • canplay
  • canplaythrough
  • click
  • durationchange
  • emptied
  • ended
  • error
  • loadeddata
  • loadedmetadata
  • loadstart
  • pause
  • play
  • playing
  • progress
  • ratechange
  • suspend
  • seeked
  • seeking
  • timeupdate
  • waiting

属性

  • currentTime
  • duration
  • ended
  • paused
  • playbackRate
  • src
  • type

よくある質問

iOS または Android SDK で VPAID 2 JavaScript クリエイティブはサポートされていますか？
IMA HTML5 SDK は、VPAID 2 JavaScript クリエイティブをサポートする唯一の IMA SDK プラットフォームです。
これにより、IMA HTML5 SDK で VPAID クリエイティブが有効になりますか？
はい。IMA HTML5 SDK は VPAID 2 JavaScript クリエイティブに対応しています。