MobileAds

class MobileAds

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

概要

定数
const String!
ERROR_DOMAIN = "com.google.android.gms.ads"

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

パブリック関数
java-static Unit

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

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

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

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

Google Mobile Ads SDK を初期化します。
java-static Unit

Google Mobile Ads SDK を初期化します。
java-static Unit

広告インスペクタの UI を開きます。
java-static Unit
openDebugMenu(context: Context!, adUnitId: String!)

デバッグ メニューを開きます。
java-static Boolean

Google Mobile Ads SDK のパブリッシャー様のファーストパーティ ID（旧称「同一アプリキー」）を有効にするかどうかを制御します。
java-static CustomTabsSession?
registerCustomTabsSession(
    context: Context,
    client: CustomTabsClient,
    origin: String,
    callback: CustomTabsCallback?
)

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

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

アプリケーションの音声がミュートされているかどうかを示します。
java-static Unit

アプリの音量を設定します。
java-static Unit

アプリのセッション中にすべての AdRequest で使用されるグローバル RequestConfiguration を設定します。
java-static Unit
startPreload(
    context: Context,
    preloadConfigurations: (Mutable)List<PreloadConfiguration!>,
    preloadCallback: PreloadCallback
)

この関数は非推奨になりました。

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

定数

ERROR_DOMAIN

const val ERROR_DOMAIN = "com.google.android.gms.ads": String!

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

パブリック関数

disableMediationAdapterInitialization

java-static fun disableMediationAdapterInitialization(context: Context!): Unit

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

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

getInitializationStatus

java-static fun getInitializationStatus(): InitializationStatus?

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

getRequestConfiguration

java-static fun getRequestConfiguration(): RequestConfiguration

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

getVersion

java-static fun getVersion(): VersionInfo!

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

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

initialize

@RequiresPermission(value = Manifest.permission.INTERNET)
java-static fun initialize(context: Context!): Unit

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

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

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

パラメータ
context: Context!

SDK が実行されている Context。

initialize

java-static fun initialize(context: Context!, listener: OnInitializationCompleteListener!): Unit

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

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

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

パラメータ
context: Context!

SDK が実行されているアクティビティ Context。
listener: OnInitializationCompleteListener!

初期化の完了時に呼び出されるコールバック。

openAdInspector

java-static fun openAdInspector(context: Context!, listener: OnAdInspectorClosedListener!): Unit

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

openDebugMenu

java-static fun openDebugMenu(context: Context!, adUnitId: String!): Unit

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

パラメータ
context: Context!

SDK が実行されているアクティビティ Context。
adUnitId: String!

アプリに関連付けられているアド マネージャーの広告ユニット ID。

putPublisherFirstPartyIdEnabled

java-static fun putPublisherFirstPartyIdEnabled(enabled: Boolean): Boolean

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

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

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

パラメータ
enabled: Boolean

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

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

registerCustomTabsSession

java-static fun registerCustomTabsSession(
    context: Context,
    client: CustomTabsClient,
    origin: String,
    callback: CustomTabsCallback?
): CustomTabsSession?

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

パラメータ
context: Context

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

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

検証用のデジタル アセットリンクのオリジンとして使用される文字列。
callback: CustomTabsCallback?

CustomTabsSession からコールバックを受信するオプションの CustomTabsCallback。
戻り値
CustomTabsSession?

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

registerWebView

java-static fun registerWebView(webview: WebView): Unit

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

setAppMuted

java-static fun setAppMuted(muted: Boolean): Unit

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

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

パラメータ
muted: Boolean

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

setAppVolume

java-static fun setAppVolume(volume: Float): Unit

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

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

パラメータ
volume: Float

音量（0（ミュート）～ 1.0（メディアの最大音量）の float 値）。デフォルトは 1.0 です。
例外
java.lang.IllegalArgumentException

音量が有効な範囲外の場合

setRequestConfiguration

java-static fun setRequestConfiguration(requestConfiguration: RequestConfiguration): Unit

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

startPreload

java-static fun startPreload(
    context: Context,
    preloadConfigurations: (Mutable)List<PreloadConfiguration!>,
    preloadCallback: PreloadCallback
): Unit

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

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

パラメータ
context: Context

SDK が実行されている Context。
preloadConfigurations: (Mutable)List<PreloadConfiguration!>

広告を事前読み込みするための構成。
preloadCallback: PreloadCallback

各プリロード構成で広告の利用可能性が変化したときに呼び出されるコールバック。