MobileAds

Kotlin |Java

public class MobileAds

---

クラスには、Google Mobile Ads SDK 全体に適用されるロジックが含まれています。現時点では、初期化に使用されるメソッドのみが含まれています。

概要

定数
static final String	ERROR_DOMAIN = "com.google.android.gms.ads" Google Mobile Ads SDK のデフォルトのエラー ドメイン名。

パブリック メソッド
static void	disableMediationAdapterInitialization(Context context) initialize または最初の広告リクエストの前に呼び出して、メディエーション アダプタの初期化を無効にします。
static @Nullable InitializationStatus	getInitializationStatus() SDK の初期化ステータスを取得します。
static @NonNull RequestConfiguration	getRequestConfiguration() グローバル RequestConfiguration を取得します。
static VersionInfo	getVersion() Google Mobile Ads SDK の外部バージョン（20.6.0 など）を取得します。
static void	@RequiresPermission(value = Manifest.permission.INTERNET) initialize(Context context) Google Mobile Ads SDK を初期化します。
static void	initialize(Context context, OnInitializationCompleteListener listener) Google Mobile Ads SDK を初期化します。
static void	openAdInspector(Context context, OnAdInspectorClosedListener listener) 広告インスペクタの UI を開きます。
static void	openDebugMenu(Context context, String adUnitId) デバッグ メニューを開きます。
static boolean	putPublisherFirstPartyIdEnabled(boolean enabled) Google Mobile Ads SDK のパブリッシャー様のファーストパーティ ID（旧称「同一アプリキー」）を有効にするかどうかを制御します。
static @Nullable CustomTabsSession	registerCustomTabsSession(     @NonNull Context context,     @NonNull CustomTabsClient client,     @NonNull String origin,     @Nullable CustomTabsCallback callback ) CustomTabsClient を Google Mobile Ads SDK に登録して、この CustomTabsSession 内の広告のアプリ内広告収益化を改善します。
static void	registerWebView(@NonNull WebView webview) WebView を Google Mobile Ads SDK に登録して、この WebView 内の広告のアプリ内広告収益化を改善します。
static void	setAppMuted(boolean muted) アプリケーションの音声がミュートされているかどうかを示します。
static void	setAppVolume(float volume) アプリの音量を設定します。
static void	setRequestConfiguration(     @NonNull RequestConfiguration requestConfiguration ) アプリのセッション中にすべての AdRequest で使用されるグローバル RequestConfiguration を設定します。
static void	startPreload(     @NonNull Context context,     @NonNull List<PreloadConfiguration> preloadConfigurations,     @NonNull PreloadCallback preloadCallback ) このメソッドは非推奨です。 代わりに start または start を使用してください。

定数

ERROR_DOMAIN

public static final String ERROR_DOMAIN = "com.google.android.gms.ads"

Google Mobile Ads SDK のデフォルトのエラー ドメイン名。

パブリック メソッド

disableMediationAdapterInitialization

public static void disableMediationAdapterInitialization(Context context)

initialize または最初の広告リクエストの前に呼び出して、メディエーション アダプタの初期化を無効にします。initialize または最初の広告リクエストが行われると、このメソッドは noop になります。

警告: このメソッドを呼び出すと、メディエーションのパフォーマンスに悪影響を及ぼす可能性があります。このメソッドは、アプリにメディエーション アダプタを含めているものの、このアプリ セッション中に Google メディエーションを使用する予定がない場合（A/B テストを実行している場合など）にのみ呼び出す必要があります。

getInitializationStatus

public static @Nullable InitializationStatus getInitializationStatus()

SDK の初期化ステータスを取得します。

getRequestConfiguration

public static @NonNull RequestConfiguration getRequestConfiguration()

グローバル RequestConfiguration を取得します。

getVersion

public static VersionInfo getVersion()

Google Mobile Ads SDK の外部バージョン（20.6.0 など）を取得します。

この関数の前に initialize を呼び出す必要はありません。

initialize

@RequiresPermission(value = Manifest.permission.INTERNET)
public static void initialize(Context context)

Google Mobile Ads SDK を初期化します。

このメソッドは、アプリの起動後できるだけ早い段階で呼び出して、セッションの最初の広告リクエストのレイテンシを短縮します。

このメソッドが呼び出されない場合、最初のリクエストで Google Mobile Ads SDK が自動的に初期化されます。

パラメータ
Context context	SDK が実行されている Context。

initialize

public static void initialize(Context context, OnInitializationCompleteListener listener)

Google Mobile Ads SDK を初期化します。

このメソッドは、アプリの起動後できるだけ早い段階で呼び出して、セッションの最初の広告リクエストのレイテンシを短縮します。

このメソッドが呼び出されない場合、最初のリクエストで Google Mobile Ads SDK が自動的に初期化されます。

