クラス: AdEvent

google.ima.AdEvent

class static

このイベントタイプは、広告の状態が変化したときと、ユーザーが広告を操作したときに通知として発生します。たとえば、広告の再生が開始したときや、クリックされたときなどがこれにあたります。状態の変化に応じてさまざまなイベントを Modifier に登録できます。

列挙

タイプ

静的

string

AdEvent のタイプ

値
AD_CAN_PLAY	広告の開始時またはバッファリングが完了した後、広告がバッファリングなしで再生できる状態になったときに呼び出されます。
CONTENT_PAUSE_REQUESTED（コンテンツの登録リクエスト）	コンテンツを一時停止する必要があるときに呼び出されます。これは通常、広告がコンテンツを覆う直前に発生します。
CONTENT_RESUME_REQUESTED（コンテンツ リクエストの概要）	コンテンツを再開すると呼び出されます。これは通常、広告が終了したか、折りたたまれたときに発生します。
CLICK	広告がクリックされると呼び出されます。
動画クリック	動画広告の非クリックスルー部分がクリックされると呼び出されます。
VIDEO_ICON_CLICKED（動画アイコンのクリック）	ユーザーが動画アイコンをクリックすると呼び出されます。
開始日	広告の再生が開始されると呼び出されます。
AD_PROGRESS（続行）	広告の現在の時間値が変更されたときに呼び出されます。このイベントで getAdData() を呼び出すと、AdProgressData オブジェクトが返されます。
AD_BUFFERING（購入者のバグ）	広告の読み込みがバッファリングで停止すると呼び出されます。
インプレッション	インプレッション URL が ping されると呼び出されます。
一時停止中	広告が一時停止すると呼び出されます。
再開	広告の再開時に呼び出されます。
FIRST_QUARTILE	広告のプレイヘッドが 25% を超えた時点で呼び出されます。
ミッドポイント	広告のプレイヘッドがミッドポイントを超えると呼び出されます。
サードパーティ製の四角形	広告のプレイヘッドが 75% を超えると呼び出されます。
完了	広告の再生が終了すると呼び出されます。
DURATION_CHANGE（時間変更）	広告の再生時間が変化したときに呼び出されます。
USER_CLOSE	ユーザーが広告を閉じると呼び出されます。
読み込み済み	広告データが利用可能になると呼び出されます。
ALL_ADS_COMPLETED	広告マネージャーが広告レスポンスで有効な広告をすべて再生するか、レスポンスで有効な広告が返されない場合に呼び出されます。
SKIPPED	ユーザーが広告をスキップすると呼び出されます。
LINEAR_CHANGED 回	表示された広告がリニアからノンリニア、またはその逆に変化したときに呼び出されます。
SKIPPABLE_STATE_CHANGED	表示された広告のスキップ可能状態が変更されると呼び出されます。
広告メタデータ	広告リストの読み込み時に呼び出されます。
AD_BREAK_READY	autoPlayAdBreaks が false の場合に広告ルールまたは VMAP 広告ブレークが再生されると呼び出されます。
ログの	致命的でないエラーが発生したときに呼び出されます。SDK はエラー状況に応じて同じまたは次の広告再生を続行するため、ユーザーが何か操作する必要はありません。
ボリュームの変化	広告ボリュームが変更されると呼び出されます。
ボリューム	広告ボリュームがミュートされているときに呼び出されます。
操作	広告が操作コールバックをトリガーすると呼び出されます。広告インタラクションは、広告データ内のインタラクション ID を含んでいます。

プロパティ

タイプ

静的

string

AdEvent のタイプ

値
AD_CAN_PLAY	広告の開始時またはバッファリングが完了した後、広告がバッファリングなしで再生できる状態になったときに呼び出されます。
CONTENT_PAUSE_REQUESTED（コンテンツの登録リクエスト）	コンテンツを一時停止する必要があるときに呼び出されます。これは通常、広告がコンテンツを覆う直前に発生します。
CONTENT_RESUME_REQUESTED（コンテンツ リクエストの概要）	コンテンツを再開すると呼び出されます。これは通常、広告が終了したか、折りたたまれたときに発生します。
CLICK	広告がクリックされると呼び出されます。
動画クリック	動画広告の非クリックスルー部分がクリックされると呼び出されます。
VIDEO_ICON_CLICKED（動画アイコンのクリック）	ユーザーが動画アイコンをクリックすると呼び出されます。
開始日	広告の再生が開始されると呼び出されます。
AD_PROGRESS（続行）	広告の現在の時間値が変更されたときに呼び出されます。このイベントで getAdData() を呼び出すと、AdProgressData オブジェクトが返されます。
AD_BUFFERING（購入者のバグ）	広告の読み込みがバッファリングで停止すると呼び出されます。
インプレッション	インプレッション URL が ping されると呼び出されます。
一時停止中	広告が一時停止すると呼び出されます。
再開	広告の再開時に呼び出されます。
FIRST_QUARTILE	広告のプレイヘッドが 25% を超えた時点で呼び出されます。
ミッドポイント	広告のプレイヘッドがミッドポイントを超えると呼び出されます。
サードパーティ製の四角形	広告のプレイヘッドが 75% を超えると呼び出されます。
完了	広告の再生が終了すると呼び出されます。
DURATION_CHANGE（時間変更）	広告の再生時間が変化したときに呼び出されます。
USER_CLOSE	ユーザーが広告を閉じると呼び出されます。
読み込み済み	広告データが利用可能になると呼び出されます。
ALL_ADS_COMPLETED	広告マネージャーが広告レスポンスで有効な広告をすべて再生するか、レスポンスで有効な広告が返されない場合に呼び出されます。
SKIPPED	ユーザーが広告をスキップすると呼び出されます。
LINEAR_CHANGED 回	表示された広告がリニアからノンリニア、またはその逆に変化したときに呼び出されます。
SKIPPABLE_STATE_CHANGED	表示された広告のスキップ可能状態が変更されると呼び出されます。
広告メタデータ	広告リストの読み込み時に呼び出されます。
AD_BREAK_READY	autoPlayAdBreaks が false の場合に広告ルールまたは VMAP 広告ブレークが再生されると呼び出されます。
ログの	致命的でないエラーが発生したときに呼び出されます。SDK はエラー状況に応じて同じまたは次の広告再生を続行するため、ユーザーが何か操作する必要はありません。
ボリュームの変化	広告ボリュームが変更されると呼び出されます。
ボリューム	広告ボリュームがミュートされているときに呼び出されます。
操作	広告が操作コールバックをトリガーすると呼び出されます。広告インタラクションは、広告データ内のインタラクション ID を含んでいます。

Methods

getAd

getAd() は Ad を返します。

再生中または再生中の広告を取得します。

戻り値

nullable Ad イベントに関連付けられている広告。関連する広告がない場合は null です。

getAdData

getAdData() がオブジェクトを返す

広告から追加のデータを渡すことができる。

例:

if (event.type == google.ima.AdEvent.Type.LOG) {
  let adData = event.getAdData();
  if (adData['adError']) {
    console.log('Non-fatal error occurred: ' +
        adData['adError'].getMessage());
  }
}

戻り値

nullable Object イベントの追加データです。エラーイベントが発生すると、「google.ima.AdError」タイプのオブジェクトが生成されます。このオブジェクトには、「adError」キーを使用してアクセスできます。