MobileAds

Kotlin |Java

class MobileAds

此类包含适用于整个 Google 移动广告 SDK 的逻辑。目前，其中的方法仅用于初始化。

摘要

常量
`const String!`	`ERROR_DOMAIN = "com.google.android.gms.ads"` Google 移动广告 SDK 的默认错误网域名称。

公共函数
`java-static Unit`	`disableMediationAdapterInitialization(context: Context!)` 在 `initialize` 或第一个广告请求之前调用，以停用中介适配器初始化。
`java-static InitializationStatus?`	`getInitializationStatus()` 获取 SDK 初始化状态。
`java-static RequestConfiguration`	`getRequestConfiguration()` 获取全局 `RequestConfiguration`。
`java-static VersionInfo!`	`getVersion()` 获取 Google 移动广告 SDK 的外部版本（例如 20.6.0）。
`java-static Unit`	`@RequiresPermission(value = Manifest.permission.INTERNET) initialize(context: Context!)` 初始化 Google 移动广告 SDK。
`java-static Unit`	`initialize(context: Context!, listener: OnInitializationCompleteListener!)` 初始化 Google 移动广告 SDK。
`java-static Unit`	`openAdInspector(context: Context!, listener: OnAdInspectorClosedListener!)` 打开广告检查器界面。
`java-static Unit`	`openDebugMenu(context: Context!, adUnitId: String!)` 打开调试菜单。
`java-static Boolean`	`putPublisherFirstPartyIdEnabled(enabled: Boolean)` 控制是否启用 Google 移动广告 SDK 发布商第一方 ID（以前称为“同应用标识键”）。
`java-static CustomTabsSession?`	`registerCustomTabsSession( context: Context, client: CustomTabsClient, origin: String, callback: CustomTabsCallback? )` 向 Google 移动广告 SDK 注册 `CustomTabsClient`，以提高此 `CustomTabsSession` 内广告的应用内广告创收能力。
`java-static Unit`	`registerWebView(webview: WebView)` 向 Google 移动广告 SDK 注册 `WebView`，以提高此 `WebView` 内广告的应用内广告创收能力。
`java-static Unit`	`setAppMuted(muted: Boolean)` 指示应用的音频是否处于静音状态。
`java-static Unit`	`setAppVolume(volume: Float)` 设置应用的音频音量。
`java-static Unit`	`setRequestConfiguration(requestConfiguration: RequestConfiguration)` 设置将在应用会话期间用于每个 `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 移动广告 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 移动广告 SDK 的外部版本（例如 20.6.0）。

无需在此函数之前调用 initialize。

initialize

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

初始化 Google 移动广告 SDK。

在应用启动后尽早调用此方法，以减少会话的第一个广告请求的延迟时间。

如果未调用此方法，则第一个广告请求会自动初始化 Google 移动广告 SDK。

参数
`context: Context!`	SDK 正在运行的 `Context`。

initialize

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

初始化 Google 移动广告 SDK。

在应用启动后尽早调用此方法，以减少会话的第一个广告请求的延迟时间。

如果未调用此方法，则第一个广告请求会自动初始化 Google 移动广告 SDK。

参数
`context: Context!`	SDK 正在运行的 activity `Context`。
`listener: OnInitializationCompleteListener!`	在初始化完成时调用的回调。

openAdInspector

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

打开广告检查器界面。

openDebugMenu

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

打开调试菜单。必须先调用 initialize，然后再调用此函数。

参数
`context: Context!`	SDK 正在运行的 activity `Context`。
`adUnitId: String!`	与您的应用相关联的任何 Ad Manager 广告单元 ID。

putPublisherFirstPartyIdEnabled

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

控制是否启用 Google 移动广告 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?

向 Google 移动广告 SDK 注册 CustomTabsClient，以提高此 CustomTabsSession 内广告的应用内广告创收能力。这只会创建一个 CustomTabsSession 实例，重新运行此代码会覆盖现有会话。

参数
`context: Context`	SDK 正在运行的 `Context`。
`client: CustomTabsClient`	用于创建 `CustomTabsSession` 实例的 `CustomTabsClient`。
`origin: String`	用作 Digital Asset Link 上来源的字符串，用于验证。
`callback: CustomTabsCallback?`	可选的 `CustomTabsCallback`，用于接收来自 `CustomTabsSession` 的回调。

返回
`CustomTabsSession?`	打开自定义标签页时要用于自定义标签页 intent 的 `CustomTabsSession` 实例。

registerWebView

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

向 Google 移动广告 SDK 注册 WebView，以提高此 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（媒体音量最大）。默认值为 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 目前处于小范围 Alpha 版测试阶段。如需了解详情，请与您的客户经理联系。

参数
`context: Context`	SDK 正在运行的 `Context`。
`preloadConfigurations: (Mutable)List<PreloadConfiguration!>`	用于预加载广告的配置。
`preloadCallback: PreloadCallback`	当每个预加载配置的广告可用性发生变化时要调用的回调。