MobileAds

class MobileAds


Cette classe contient la logique qui s'applique au SDK Google Mobile Ads dans son ensemble. Pour le moment, les seules méthodes qu'il contient sont utilisées pour l'initialisation.

Résumé

Constantes

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

Nom de domaine d'erreur par défaut pour le SDK Google Mobile Ads.

Fonctions publiques

java-static Unit

Appelez avant initialize ou la première demande d'annonce pour désactiver l'initialisation de l'adaptateur de médiation.

java-static InitializationStatus?

Récupère l'état d'initialisation du SDK.

java-static RequestConfiguration

Récupère le RequestConfiguration global.

java-static VersionInfo!

Obtient la version externe (par exemple, 20.6.0) du SDK Google Mobile Ads.

java-static Unit

Initialise le SDK Google Mobile Ads.

java-static Unit

Initialise le SDK Google Mobile Ads.

java-static Unit

Ouvre l'UI de l'inspecteur d'annonces.

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

Ouvre le menu de débogage.

java-static Boolean

Détermine si l'ID first party de l'éditeur du SDK Google Mobile Ads (anciennement "clé d'application identique") est activé.

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

Enregistre un CustomTabsClient auprès du SDK Google Mobile Ads pour améliorer la monétisation des annonces dans ce CustomTabsSession.

java-static Unit

Enregistre un WebView auprès du SDK Google Mobile Ads pour améliorer la monétisation des annonces dans ce WebView.

java-static Unit

Indique si le son de l'application est coupé.

java-static Unit

Définit le volume audio de l'application.

java-static Unit

Définit le RequestConfiguration global qui sera utilisé pour chaque AdRequest pendant la session de l'application.

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

Cette fonction est obsolète.

Utilisez start ou start à la place.

Constantes

ERROR_DOMAIN

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

Nom de domaine d'erreur par défaut pour le SDK Google Mobile Ads.

Fonctions publiques

disableMediationAdapterInitialization

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

Appelez avant initialize ou la première demande d'annonce pour désactiver l'initialisation de l'adaptateur de médiation. Cette méthode est une noop une fois que initialize ou la première demande d'annonce est effectuée.

Avertissement : L'appel de cette méthode peut avoir un impact négatif sur les performances de votre médiation. Cette méthode ne doit être appelée que si vous incluez des adaptateurs de médiation dans votre application, mais que vous ne prévoyez pas d'utiliser la médiation Google pendant cette session d'application (par exemple, si vous exécutez un test A/B).

getInitializationStatus

java-static fun getInitializationStatus(): InitializationStatus?

Récupère l'état d'initialisation du SDK.

getRequestConfiguration

java-static fun getRequestConfiguration(): RequestConfiguration

Récupère le RequestConfiguration global.

getVersion

java-static fun getVersion(): VersionInfo!

Obtient la version externe (par exemple, 20.6.0) du SDK Google Mobile Ads.

Il n'est pas nécessaire d'appeler initialize avant cette fonction.

initialize

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

Initialise le SDK Google Mobile Ads.

Appelez cette méthode le plus tôt possible après le lancement de l'application pour réduire la latence de la première demande d'annonce de la session.

Si cette méthode n'est pas appelée, la première demande d'annonce initialise automatiquement le SDK Google Mobile Ads.

Paramètres
context: Context!

Context dans lequel le SDK s'exécute.

initialize

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

Initialise le SDK Google Mobile Ads.

Appelez cette méthode le plus tôt possible après le lancement de l'application pour réduire la latence de la première demande d'annonce de la session.

Si cette méthode n'est pas appelée, la première demande d'annonce initialise automatiquement le SDK Google Mobile Ads.

Paramètres
context: Context!

L'activité Context dans laquelle le SDK s'exécute.

listener: OnInitializationCompleteListener!

Rappel à appeler une fois l'initialisation terminée.

openAdInspector

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

Ouvre l'UI de l'inspecteur d'annonces.

openDebugMenu

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

