google.
google.ima 名前空間を使用すると、SDK のクラス、インターフェース、列挙、プロパティにアクセスできます。
クラス
広告
さまざまな広告タイプを表すクラスにより拡張される広告クラス。
AdCuePoints
キューポイント リストは、広告ブレークのスケジュールを表します。広告ブレーク内の個々の広告はスケジュールに含まれません。
AdDisplayContainer
このクラスは、広告を表示するためのコンテナを表します。動画広告やオーバーレイ広告を格納するための構造が、SDK によって containerElement パラメータ内に自動的に作成されます。
このクラスのインスタンスを作成すると、containerElement で IFRAME が作成され、SDK コアが読み込まれます。SDK が正常に機能するには、この IFRAME を保持する必要があります。すべての広告が再生され、SDK が不要になったら、destroy() メソッドを使用して SDK をアンロードします。
containerElement パラメータは、DOM の一部である要素にする必要があります。広告を正しく表示するには、containerElement を適切に配置する必要があります。コンテンツ動画プレーヤーの上に配置し、動画プレーヤー全体を覆うように配置することをおすすめします。推奨される実装の詳細については、SDK のドキュメントをご覧ください。
注: ユーザーの操作（クリックやタップなど）によって直接呼び出されるコードでは、常に initialize() メソッドを呼び出す必要があります。
AdError
AdError は、広告の読み込み中と再生中に発生したエラーに関する情報をユーザーに表示します。errorType アクセサは、広告の読み込み中か広告の再生中にエラーが発生したかに関する情報を提供します。
AdErrorEvent
このイベントは、Google または DoubleClick のサーバーから広告を読み込む際にエラーが発生すると発生します。イベントに登録できる型は、AdsLoader と LiveData です。
AdEvent
このイベントタイプは、広告の状態が変更されたときや、ユーザーが広告を操作したときに、通知として発生します。たとえば、広告の再生、クリックなどが考えられます。LiveData では、状態変更イベントを登録できます。
AdMetadataEvent
このクラスは非推奨となりました。LiveData.getCuePoints() API を使用します。 メタデータを含む特定の広告イベント。
AdPodInfo
広告は、連続配信広告の一部に含まれる場合もある。このオブジェクトは、Pod 内の広告の数や連続配信広告内の広告位置など、その Pod に関連するメタデータを公開します。
多くの場合、このオブジェクトに含まれる getTotalAds API は適切ですが、SDK の最良の推測を表します。詳細については、このメソッドのドキュメントをご覧ください。
AdProgressData
このオブジェクトは、広告の再生中に現在の進行状況に関する情報を公開します。
AdsLoader
AdsLoader を使用すると、クライアントは広告サーバーに広告をリクエストできます。そのためには、LiveDataLoaderEvent イベントに登録してから広告をリクエストする必要があります。
広告主
外部公開 API をパブリッシャーに提供し、広告マネージャーの内部インスタンスと通信します。
広告の読み込みイベント
このイベントは、AdsLoader を介して Google または DoubleClick 広告サーバーから広告が正常に読み込まれたときに発生します。このイベントは AdsLoader に登録できます。
AdsRenderingSettings
広告のレンダリングを制御するパラメータを定義します。
AdsRequest
広告リクエストのプロパティを指定するクラス。
コンパニオン広告
コンパニオン広告を表します。
CompanionAdSelectionSettings
CompanionAdSelectionSettings オブジェクトは、ima.Ad.getCompanionAds 関数を呼び出すときの選択条件を定義するために使用されます。
ImaSdkSettings
このクラスには SDK 全体の設定が含まれます。
ユニバーサル広告 ID 情報
このオブジェクトは、広告 ID 値や広告 ID レジストリなど、クリエイティブに関連付けられたユニバーサル広告 ID に関する情報を公開します。
列挙型
OmidAccessMode
string
ウェブ用の OMID で利用可能なアクセスモードによって、検証スクリプトがアクセスできる量を制御します。
値 |
|
|---|---|
|
LIMITED |
検証スクリプトはサンドボックス化されており、クリエイティブまたはパブリッシャーのページにアクセスすることはできません。また、スクリプトがどのパブリッシャーのドメインになっているかを直接確認することもできません。 |
|
DOMAIN |
確認スクリプトはサンドボックス化されており、クリエイティブまたはパブリッシャーのページにはアクセスできません。ただし、そのスクリプトは、どのパブリッシャー ドメイン上にあるかを直接確認できる方法で読み込まれます。 |
|
FULL |
検証スクリプトは、クリエイティブとパブリッシャーのページに直接アクセスできます。 |
OmidVerification ベンダー
数値
OMID 検証ベンダーを識別します。ベンダーはアルファベット順に表示されます。
値 |
|
|---|---|
|
注意 |
|
|
DourbleVerify |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
手法 |
|
|
MOAT |
|
|
ニールセン |
|
|
Google Pixel |
|
|
その他 |
スクリプト URL が他のベンダーと一致しない場合に使用するデフォルト ベンダー。 |
UI 要素
string
表示または非表示を構成できる各種 UI 要素を指定する列挙型。AdSense と ADX の広告の場合、これらの設定は無視される可能性があります。
値 |
|
|---|---|
|
AD_ATTRIBUTION（ADT 識別子） |
広告 UI に「広告」テキストが表示されます。カウントダウン タイマーを表示するには必要です。 |
|
COUNTDOWN |
カウントダウン タイマーを表示するには、広告の帰属表示が必要です。 |
表示モード
string
広告のさまざまな VPAID ビューモードを指定する列挙型。
値 |
|
|---|---|
|
標準 |
通常の広告ビューモード。 |
|
全画面表示 |
全画面広告モード。パブリッシャーが現在の AdDisplayContainer 配置を全画面表示だと考えていることをアド マネージャーに示します（全画面のシミュレーションなど）。これにより、アド マネージャーが全画面表示にはなりません。 |
- 非推奨
プロパティ
OmidAccessMode
string
ウェブ用の OMID で利用可能なアクセスモードによって、検証スクリプトがアクセスできる量を制御します。
値 |
|
|---|---|
|
LIMITED |
検証スクリプトはサンドボックス化されており、クリエイティブまたはパブリッシャーのページにアクセスすることはできません。また、スクリプトがどのパブリッシャーのドメインになっているかを直接確認することもできません。 |
|
DOMAIN |
確認スクリプトはサンドボックス化されており、クリエイティブまたはパブリッシャーのページにはアクセスできません。ただし、そのスクリプトは、どのパブリッシャー ドメイン上にあるかを直接確認できる方法で読み込まれます。 |
|
FULL |
検証スクリプトは、クリエイティブとパブリッシャーのページに直接アクセスできます。 |
OmidVerification ベンダー
数値
OMID 検証ベンダーを識別します。ベンダーはアルファベット順に表示されます。
値 |
|
|---|---|
|
注意 |
|
|
DourbleVerify |
|
|
|
|
|
INTEGRAL_AD_SCIENCE |
|
|
手法 |
|
|
MOAT |
|
|
ニールセン |
|
|
Google Pixel |
|
|
その他 |
スクリプト URL が他のベンダーと一致しない場合に使用するデフォルト ベンダー。 |
UI 要素
string
表示または非表示を構成できる各種 UI 要素を指定する列挙型。AdSense と ADX の広告の場合、これらの設定は無視される可能性があります。
値 |
|
|---|---|
|
AD_ATTRIBUTION（ADT 識別子） |
広告 UI に「広告」テキストが表示されます。カウントダウン タイマーを表示するには必要です。 |
|
COUNTDOWN |
カウントダウン タイマーを表示するには、広告の帰属表示が必要です。 |
表示モード
string
広告のさまざまな VPAID ビューモードを指定する列挙型。
値 |
|
|---|---|
|
標準 |
通常の広告ビューモード。 |
|
全画面表示 |
全画面広告モード。パブリッシャーが現在の AdDisplayContainer 配置を全画面表示だと考えていることをアド マネージャーに示します（全画面のシミュレーションなど）。これにより、アド マネージャーが全画面表示にはなりません。 |
- 非推奨
設定にアクセスする必要があります。
null 以外の ImaSdkSettings
グローバル シングルトン設定インスタンス。