クラス: ImaSdkSettings

google.ima.ImaSdkSettings

class public static

このクラスには SDK 全体の設定が含まれます。

列挙型

CompanionBackfillMode（コンパニオン バックフィル モード）

定数 静的

string

コンパニオン バックフィル設定の定数のセットを定義します。この設定は、さまざまなシナリオでコンパニオンをバックフィルする必要があるかどうかを示します。

値を ALWAYS にした場合、メインの広告が返されなかった場合でも、すべての状況でコンパニオン バックフィルが試行されます。

値を ON_MASTER_AD にした場合、メインの広告があり、コンパニオン広告の数がコンパニオン スロットの数より少ない場合、コンパニオン バックフィルが試行されます。見つからないコンパニオンはバックフィルされます。

デフォルト値は ALWAYS です。

クライアントサイドのコンパニオン バックフィルでは、Google パブリッシャー タグ（GPT）を使用してコンパニオンを適切にタグ付けする必要があります。 バックフィルを有効にするには、GPT の標準設定に次の変更を加える必要があります。 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
自動再生動画では、コンパニオン スロットがプリロードされないようにして、直ちにコンパニオンに置き換えられるように、次の変更を行うことをおすすめします。 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

値

ALWAYS

ON_MASTER_AD

VPAID モード

定数 静的

数値

VPAID 機能を有効にするための定数のセットです。

値

無効

VPAID 広告は再生されず、エラーが返されます。

有効

VPAID 広告は、クロスドメインの iFrame を使用して有効化されます。VPAID 広告がサイトにアクセスできません。Friendly iframe アクセスに依存する VPAID 広告はエラーとなる可能性があります。グローバル ウィンドウはデフォルト。

安全

VPAID 広告は、Friendly iframe で有効になります。これにより、JavaScript 経由でサイトにアクセスできるようになります。

プロパティ

CompanionBackfillMode（コンパニオン バックフィル モード）

定数 静的

string

コンパニオン バックフィル設定の定数のセットを定義します。この設定は、さまざまなシナリオでコンパニオンをバックフィルする必要があるかどうかを示します。

値を ALWAYS にした場合、メインの広告が返されなかった場合でも、すべての状況でコンパニオン バックフィルが試行されます。

値を ON_MASTER_AD にした場合、メインの広告があり、コンパニオン広告の数がコンパニオン スロットの数より少ない場合、コンパニオン バックフィルが試行されます。見つからないコンパニオンはバックフィルされます。

デフォルト値は ALWAYS です。

クライアントサイドのコンパニオン バックフィルでは、Google パブリッシャー タグ（GPT）を使用してコンパニオンを適切にタグ付けする必要があります。 バックフィルを有効にするには、GPT の標準設定に次の変更を加える必要があります。 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
自動再生動画では、コンパニオン スロットがプリロードされないようにして、直ちにコンパニオンに置き換えられるように、次の変更を行うことをおすすめします。 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

値

ALWAYS

ON_MASTER_AD

VPAID モード

定数 静的

数値

VPAID 機能を有効にするための定数のセットです。

値

無効

VPAID 広告は再生されず、エラーが返されます。

有効

VPAID 広告は、クロスドメインの iFrame を使用して有効化されます。VPAID 広告がサイトにアクセスできません。Friendly iframe アクセスに依存する VPAID 広告はエラーとなる可能性があります。グローバル ウィンドウはデフォルト。

安全

VPAID 広告は、Friendly iframe で有効になります。これにより、JavaScript 経由でサイトにアクセスできるようになります。

Methods

getCompanionBackfill

getCompanionBackfill() は CompanionBackfillMode を返します。

現在のコンパニオン バックフィル モードを返します。

戻り値

non-null CompanionBackfillMode 現在の値。

getDisableCustomPlaybackForIOS10Plus

getDisableCustomPlaybackForIOS10Plus() がブール値を返す

iOS 10 以降のブラウザでカスタム再生を無効にするかどうかを指定します。デフォルト値は false です。

戻り値

boolean 

getFeatureFlags

getFeatureFlags() は、任意のタイプのプロパティを持つオブジェクトを返します。

キーを特徴フラグとして、値を現在の状態として持つオブジェクトを返します。

戻り値

non-null Object with any type properties 

getLocale

getLocale() は文字列を返す

パブリッシャー指定のロケールを返します。

戻り値

string パブリッシャー指定の言語 / 地域。

getNumRedirects

getNumRedirects() が数値を返す

後続のリダイレクトの拒否の最大数を返します。

戻り値

number: リダイレクトの最大数。

getPlayerType

getPlayerType() は文字列を返す

パートナー提供のプレーヤー タイプを返します。

戻り値

string パートナーのプレーヤー タイプ。

getPlayerVersion

getPlayerVersion() が文字列を返す

パートナー提供のプレーヤーのバージョンを返します。

戻り値

string パートナーのプレーヤー バージョン。

getPpid

getPpid() から返される値（null または文字列）

パブリッシャー指定の ID を返します。

戻り値

(null or string) パブリッシャー指定の ID。

isCookiesEnabled

isCookiesEnabled() はブール値を返します

戻り値

booleanパブリッシャーが Cookie の使用を許可しているかどうか。

setAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) は void を返す

VMAP と広告ルールの広告ブレークを自動的に再生するかどうかを設定します

パラメータ

autoPlayAdBreaks

ブール値

ミッドロール挿入点を自動再生するかどうかを指定します。
戻り値

