MobileAds

public class MobileAds

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

概要

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

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

パブリック メソッド
static void

initialize または最初の広告リクエストの前に呼び出して、メディエーション アダプタの初期化を無効にします。
static @Nullable InitializationStatus

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

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

Google Mobile Ads SDK の外部バージョン（20.6.0 など）を取得します。
static void
@RequiresPermission(value = Manifest.permission.INTERNET)
initialize(Context context)

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

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

広告インスペクタの UI が開きます。
static void
openDebugMenu(Context context, String adUnitId)

デバッグ メニューを開きます。
static boolean

Google Mobile Ads SDK パブリッシャーの自社 ID（旧称「同一アプリキー」）を有効にするかどうかを制御します。
static @Nullable CustomTabsSession
registerCustomTabsSession(
    @NonNull Context context,
    @NonNull CustomTabsClient client,
    @NonNull String origin,
    @Nullable CustomTabsCallback callback
)

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

Google Mobile Ads SDK に WebView を登録して、この 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
)

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

定数

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 または最初の広告リクエストが実行されると、無効になります。

警告: このメソッドを呼び出すと、メディエーションのパフォーマンスに悪影響を及ぼす可能性があります。このメソッドは、アプリにメディエーション アダプターが含まれているが、このアプリ セッション中に 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
)

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

パラメータ
@NonNull Context context

SDK が実行されている Context。
@NonNull CustomTabsClient client

CustomTabsSession インスタンスの作成に使用される CustomTabsClient。
@NonNull String origin

デジタル アセット リンクの検証で送信元として使用される文字列。
@Nullable CustomTabsCallback callback

からコールバックを受け取るオプションの CustomTabsCallback。
戻り値
@Nullable CustomTabsSession

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

registerWebView

public static void registerWebView(@NonNull WebView webview)

Google Mobile Ads SDK に WebView を登録して、この 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（メディアの音量最大）の浮動小数点数）。デフォルトは 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
)

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

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

パラメータ
@NonNull Context context

SDK が実行されている Context。
@NonNull List<PreloadConfiguration> preloadConfigurations

広告をプリロードするための設定。
@NonNull PreloadCallback preloadCallback

プリロード構成ごとに広告の提供状況が変更されたときに呼び出されるコールバック。