パラメータ
Context context	SDK が実行されているアクティビティ Context。
OnInitializationCompleteListener listener	初期化の完了時に呼び出されるコールバック。

openAdInspector

public static void openAdInspector(Context context, OnAdInspectorClosedListener listener)

広告インスペクタの UI を開きます。

openDebugMenu

public static void openDebugMenu(Context context, String adUnitId)

デバッグ メニューを開きます。initialize は、この関数の前に呼び出す必要があります。

パラメータ
Context context	SDK が実行されているアクティビティ Context。
String adUnitId	アプリに関連付けられているアド マネージャーの広告ユニット ID。

putPublisherFirstPartyIdEnabled

public static boolean putPublisherFirstPartyIdEnabled(boolean enabled)

Google Mobile Ads SDK のパブリッシャーのファーストパーティ ID（旧称「同一アプリキー」）を有効にするかどうかを制御します。

この ID はデフォルトで有効になっています。無効にすると、設定はアプリ セッション間で保持され、ID はクリアされます。

initialize は、この関数の前に呼び出す必要があります。

パラメータ
boolean enabled	パブリッシャーのファーストパーティ ID が有効な場合は true、それ以外の場合は false のブール値。

戻り値
boolean	決定が正常に永続化された場合は true。永続化に失敗した場合は False。

registerCustomTabsSession

public static @Nullable CustomTabsSession registerCustomTabsSession(
    @NonNull Context context,
    @NonNull CustomTabsClient client,
    @NonNull String origin,
    @Nullable CustomTabsCallback callback
)

CustomTabsClient を Google Mobile Ads SDK に登録して、この CustomTabsSession 内の広告のアプリ内広告収益化を改善します。これにより、CustomTabsSession のインスタンスが 1 つだけ作成され、これを再実行すると既存のセッションがオーバーライドされます。

パラメータ
@NonNull Context context	SDK が実行されている Context。
@NonNull CustomTabsClient client	CustomTabsSession インスタンスの作成に使用される CustomTabsClient。
@NonNull String origin	検証用のデジタル アセットリンクのオリジンとして使用される文字列。
@Nullable CustomTabsCallback callback	CustomTabsSession からコールバックを受信するオプションの CustomTabsCallback。

戻り値
@Nullable CustomTabsSession	カスタムタブ ページを開くときにカスタムタブ インテントに使用される CustomTabsSession インスタンス。

registerWebView

public static void registerWebView(@NonNull WebView webview)

WebView を Google Mobile Ads SDK に登録して、この WebView 内の広告のアプリ内広告収益化を改善します。

setAppMuted

public static void setAppMuted(boolean muted)

アプリケーションの音声がミュートされているかどうかを示します。すべての広告の初期ミュート状態に影響します。

警告: アプリケーションをミュートすると、配信可能な動画広告が減るため、アプリの広告収益が減少することがあります。この API を利用するのは、アプリがユーザーにカスタム ミュート設定を提供しており、ユーザーが行ったミュート設定をこの API に反映する場合だけにしましょう。

パラメータ
boolean muted	アプリがミュートされている場合は true、それ以外の場合は false。デフォルトは false です。

setAppVolume

public static void setAppVolume(float volume)

アプリケーションの音量を設定します。他の音声出力に対するすべての広告の音量に影響します。

警告: アプリの音量を下げると、配信可能な動画広告が減るため、アプリの広告収益が減少することがあります。この API を利用するのは、アプリがユーザーにカスタム音量設定を提供しており、ユーザーが設定した音量をこの API に反映する場合だけにしましょう。

パラメータ
float volume	音量（0（ミュート）～ 1.0（メディアの最大音量）の float 値）。デフォルトは 1.0 です。

例外
java.lang.IllegalArgumentException	音量が有効な範囲外の場合

setRequestConfiguration

public static void setRequestConfiguration(
    @NonNull RequestConfiguration requestConfiguration
)

アプリのセッション中にすべての AdRequest で使用されるグローバル RequestConfiguration を設定します。

startPreload

public static void startPreload(
    @NonNull Context context,
    @NonNull List<PreloadConfiguration> preloadConfigurations,
    @NonNull PreloadCallback preloadCallback
)

このメソッドは非推奨です。

代わりに start または start を使用してください。

指定された構成の広告のプリロードを開始します。

広告プリロード API は限定アルファ版です。詳しくは、アカウント マネージャーにお問い合わせください。

パラメータ
@NonNull Context context	SDK が実行されている Context。
@NonNull List<PreloadConfiguration> preloadConfigurations	広告を事前読み込みするための構成。
@NonNull PreloadCallback preloadCallback	各プリロード構成で広告の利用可能性が変化したときに呼び出されるコールバック。