Ouvre le menu de débogage. initialize doit être appelé avant cette fonction.

Paramètres
context: Context!

L'activité Context dans laquelle le SDK s'exécute.

adUnitId: String!

Tout ID de bloc d'annonces Ad Manager associé à votre application.

putPublisherFirstPartyIdEnabled

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

Détermine si l'ID first party de l'éditeur du SDK Google Mobile Ads (anciennement "clé d'application identique") est activé.

L'ID est activé par défaut. Lorsqu'il est désactivé, le paramètre est conservé d'une session d'application à l'autre et l'ID est effacé.

initialize doit être appelé avant cette fonction.

Paramètres
enabled: Boolean

Valeur booléenne "true" si l'ID first party de l'éditeur est activé, ou "false" dans le cas contraire.

Renvoie
Boolean

"true" si la décision est conservée avec succès. "False" si la persistance échoue.

registerCustomTabsSession

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

Enregistre un CustomTabsClient auprès du SDK Google Mobile Ads pour améliorer la monétisation des annonces dans ce CustomTabsSession. Cela ne créera qu'une seule instance de CustomTabsSession. Si vous exécutez à nouveau cette opération, la session existante sera remplacée.

Paramètres
context: Context

Context dans lequel le SDK s'exécute.

client: CustomTabsClient

CustomTabsClient utilisé pour créer l'instance CustomTabsSession.

origin: String

Chaîne utilisée comme origine dans le lien Digital Asset Links pour la validation.

callback: CustomTabsCallback?

CustomTabsCallback facultatif pour recevoir des rappels de CustomTabsSession.

Renvoie
CustomTabsSession?

Instance CustomTabsSession à utiliser pour l'intent d'onglets personnalisés lors de l'ouverture d'une page d'onglets personnalisés.

registerWebView

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

Enregistre un WebView auprès du SDK Google Mobile Ads pour améliorer la monétisation des annonces dans ce WebView.

setAppMuted

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

Indique si le son de l'application est coupé. Affecte l'état de mise en sourdine initial pour toutes les annonces.

Avertissement : Si vous coupez le son de votre application, vous réduisez l'éligibilité aux annonces vidéo et les revenus publicitaires de votre application. Vous ne devez utiliser cette API que si votre application fournit à l'utilisateur une commande de désactivation du son personnalisée. Vous devez refléter la décision de l'utilisateur concernant la désactivation du son dans cette API.

Paramètres
muted: Boolean

"true" si l'application est en mode silencieux, "false" dans le cas contraire. Valeur par défaut : "false".

setAppVolume

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

Définit le volume audio de l'application. Affecte le volume audio de toutes les annonces par rapport aux autres sorties audio.

Avertissement : Si vous baissez le volume audio de votre application, vous risquez de réduire son éligibilité aux annonces vidéo et ses revenus publicitaires. Vous ne devez utiliser cette API que si votre application fournit des commandes personnalisées de contrôle du volume à l'utilisateur, et vous devez refléter le choix de l'utilisateur dans cette API.

Paramètres
volume: Float

le volume sous la forme d'un nombre à virgule flottante compris entre 0 (désactivé) et 1,0 (volume média maximal). La valeur par défaut est 1.0.

Génère
java.lang.IllegalArgumentException

si le volume est hors de la plage valide.

setRequestConfiguration

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

Définit le RequestConfiguration global qui sera utilisé pour chaque AdRequest pendant la session de l'application.

startPreload

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

Démarre le préchargement des annonces pour les configurations données.

Les API de préchargement d'annonces sont disponibles en version alpha limitée. Pour en savoir plus, contactez votre responsable de compte.

Paramètres
context: Context

Context dans lequel le SDK s'exécute.

preloadConfigurations: (Mutable)List<PreloadConfiguration!>

Configurations permettant de précharger les annonces.

preloadCallback: PreloadCallback

Rappel à invoquer lorsque la disponibilité des annonces change pour chaque configuration de préchargement.