MobileAds

Kotlin |Java

public class MobileAds

這個類別包含適用於整個 Google Mobile Ads SDK 的邏輯。目前，其中的方法僅用於初始化。

摘要

常數
`static final String`	`ERROR_DOMAIN = "com.google.android.gms.ads"` Google Mobile Ads SDK 的預設錯誤網域名稱。

公用方法
`static void`	`disableMediationAdapterInitialization(Context context)` 在 `initialize` 或第一個廣告請求之前呼叫，即可停用中介服務轉接程式初始化。
`static @Nullable InitializationStatus`	`getInitializationStatus()` 取得 SDK 初始化狀態。
`static @NonNull RequestConfiguration`	`getRequestConfiguration()` 取得全域 `RequestConfiguration`。
`static VersionInfo`	`getVersion()` 取得 Google Mobile Ads SDK 的外部版本 (例如 20.6.0)。
`static void`	`@RequiresPermission(value = Manifest.permission.INTERNET) initialize(Context context)` 初始化 Google Mobile Ads SDK。
`static void`	`initialize(Context context, OnInitializationCompleteListener listener)` 初始化 Google Mobile Ads SDK。
`static void`	`openAdInspector(Context context, OnAdInspectorClosedListener listener)` 開啟廣告檢查器 UI。
`static void`	`openDebugMenu(Context context, String adUnitId)` 開啟偵錯選單。
`static boolean`	`putPublisherFirstPartyIdEnabled(boolean enabled)` 控制是否啟用 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`	`registerWebView(@NonNull WebView webview)` 向 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 )` 這個方法已淘汰。請改用 `start` 或 `start`。

常數

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 或第一個廣告請求，這個方法就會變成 noop。

警告：呼叫這個方法可能會對中介服務成效造成負面影響。只有在應用程式中加入中介服務介面卡，但您不打算在這次應用程式工作階段中使用 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`	與應用程式相關聯的任何 Ad Manager 廣告單元 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 執行個體，重新執行此操作會覆寫現有工作階段。

參數
`@NonNull Context context`	SDK 執行的 `Context`。
`@NonNull CustomTabsClient client`	`CustomTabsClient` 用於建立 `CustomTabsSession` 例項。
`@NonNull String origin`	用做 Digital Asset Link 來源的字串，用於驗證。
`@Nullable CustomTabsCallback callback`	選用 `CustomTabsCallback`，可接收 `CustomTabsSession` 的回呼。

傳回
`@Nullable CustomTabsSession`	`CustomTabsSession` 例項，用於開啟自訂分頁頁面時的自訂分頁 Intent。

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 目前為 Alpha 版，僅開放部分使用者使用。如要瞭解詳情，請洽詢客戶經理。

參數
`@NonNull Context context`	SDK 執行的`Context`。
`@NonNull List<PreloadConfiguration> preloadConfigurations`	預先載入廣告的設定。
`@NonNull PreloadCallback preloadCallback`	當每個預先載入設定的廣告可用性變更時，系統會叫用此回呼。