void 

setCompanionBackfill

setCompanionBackfill(mode) が void を返す

コンパニオン バックフィル モードを設定します。ImaSdkSettings.CompanionBackfillMode で利用できるさまざまなモードをご覧ください。

デフォルトのモードは ImaSdkSettings.CompanionBackfillMode.ALWAYS です。

パラメータ

モード

CompanionBackfillMode（コンパニオン バックフィル モード）

選択したコンパニオン バックフィル モード。

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

void 

setCookiesEnabled

setCookiesEnabled(cookiesEnabled) は void を返す。

SDK がファースト パーティ Cookie としてパブリッシャーのドメインに Google アド マネージャー Cookie（GFP Cookie）を保存するかどうかを指定します。これにより、サードパーティの Cookie を使用せずに、同じドメインに対する複数回の訪問で永続性を確保できます。デフォルトは true です。

この設定は、他の当事者が設定した、またはその他の目的で設定された他の Cookie には影響しません。ユーザーの同意とオプトアウトによってファーストパーティの Cookie の使用も無効になることがあります。パブリッシャー様が IAB 準拠の同意管理プロバイダを使用しているかどうかが、同じフレーム内で収集されます。

パラメータ

cookieEnabled

ブール値
戻り値

void 

setDisableCustomPlaybackForIOS10Plus

setDisableCustomPlaybackForIOS10Plus(disable) が void を返す

iOS 10 以降のブラウザでカスタム再生を無効にするかどうかを指定します。true の場合、コンテンツ動画がインラインである場合に広告がインラインで再生されます。これにより、TrueView のスキップ可能な広告が有効になります。ただし、この広告はインラインで表示されるので、iOS のネイティブ フルスクリーンに対応していません。false の場合、広告はコンテンツと同じプレーヤーで再生されます。AdDisplayContainer の作成時にここで設定した値が、コンテナの全期間にわたって使用されます。デフォルト値は false です。

パラメータ

無効にする

ブール値

カスタム再生を無効にするかどうかを指定します。
戻り値

void 

setFeatureFlags

setFeatureFlags(featureFlags) が void を返す

フィーチャー トグルの値を設定します。これは、広告をリクエストする前にできるだけ早く設定する必要があります。設定は、次の広告リクエストまで変更されません。このメソッドを再度呼び出すと、次の広告リクエストのすべての機能フラグがリセットされます。

パラメータ

featureFlags

任意のタイプのプロパティを持つオブジェクト

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

void 

setLocale

setLocale(locale) は void を返す

パブリッシャー指定の言語 / 地域を設定します。AdsLoader または AdDisplayContainer を作成する前に呼び出す必要があります。ロケールには、UI 要素を表示する言語を指定します。サポートされるコードは、言語とロケールのローカライズに記載されています。

パラメータ

locale

string

パブリッシャー指定の言語 / 地域。
戻り値

void 

setNumRedirects

setNumRedirects(numRedirects) は void を返す

リダイレクトが拒否され、広告の読み込みが中止されるまでのリダイレクトの最大数を指定します。リダイレクトの数はレイテンシに直接影響するため、ユーザー エクスペリエンスにも影響します。これは、すべての VAST ラッパー広告に適用されます。

パラメータ

リダイレクト数

数値

リダイレクトの最大数。
戻り値

void 

setPlayerType

setPlayerType(playerType) が void を返す

パートナー提供のプレーヤー タイプを設定します。この設定を使用して、SDK と統合するプレーヤーの名前を指定する必要があります。20 文字を超えるプレーヤー タイプは切り捨てられます。指定するプレーヤー タイプは短く、一意である必要があります。これはオプションであり、プレーヤー タイプをトラッキングして SDK のユーザビリティを向上させるために使用されます。

例: 


settings.setPlayerType('google/gmf-player');

パラメータ

playerType

string

パートナー プレーヤーのタイプ。
戻り値

void 

setPlayerVersion

setPlayerVersion(playerVersion) が void を返す

パートナー提供のプレーヤーのバージョンを設定します。この設定を使用して、SDK と統合されるパートナー プレーヤーのバージョンを指定します。20 文字を超えるプレーヤー バージョンは省略されます。これはオプションです。プレーヤーのバージョンをトラッキングすることで SDK のユーザビリティを向上させることができます。

例: 


settings.setPlayerVersion('1.0.0');

パラメータ

playerVersion

string

パートナー プレーヤーのバージョン。
戻り値

void 

setPpid

setPpid(ppid) は void を返す

パブリッシャー指定の ID を設定します。

パラメータ

ppid

string

パブリッシャー指定の ID。
戻り値

void 

setSessionId

setSessionId(sessionId) が void を返す

セッション ID は一時的なランダムな ID です。フリークエンシー キャップ専用です。セッション ID は UUID である必要があります。

パラメータ

sessionId

string

フリークエンシー キャップに使用する一時的な UUID。
戻り値

void 

setVpaidAllowed

setVpaidAllowed（allowVpaid）で返される

非推奨です。setVpaidMode を使用する。VPAID クリエイティブを許可するかどうかを設定します。

パラメータ

allowVpaid

ブール値

VPAID クリエイティブを許可するかどうか。
戻り値

void 

setVpaidMode

setVpaidMode（vpaidMode）が void を返す

VPAID 再生モードを設定します。

パラメータ

vpaidMode

VPAID モード

VPAID 広告の再生方法を設定します。デフォルトはセキュアモードです。

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

void