MobileAds

public class MobileAds

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

摘要

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

Google Mobile Ads SDK 的預設錯誤網域名稱。

公用方法
static void

在 initialize 或第一個廣告要求之前呼叫，即可停用中介服務轉接器初始化。
static @Nullable InitializationStatus

取得 SDK 初始化狀態。
static @NonNull RequestConfiguration

取得全域 RequestConfiguration。
static VersionInfo

取得 Google Mobile Ads SDK 的外部版本 (例如 20.6.0)。
static void
@RequiresPermission(value = Manifest.permission.INTERNET)
initialize(Context context)

初始化 Google Mobile Ads SDK。
static void

初始化 Google Mobile Ads SDK。
static void

開啟廣告檢查器 UI。
static void
openDebugMenu(Context context, String adUnitId)

開啟偵錯選單。
static boolean

控制是否啟用 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

使用 Google Mobile Ads SDK 註冊 WebView，改善這個 WebView 內的應用程式內廣告營利功能。
static void
setAppMuted(boolean muted)

指出應用程式的音訊是否靜音。
static void
setAppVolume(float volume)

設定應用程式的音訊音量。
static void
setRequestConfiguration(
    @NonNull RequestConfiguration requestConfiguration
)

設定全域 RequestConfiguration，在應用程式工作階段期間，系統會為每個 AdRequest 使用此 RequestConfiguration。
static void
startPreload(
    @NonNull Context context,
    @NonNull List<PreloadConfiguration> preloadConfigurations,
    @NonNull PreloadCallback preloadCallback
)

開始為指定設定預先載入廣告。

常數

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 或發出第一個廣告請求後，這個方法會變成空值。

警告：呼叫此方法可能會對中介服務成效造成負面影響。只有在應用程式中加入中介服務轉接器，但不打算在這個應用程式工作階段中使用 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，用於接收 的回呼。
傳回
@Nullable CustomTabsSession

CustomTabsSession 例項，用於開啟自訂 Tabs 頁面時的自訂 Tabs 意圖。

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
)

設定全域 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

當每個預先載入設定的廣告可用性變更時，系統會叫用此回呼。