google. ima. AdDisplayContainer
このクラスは、広告を表示するためのコンテナを表します。SDK は、動画広告やオーバーレイ広告を格納するための構造体を containerElement パラメータ内に自動的に作成します。
このクラスのインスタンスが作成されると、containerElement に iframe が作成され、SDK コアが読み込まれます。SDK を正常に機能させるには、この iframe を保持する必要があります。すべての広告が再生され、SDK が不要になった場合は、destroy()
メソッドを使用して SDK をアンロードします。
containerElement パラメータは、DOM の一部である必要があります。広告を正しく表示するには、containerElement を正しく配置する必要があります。コンテンツ動画プレーヤーの上に配置し、動画プレーヤー全体を対象とするサイズにすることをおすすめします。推奨実装の詳細については、SDK ドキュメントをご覧ください。
注: ユーザーの操作(クリックやタップなど)によって直接呼び出されるコードで、必ず initialize()
メソッドを呼び出す必要があります。
コンストラクタ
ディスプレイ広告コンテナ
新しい AdDisplayContainer(containerElement、videoElement、clickTrackingElement)
パラメータ |
|
---|---|
containerElement |
広告を表示する要素。AdDisplayContainer を作成する前に、要素を DOM に挿入する必要があります。 値を null にすることはできません。 |
動画要素 |
任意 代替の動画広告再生要素を指定します。常にコンテンツ動画プレーヤーを渡すことをおすすめします。 値を null にすることはできません。 |
clickTrackingElement |
任意 代替の動画広告クリック要素を指定します。SDK でクリックを処理できるようにするには、null のままにします。指定した場合でも、動画プレーヤーが UI 要素に対応していない環境(iPhone や 4.0 より前の Android など)で AdSense/AdX 以外のクリエイティブが表示されている場合にのみ、SDK はカスタム クリック トラッキング要素を使用します。SDK がレンダリングする UI 要素に対するクリックをインターセプトできるため、カスタム クリック トラッキング要素は動画プレーヤーの上にレンダリングしないでください。なお、この SDK がカスタム クリック トラッキング要素の公開設定を変更することはありません。つまり、カスタム クリック トラッキング要素が指定されている場合は、線形広告が再生される際にそれを適切に表示する必要があります。 ima.AdEvent.Type.STARTED イベントが発生したときに ima.Modifier.isCustomClickTrackingUsed をチェックして、カスタム クリック トラッキング要素を表示するかどうかを決定できます。UI に適している場合、ima.AdEvent.Type.CONTENT_RESUME_REQUESTED イベントが発生したときにクリック トラッキング要素を非表示にする必要があります。 値を null にすることはできません。 |
Methods
destroy
destroy()
内部状態と以前に作成した DOM 要素を破棄します。 IMA SDK はアンロードされ、それ以降は API を呼び出さないでください。
initialize
initialize()
再生用の内部動画要素を初期化します。動画アクションをユーザー開始としてマークできるように、このメソッドはユーザー アクションの直接の結果として呼び出す必要があります。
一部のブラウザでは、動画がミュート状態のときに、ユーザーによる操作なしで動画を再生できます。この動作については、AdsRequest.setAdWillPlayMuted(true)
を使用し、AdsManager.start()
の前にこのメソッドを呼び出してください。