MobileAds

class MobileAds

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

摘要

常量
const String!
ERROR_DOMAIN = "com.google.android.gms.ads"

Google 移动广告 SDK 的默认错误网域名称。

公共函数
java-static Unit

在 initialize 或第一个广告请求之前调用此方法，以停用中介适配器初始化。
java-static InitializationStatus?

获取 SDK 初始化状态。
java-static RequestConfiguration

获取全局 RequestConfiguration。
java-static VersionInfo!

获取 Google 移动广告 SDK 的外部版本（例如 20.6.0）。
java-static Unit
@RequiresPermission(value = Manifest.permission.INTERNET)
initialize(context: Context!)

初始化 Google 移动广告 SDK。
java-static Unit

初始化 Google 移动广告 SDK。
java-static Unit

打开广告检查器界面。
java-static Unit
openDebugMenu(context: Context!, adUnitId: String!)

打开调试菜单。
java-static Boolean

用于控制是否启用 Google 移动广告 SDK 发布商第一方 ID（以前称为“同应用标识键”）。
java-static CustomTabsSession?
registerCustomTabsSession(
    context: Context,
    client: CustomTabsClient,
    origin: String,
    callback: CustomTabsCallback?
)

向 Google 移动广告 SDK 注册 CustomTabsClient，以改进此 CustomTabsSession 中的广告应用内广告创收。
java-static Unit

向 Google 移动广告 SDK 注册 WebView，以改进此 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 移动广告 SDK 的默认错误网域名称。

公共函数

disableMediationAdapterInitialization

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

在 initialize 或第一个广告请求之前调用此方法，以停用中介适配器初始化。在 initialize 或首个广告请求发出后，此方法会执行无操作。

警告：调用此方法可能会对您的中介效果产生不利影响。只有当您在应用中添加了中介适配器，但不打算在此应用会话期间使用 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

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?

打开自定义标签页页面时，要用于自定义标签页 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

在每次预加载配置的广告播出信息发生变化时调用的回调。