MobileAds

class MobileAds 

Class contains logic that applies to the Google Mobile Ads SDK as a whole. Right now, the only methods in it are used for initialization.

Summary

Constants

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

Default error domain name for the Google Mobile Ads SDK.

Public functions

java-static Unit

Call before initialize or the first ad request to disable mediation adapter initialization.

java-static InitializationStatus ?

Gets the SDK initialization status.

java-static RequestConfiguration

Gets the global RequestConfiguration .

java-static VersionInfo !

Gets the external version (for example, 20.6.0) of the Google Mobile Ads SDK.

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

Initializes the Google Mobile Ads SDK.

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

Initializes the Google Mobile Ads SDK.

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

Opens the ad inspector UI.

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

Opens the debug menu.

java-static Boolean

Controls whether the Google Mobile Ads SDK publisher first-party ID, formerly known as the same app key, is enabled.

java-static CustomTabsSession ?
registerCustomTabsSession (
    context:  Context ,
    client:  CustomTabsClient ,
    origin:  String ,
    callback:  CustomTabsCallback ?
)

Registers a CustomTabsClient with the Google Mobile Ads SDK to improve in-app ad monetization of ads within this CustomTabsSession .

java-static Unit
registerWebView (webview:  WebView )

Registers a WebView with the Google Mobile Ads SDK to improve in-app ad monetization of ads within this WebView .

java-static Unit
setAppMuted (muted:  Boolean )

Indicates whether the application's audio is muted.

java-static Unit
setAppVolume (volume:  Float )

Sets the application's audio volume.

java-static Unit
setRequestConfiguration (requestConfiguration:  RequestConfiguration )

Sets the global RequestConfiguration that will be used for every AdRequest during the app's session.

java-static Unit
startPreload (
    context:  Context ,
    preloadConfigurations: ( Mutable ) List < PreloadConfiguration !>,
    preloadCallback:  PreloadCallback
)

This function is deprecated.

Use start or start instead.

Constants

ERROR_DOMAIN

const val  ERROR_DOMAIN 
= "com.google.android.gms.ads":  String 
!

Default error domain name for the Google Mobile Ads SDK.

Public functions

disableMediationAdapterInitialization

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

Call before initialize or the first ad request to disable mediation adapter initialization. This method is a noop once initialize or the first ad request is made.

Warning: Calling this method may negatively impact your mediation performance. This method should only be called if you include mediation adapters in your app, but you don't plan to use Google mediation during this app session (for example, you are running an A/B test).

getInitializationStatus

java-static fun  getInitializationStatus 
():  InitializationStatus 
?

Gets the SDK initialization status.

getRequestConfiguration

java-static fun  getRequestConfiguration 
():  RequestConfiguration 

Gets the global RequestConfiguration .

getVersion

java-static fun  getVersion 
():  VersionInfo 
!

Gets the external version (for example, 20.6.0) of the Google Mobile Ads SDK.

initialize doesn't need to be called prior to this function.

initialize

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

Initializes the Google Mobile Ads SDK.

Call this method as early as possible after the app launches to reduce latency on the session's first ad request.

If this method is not called, the first ad request automatically initializes the Google Mobile Ads SDK.

Parameters
context:  Context !

The Context the SDK is running in.

initialize

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

Initializes the Google Mobile Ads SDK.

Call this method as early as possible after the app launches to reduce latency on the session's first ad request.

If this method is not called, the first ad request automatically initializes the Google Mobile Ads SDK.

Parameters
context:  Context !

The activity Context the SDK is running in.

listener:  OnInitializationCompleteListener !

A callback to be invoked upon initialization completion.

openAdInspector

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

Opens the ad inspector UI.

openDebugMenu

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

Opens the debug menu. initialize must be called prior to this function.

Parameters
context:  Context !

The activity Context the SDK is running in.

adUnitId:  String !

Any Ad Manager ad unit ID associated with your app.

putPublisherFirstPartyIdEnabled

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

Controls whether the Google Mobile Ads SDK publisher first-party ID, formerly known as the same app key, is enabled.

The ID is enabled by default. When disabled, the setting is persisted across app sessions and the ID is cleared.

initialize must be called prior to this function.

Parameters
enabled:  Boolean

boolean true if the publisher first-party ID is enabled, false otherwise.

Returns
Boolean

true if the decision is persisted successfully. False if it fails to be persisted.

registerCustomTabsSession

java-static fun  registerCustomTabsSession 
(
    context:  Context ,
    client:  CustomTabsClient ,
    origin:  String ,
    callback:  CustomTabsCallback ?
):  CustomTabsSession ?

Registers a CustomTabsClient with the Google Mobile Ads SDK to improve in-app ad monetization of ads within this CustomTabsSession . This will only create one instance of CustomTabsSession and re-running this overrides the existing session.

Parameters
context:  Context

The Context the SDK is running in.

client:  CustomTabsClient

CustomTabsClient used to create the CustomTabsSession instance.

origin:  String

String used as origin on the Digital Asset Link for verification.

callback:  CustomTabsCallback ?

optional CustomTabsCallback to receive callbacks from .

Returns
CustomTabsSession ?

CustomTabsSession instance to be used for Custom Tabs Intent when opening a Custom Tabs page.

registerWebView

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

Registers a WebView with the Google Mobile Ads SDK to improve in-app ad monetization of ads within this WebView .

setAppMuted

java-static fun  setAppMuted 
(muted:  Boolean 
):  Unit 

Indicates whether the application's audio is muted. Affects initial mute state for all ads.

Warning: Muting your application reduces video ad eligibility and may reduce your app's ad revenue. You should only utilize this API if your app provides a custom mute control to the user, and you should reflect the user's mute decision in this API.

Parameters
muted:  Boolean

true if the app is muted, false otherwise. Defaults to false.

setAppVolume

java-static fun  setAppVolume 
(volume:  Float 
):  Unit 

Sets the application's audio volume. Affects audio volumes of all ads relative to other audio output.

Warning: Lowering your app's audio volume reduces video ad eligibility and may reduce your app's ad revenue. You should only utilize this API if your app provides custom volume controls to the user, and you should reflect the user's volume choice in this API.

Parameters
volume:  Float

the volume as a float from 0 (muted) to 1.0 (full media volume). Defaults to 1.0

Throws
java.lang.IllegalArgumentException

if volume is out of the valid range

setRequestConfiguration

java-static fun  setRequestConfiguration 
(requestConfiguration:  RequestConfiguration 
):  Unit 

Sets the global RequestConfiguration that will be used for every AdRequest during the app's session.

startPreload

java-static fun    startPreload 
 
 
(
    context:  Context ,
    preloadConfigurations: ( Mutable ) List < PreloadConfiguration !>,
    preloadCallback:  PreloadCallback
):  Unit

Starts preloading ads for the given configurations.

Ad preloading APIs are in a limited alpha. Please reach out to your account manager for more information.

Parameters
context:  Context

The Context the SDK is running in.

preloadConfigurations: ( Mutable ) List < PreloadConfiguration !>

The configurations to preload ads.

preloadCallback:  PreloadCallback

A callback to be invoked when ad availability changes for each preload configuration.

Design a Mobile Site
View Site in Mobile | Classic
Share by: