クラス: LiveData

Methods

折りたたむ

折りたたみ()

現在の広告を折りたたみます。HTML5 SDK では機能はありません。

#よくある質問

configureModifier(content, adsRenderingSettings)

MyGlassLoader イベントからこの AdManager への参照を取得するために必要なパラメータを設定します。

パラメータ

コンテンツ

オブジェクト

パブリッシャーのコンテンツを再生するオブジェクト。

値を null にすることはできません。

adsRenderingSettings

任意

AdsRenderingSettings

広告のレンダリングを制御する、必要に応じて設定を行います。

値は null でもかまいません。

destroy

destroy()

実行時に読み込み、広告終了時に適切に削除する必要がある広告アセットを削除し、広告とすべてのトラッキングを停止します。

破棄広告ブレーク

破棄 AdBreak()

広告ブレークが現在再生されている場合は、破棄してコンテンツを再開します。それ以外の場合は、次回の広告ブレークは無視してください。たとえば、アド マネージャーが読み込まれた直後に呼び出すことで、今後のミッドロールやポストロールを失うことなくプレロールを無視できます。広告リクエストで再生リストまたは VMAP レスポンスが返されない限り、処理は行われません。

expand

expand()

現在の広告を展開します。HTML5 SDK では機能はありません。

ピント

focus()

スキップボタンがある場合は、ボタンにフォーカスを合わせます。存在しない場合は、アイコンやインタラクティブ クリエイティブなどのインタラクティブな要素にフォーカスが当てられます。

getAdSkippableState

getAdSkippableState() がブール値を返す

広告が現在スキップ可能な場合は true を返します。この値が変更されると、AdsManagerAdEvent.SKIPPABLE_STATE_CHANGED イベントを呼び出します。

戻り値

boolean現時点で広告がスキップ可能な場合は true、それ以外の場合は false です。

getCuePoints

getCuePoints() は数値の配列を返します

スケジュールされた広告ブレークの再生タイミングを示すオフセットの配列を秒単位で返します。プレロールは 0、ポストロールは -1 を表します。空の配列は、広告または連続配信広告のスケジュールが設定されず、いつでも再生できることを示します。

戻り値

non-null Array of number 時間オフセットのリスト(秒)。

getRemainingTime

getRemainingTime() は数値を返す

再生中の広告の残り時間を取得します。広告がまだ読み込まれていない場合や再生が完了していない場合、API は -1 を返します。

戻り値

number 現在の広告の残り時間を返します。現在の広告(カスタム広告など)で残りの時間が定義されていない場合、値は -1 を返します。

getVolume

getVolume() は数値を返します。

現在の広告のボリュームを取得します。

戻り値

number 現在の広告の音量。0(ミュート)から 1(最大)までです。

init

init(width, height, viewMode, videoElement)

init を呼び出して、広告マネージャーで広告エクスペリエンスを初期化する。

パラメータ

width

数値

広告で選択した幅。

高さ

数値

広告の選択済みの高さ。

表示モード

表示モード

選択した表示モード。

値を null にすることはできません。

動画要素

任意

HTMLVideoElement

カスタム再生用の動画要素。この動画要素は、AdDisplayContainer コンストラクタで提供されている要素よりも優先されます。このプロパティはどうしても必要な場合にのみ使用してください。それ以外の場合は、AdDisplayContainer の作成時にこの動画要素を指定することをおすすめします。

値は null でもかまいません。

isCustomClickTrackingUsed

isCustomClickTrackingUsed() はブール値を返す

現在の広告でクリック トラッキングにカスタム クリック トラッキング要素が使用されている場合、true が返されます。カスタム クリック トラッキングは、オプションのクリック トラッキング要素が AdDisplayContainer に提供され、カスタム再生が使用され、現在の広告が AdSense/AdX 広告でない場合にのみ使用されます。

戻り値

boolean カスタム クリック トラッキングを使用するかどうかを指定します。

isCustomPlaybackUsed

isCustomPlaybackUsed() がブール値を返す

現在の広告の再生にカスタム動画要素が使用されている場合は true を返します。カスタム動画要素でよりシームレスな広告視聴ができるプラットフォームでは、オプションの動画要素が AdDisplayContainer に提供されると、カスタム再生が発生します。

戻り値

boolean カスタム再生を使用するかどうか。

一時停止

Pause()

再生中の広告を一時停止します。この関数は、静的オーバーレイが表示されているとき、または広告がまだ読み込まれていない場合や再生が完了している場合に機能しません。

resize

サイズ変更(幅、高さ、ビューモード)

現在の広告のサイズを変更します。

パラメータ

width

数値

新しい広告スロットの幅。

高さ

数値

新しい広告スロットの高さ。

表示モード

表示モード

新しい表示モード。

値を null にすることはできません。

resume

Resume()

読み込みと一時停止が行われている現在の広告を再開します。この関数は、静的オーバーレイが表示されているとき、または広告がまだ読み込まれていない場合や再生が完了している場合に機能しません。

setVolume

setVolume(volume)

現在の広告の音量を設定します。

パラメータ

Volume

数値

設定する音量(0(ミュート)から 1(最大))です。

スキップ

Skip()

AdsManager.getAdSkippableState() が true の場合、現在の広告をスキップします。他の状況で呼び出されても、スキップしても効果はありません。スキップが完了すると、AdsManagerAdEvent.SKIPPED イベントを呼び出します。

start

start()

広告の再生を開始します。

デベロッパーは最初に AdDisplayContainer.initialize() を呼び出す必要があります。

停止

stop()

広告の再生を停止します。これを呼び出すと、パブリッシャーはコンテンツに戻ります。

updateAdsRenderingSettings

updateAdsRenderingSettings(adsRenderingSettings)

広告レンダリングの設定を更新します。ビットレートなどの広告レンダリング設定を更新する必要がある場合に、ミッドロール挿入点間の VMAP のユースケースで特に使用します。

パラメータ

adsRenderingSettings

AdsRenderingSettings

更新された広告のレンダリング設定。

値を null にすることはできません。