動的に広告ポリシを設定する

Player API の Advertising モジュールの setAdPolicy メソッドを使用して、プレーヤの広告ポリシをオーバーライドできます。このメソッドを使用すると、プレーヤの広告要求を制御するポリシをその場で変更できます。たとえば、プレーヤで利用できる任意のプロパティ値に基づいて、広告サーバー URL、キーと値のペア、広告挿入ポイントなどを即座に変更できます。setAdPolicy() を使用してプレーヤの広告ポリシに対して行った変更は、プレーヤの今回のロードに限って適用されます。プレーヤの次回ロード時には、再度 setAdPolicy() が呼び出されなければ、Advertising モジュールで定義された広告ポリシが使用されます。

たとえば、Advertising モジュールで Brightcove プレーヤの広告ポリシを、動画 3 本ごとにプレロール広告を表示するように設定してあるとします。Web サイトでは、登録ユーザーは広告なしでコンテンツを見られるようにし、それ以外の訪問者にはプレロール広告を表示します。setAdPolicy() メソッドを使用すると、登録ユーザーがプレーヤをロードした場合にプレロール広告要求をオフにできます。このメソッドの使い道は、他にも多数あります。設定可能なプロパティをご覧いただくことをおすすめします。プレーヤの広告ポリシを動的に制御し、動画に適切なタイプの広告をサイト上で配信するために役立ててください。

Player API には、対応する取得メソッドの getAdPolicy があります。このメソッドは、現在の広告ポリシを返します。広告ポリシには設定できない値もあるため、getAdPolicy が返す値のほうが多くなっています。

setAdPolicy を使用する

setAdPolicy メソッドを使用するには、以下の手順を行います。

1. プレーヤの構成でこの API を有効にしておきます。
2. プレーヤへの参照と、Advertising モジュールへの参照を取得します。たとえば、JavaScript では次のように記述します。

   var player;
   var adModule;
           
   // テンプレートがロードされるときに呼び出されます。 
   // モジュールへの参照を保存するのに使用します。
           
   function onTemplateLoaded(pExperience) {
   player= brightcove.getExperience(pExperience);
   adModule = player.getModule(APIModules.ADVERTISING);

3. AdPolicy オブジェクトを作成して、変更する広告ポリシのプロパティを設定し、setAdPolicy メソッドで渡します。

setAdPolicy メソッドのその他の例やリファレンス情報については、Player API リファレンスを参照してください。

AdPolicy オブジェクト

setAdPolicy メソッドは、AdPolicy オブジェクトを受け取ります。次のプロパティを持つオブジェクトです。AdPolicy オブジェクトで定義されていないプロパティは、現在の広告ポリシの値が保持されます。