クラス: AdsRequest

コンストラクタ

AdsRequest

新しい AdsRequest()

実装
google.ima.AdsRequestInterface

プロパティ

adTagUrl

string

広告サーバーからリクエストされた広告タグ URL を指定します。 広告タグ URL の作成について詳しくは、 メインの広告タグを手動で作成するをご覧ください。

このパラメータは必須です。

adsResponse

(null、文字列、null 以外のドキュメント)

広告タグ URL からリクエストを行うのではなく、広告レスポンスとして使用する VAST 2.0 ドキュメントを指定します。これは、デバッグや、VAST レスポンスがすでに利用可能な場合などに役立ちます。

このパラメータは省略可能です。

コンテンツの長さ

(null または数値)

コンテンツの表示時間を秒単位で指定します。これは、1)AdX 広告ターゲティングと、2)VMAP ポストロールをプリロードするタイミングの決定という 2 つのケースで使用されます。

このパラメータは省略可能です。

contentKeyword

(null または null 以外の文字列の配列)

表示するコンテンツを表すキーワードを指定します。AdX リクエストで使用されます。

このパラメータはオプションです。

contentTitle

(null または文字列)

表示するコンテンツのタイトルを指定します。AdX リクエストで使用されます。

このパラメータは省略可能です。

forceNonLinearFullSlot

ブール値

ノンリニア AdSense 広告をリニア フルスロットとして強制的に表示します。設定すると、コンテンツ動画が一時停止され、ノンリニア テキスト広告またはイメージ広告がフルスロットとしてレンダリングされます。広告がスキップされるか閉じられると、コンテンツ動画が再開されます。

linearAdSlotHeight

数値

リニア広告が表示される長方形領域の高さを指定します。この値は、広告選択の条件の 1 つとして使用されます。この値は、実際の広告の高さと一致している必要はありません。

このパラメータは必須です。

linearAdSlotWidth

数値

線形広告が表示される長方形の領域の幅を指定します。この値は、広告選択の条件の 1 つとして使用されます。この値は、実際の広告の幅と一致させる必要はありません。

このパラメータは必須です。

liveStreamPrefetchSeconds

数値

requestAds を呼び出してから広告タグ URL をリクエストするまでに待機する最大時間を秒単位で指定します。これを利用して、ライブ ストリーム イベント中のリクエストのタイミングをずらして、リクエスト数の急増を軽減できます。

nonLinearAdSlotHeight

数値

ノンリニア広告を表示する長方形領域の高さを指定します。この値は、広告選択の条件の 1 つとして使用されます。この値は、実際の広告の高さと一致している必要はありません。

このパラメータは必須です。

nonLinearAdSlotWidth

数値

ノンリニア広告を表示する長方形領域の幅を指定します。この値は、広告選択の条件の 1 つとして使用されます。この値は、実際の広告の幅と一致させる必要はありません。

このパラメータは必須です。

omidAccessModeRules

文字列プロパティを持つ null 以外のオブジェクト

確認ベンダーを OMID アクセスモードにマッピングするための設定オブジェクト。 キーは google.ima.OmidVerificationVendor の値で、値は google.ima.OmidAccessMode の値である必要があります。

検証スクリプトの URL は、ベンダーが提供する正規表現と内部的に照合され、OmidVerificationVendor キーに解決されます。次に、IMA はこのオブジェクトを使用して、特定のベンダーのアクセスモードを検索します。

既知のベンダーに解決されないスクリプト URL や、解決された OmidVerificationVendor がこのオブジェクトで指定されていない場合、IMA では OmidVerificationVendor で指定されたアクセスモードが使用されます。OmidVerificationVendor.OTHER が指定されていない場合、アクセス モードが LIMITED になります。

pageUrl

(null または文字列)

ターゲティングのために Google 広告リクエストに含めるページの完全な URL を指定します。URL は有効な URL である必要があります。指定すると、この値は [PAGEURL] VAST マクロで使用されます。

このパラメータは省略可能です。

VAST タイムアウト

数値

単一のラッパーのデフォルト VAST 読み込みタイムアウトをミリ秒単位でオーバーライドします。デフォルトのタイムアウトは 5,000 ミリ秒です。

このパラメータはオプションです。

Methods

setAdWillAutoPlay

setAdWillAutoPlay(autoPlay)が void を返す

プレーヤーがユーザーのアクションに応じてコンテンツと広告を開始しようとするのか、それとも自動的に再生されるのかについて、SDK に通知します。この設定を変更しても、広告再生には影響しません。

パラメータ

自動再生

ブール値

コンテンツと広告が自動再生されるか、ユーザーの操作によって開始されるか。

戻り値

void 

setAdWillPlayMuted

setAdWillPlayMuted(muted) が void を返す

プレーヤーがミュート中に広告を開始するかどうかを SDK に通知します。 この設定を変更しても広告再生には影響しませんが、広告リクエストで適切なシグナルが送信され、購入者がミュートされた広告枠に入札できるようになります。

パラメータ

ミュート中

ブール値

ミュート中に広告を再生するかどうかを指定します。

戻り値

void 

setContinuousPlayback

setContinuousPlayback(continuousPlayback) は、void を返します。

プレーヤーがテレビ放送のようにコンテンツを連続して連続して再生する意向があるかどうかを SDK に通知します。この設定を変更しても広告の再生には影響しませんが、広告リクエストで適切なシグナルが送信され、購入者が広告枠のタイプに入札できるようになります。

パラメータ

連続再生

ブール値

コンテンツの動画が連続して再生されるかどうか。

戻り値

void