MobileAds

public 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

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

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

Méthodes publiques

static void

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

static @Nullable InitializationStatus

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

static @NonNull RequestConfiguration

Récupère le RequestConfiguration global.

static VersionInfo

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

static void

Initialise le SDK Google Mobile Ads.

static void

Initialise le SDK Google Mobile Ads.

static void

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

static void
openDebugMenu(Context context, String adUnitId)

Ouvre le menu de débogage.

static boolean

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

static @Nullable CustomTabsSession
registerCustomTabsSession(
    @NonNull Context context,
    @NonNull CustomTabsClient client,
    @NonNull String origin,
    @Nullable CustomTabsCallback callback
)

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

static void

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

static void
setAppMuted(boolean muted)

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

static void
setAppVolume(float volume)

Définit le volume audio de l'application.

static void
setRequestConfiguration(
    @NonNull RequestConfiguration requestConfiguration
)

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

static void
startPreload(
    @NonNull Context context,
    @NonNull List<PreloadConfiguration> preloadConfigurations,
    @NonNull PreloadCallback preloadCallback
)

Cette méthode est obsolète.

Utilisez start ou start à la place.

Constantes

ERROR_DOMAIN

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

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

Méthodes publiques

disableMediationAdapterInitialization

public static void disableMediationAdapterInitialization(Context context)

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

public static @Nullable InitializationStatus getInitializationStatus()

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

getRequestConfiguration

public static @NonNull RequestConfiguration getRequestConfiguration()

Récupère le RequestConfiguration global.

getVersion

public static VersionInfo getVersion()

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)
public static void initialize(Context context)

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

public static void initialize(Context context, OnInitializationCompleteListener listener)

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.

OnInitializationCompleteListener listener

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

openAdInspector

public static void openAdInspector(Context context, OnAdInspectorClosedListener listener)

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

openDebugMenu

public static void openDebugMenu(Context context, String adUnitId)

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.

String adUnitId

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

putPublisherFirstPartyIdEnabled

public static boolean putPublisherFirstPartyIdEnabled(boolean enabled)

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
boolean enabled

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

public static @Nullable CustomTabsSession registerCustomTabsSession(
    @NonNull Context context,
    @NonNull CustomTabsClient client,
    @NonNull String origin,
    @Nullable CustomTabsCallback callback
)

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
@NonNull Context context

Context dans lequel le SDK s'exécute.

@NonNull CustomTabsClient client

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

@NonNull String origin

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

@Nullable CustomTabsCallback callback

CustomTabsCallback facultatif pour recevoir des rappels de CustomTabsSession.

Renvoie
@Nullable CustomTabsSession

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

registerWebView

public static void registerWebView(@NonNull WebView webview)

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

setAppMuted

public static void setAppMuted(boolean muted)

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
boolean muted

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

setAppVolume

public static void setAppVolume(float volume)

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
float volume

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

public static void setRequestConfiguration(
    @NonNull RequestConfiguration requestConfiguration
)

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

startPreload

public static void startPreload(
    @NonNull Context context,
    @NonNull List<PreloadConfiguration> preloadConfigurations,
    @NonNull PreloadCallback preloadCallback
)

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
@NonNull Context context

Context dans lequel le SDK s'exécute.

@NonNull List<PreloadConfiguration> preloadConfigurations

Configurations permettant de précharger les annonces.

@NonNull PreloadCallback preloadCallback

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