MobileAds

Kotlin |Java

public class MobileAds

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

摘要

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

公共方法
`static void`	`disableMediationAdapterInitialization(Context context)` 在 `initialize` 或第一个广告请求之前调用，以停用中介适配器初始化。
`static @Nullable InitializationStatus`	`getInitializationStatus()` 获取 SDK 初始化状态。
`static @NonNull RequestConfiguration`	`getRequestConfiguration()` 获取全局 `RequestConfiguration`。
`static VersionInfo`	`getVersion()` 获取 Google 移动广告 SDK 的外部版本（例如 20.6.0）。
`static void`	`@RequiresPermission(value = Manifest.permission.INTERNET) initialize(Context context)` 初始化 Google 移动广告 SDK。
`static void`	`initialize(Context context, OnInitializationCompleteListener listener)` 初始化 Google 移动广告 SDK。
`static void`	`openAdInspector(Context context, OnAdInspectorClosedListener listener)` 打开广告检查器界面。
`static void`	`openDebugMenu(Context context, String adUnitId)` 打开调试菜单。
`static boolean`	`putPublisherFirstPartyIdEnabled(boolean enabled)` 控制是否启用 Google 移动广告 SDK 发布商第一方 ID（以前称为“同应用标识键”）。
`static @Nullable CustomTabsSession`	`registerCustomTabsSession( @NonNull Context context, @NonNull CustomTabsClient client, @NonNull String origin, @Nullable CustomTabsCallback callback )` 向 Google 移动广告 SDK 注册 `CustomTabsClient`，以提高此 `CustomTabsSession` 内广告的应用内广告创收能力。
`static void`	`registerWebView(@NonNull WebView webview)` 向 Google 移动广告 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 )` 此方法已弃用。请改为使用 `start` 或 `start`。

常量

ERROR_DOMAIN

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

Google 移动广告 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 移动广告 SDK 的外部版本（例如 20.6.0）。

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

initialize

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

初始化 Google 移动广告 SDK。

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

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

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

initialize

public static void initialize(Context context, OnInitializationCompleteListener listener)

初始化 Google 移动广告 SDK。

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

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

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

openAdInspector

public static void openAdInspector(Context context, OnAdInspectorClosedListener listener)

打开广告检查器界面。

openDebugMenu

public static void openDebugMenu(Context context, String adUnitId)

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

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

putPublisherFirstPartyIdEnabled

public static boolean putPublisherFirstPartyIdEnabled(boolean enabled)

控制是否启用 Google 移动广告 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 移动广告 SDK 注册 CustomTabsClient，以提高此 CustomTabsSession 内广告的应用内广告创收能力。这只会创建一个 CustomTabsSession 实例，重新运行此代码会覆盖现有会话。

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

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

registerWebView

public static void registerWebView(@NonNull WebView webview)

向 Google 移动广告 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 目前处于小范围 Alpha 版测试阶段。如需了解详情，请与您的客户经理联系。

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