El módulo @google/mobile-ads proporciona las interfaces, las clases y las funciones de nivel superior principales de TypeScript para integrar los anuncios de Google para dispositivos móviles en las aplicaciones de React Native.
Descripción general
-
Ciclo de vida e inicialización del SDK: Usa
initializeconInitializationConfigpara inicializar el SDK y, luego, inspecciona los estados de inicialización del adaptador congetInitializationStatusyInitializationStatus. -
User Messaging Platform (UMP): Administra el consentimiento del usuario con
requestConsentInfoUpdate,loadAndShowConsentFormIfRequired,showPrivacyOptionsFormy, luego, inspecciona el estado del consentimiento congetConsentStatusycanRequestAds. -
Request Configuration: Define la configuración global de segmentación y de políticas con
setRequestConfigurationyRequestConfiguration, y configura opciones comoAgeRestrictedTreatment,MaxAdContentRatingyPublisherPrivacyPersonalizationState. -
Formatos de anuncios: Carga y presenta anuncios con clases de formato, como
AppOpenAd,InterstitialAd,RewardedAdyRewardedInterstitialAd. -
Herramientas para desarrolladores: Inspecciona la publicación de anuncios, el estado del adaptador y las configuraciones del SDK en tiempo real con
openAdInspectoroopenDebugMenu.
| Alias de tipo | |
|---|---|
Adapter
|
Representa los posibles estados de inicialización de un adaptador de mediación.
|
Ad
|
Son las posiciones del ícono de AdChoices en la vista del anuncio. |
Ad
|
Es el formato del anuncio que se solicita. |
Ad
|
Es información sobre el error que indica por qué falló el inspector de anuncios.
|
Ad
|
Errores que afectan la apertura o el funcionamiento del inspector de anuncios
|
Ad
|
Son opciones de orientación para los anuncios de banner adaptable intercalado y adaptable fijo grande.
|
Ad
|
Representa las dimensiones de un anuncio. |
Age
|
Define las opciones de tratamiento con restricción de edad para las solicitudes de anuncios.
|
Consent
|
Son los valores del estado de consentimiento. |
Debug
|
Valores de depuración para probar la geografía. |
Form
|
Representa los códigos de error de las fallas en las operaciones del formulario de User Messaging Platform (UMP).
|
Full
|
|
Load
|
Representa los códigos de error para las fallas en la operación de carga de anuncios.
|
Max
|
Define la clasificación máxima del contenido del anuncio para la app y clasifica los tipos de anuncios que se pueden mostrar.
|
Native
|
Nombres que se usan para identificar los recursos de anuncios nativos estándares.
|
Native
|
Identifica el formato de un anuncio nativo cargado. |
Native
|
Son las preferencias para la relación de aspecto de los medios de los anuncios nativos devueltos.
|
On
|
Es la definición de interfaz para una devolución de llamada que se invocará cuando se cierre la IU del inspector de anuncios.
|
Precision
|
Es la precisión del valor del anuncio informado. |
Privacy
|
Es el estado de requisito de las opciones de privacidad. |
Publisher
|
Indica los estados de personalización del tratamiento de privacidad del publicador.
|
Resize
|
Opciones para personalizar el modo de cambio de tamaño del contenido de la imagen en NativeAdMediaView.
|
Resolved
|
Representa el estado final resuelto de un tamaño de anuncio después de que se cargó un anuncio.
|
Swipe
|
Instrucciones para gestos de deslizamiento de clic personalizados. |
| Variables | |
|---|---|
Ad
|
Tamaños de anuncios predefinidos y métodos auxiliares para crear tamaños adaptables y personalizados.
|
| Funciones | |
|---|---|
can
|
Verifica si el estado de consentimiento actual te permite solicitar anuncios.
|
get
|
Obtiene el estado de consentimiento actual del usuario. |
get
|
Obtiene el estado de inicialización del SDK. |
get
|
Verifica si se requiere un punto de entrada de opciones de privacidad para tu app.
|
get
|
Obtiene la configuración global de la solicitud. |
initialize
|
Inicializa el SDK de anuncios de Google para dispositivos móviles. |
is
|
Verifica si hay un formulario de consentimiento disponible. |
load
|
Carga un formulario de consentimiento y se lo presenta al usuario si su estado de consentimiento actual lo requiere (p.ej., el estado es REQUIRED).
|
open
|
Abre la superposición del inspector de anuncios del SDK de anuncios de Google para dispositivos móviles.
|
open
|
Abre el menú de depuración. |
parse
|
Analiza un error nativo que se produjo durante la carga del anuncio y lo encapsula en un objeto LoadAdError.
|
request
|
Solicita una actualización de la información de consentimiento. |
reset
|
Borra todo el estado de consentimiento del almacenamiento persistente.
|
set
|
Controla si el ID propio del publicador está habilitado.
|
set
|
Establece la configuración global de la solicitud para el cumplimiento y la segmentación.
|
set
|
Establece el volumen de audio de la aplicación controlada por el usuario.
|
set
|
Establece si la aplicación está silenciada. |
show
|
Muestra el formulario de opciones de privacidad. |
Alias de tipo
AdapterState
AdapterState: typeof AdapterState[keyof typeof AdapterState]
AdChoicesPlacement
AdChoicesPlacement:
typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
AdFormat
Es el formato del anuncio que se solicita.
AdInspectorError
AdInspectorError:
BaseError<AdInspectorErrorCode>
AdInspectorErrorCode
AdInspectorErrorCode:
typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
AdOrientation
AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
| Propiedades | |
|---|---|
CURRENT
|
|
LANDSCAPE
|
|
PORTRAIT
|
|
AdSize
Representa las dimensiones de un anuncio.
Puede ser uno de los tamaños predefinidos (p.ej., AdSize.LARGE_BANNER) o un tamaño adaptable.
Puede ser uno de los tamaños predefinidos (p.ej., AdSize.LARGE_BANNER) o un tamaño adaptable.
AgeRestrictedTreatment
AgeRestrictedTreatment:
typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
ConsentStatus
ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
DebugGeography
DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
FormErrorCode
FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
FullScreenContentErrorCode
FullScreenContentErrorCode:
typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
| Propiedades | |
|---|---|
AD_
|
El anuncio ya se mostró. |
AD_
|
El anuncio no está listo para mostrarse. |
AD_
|
El anuncio es demasiado grande para la escena (solo para iOS). |
APP_
|
La app no está en primer plano. |
INTERNAL_
|
Se produjo un error interno. Por ejemplo, se produjo una excepción cuando se preparaba para mostrar el contenido del anuncio.
|
MEDIATION_
|
El adaptador de mediación no pudo mostrar el anuncio. Consulta FullScreenContentError.mediationAdError para conocer la causa subyacente.
|
UNKNOWN
|
No se pudo asignar el código de error a un código de error conocido.
|
LoadAdErrorCode
LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
MaxAdContentRating
MaxAdContentRating:
typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
NativeAdAssetNames
NativeAdAssetNames:
typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
NativeAdType
NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
| Propiedades | |
|---|---|
BANNER
|
Anuncio de banner. |
CUSTOM_
|
Es un anuncio en formato nativo personalizado. |
NATIVE
|
Anuncio nativo. |
NativeMediaAspectRatio
NativeMediaAspectRatio:
typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
OnAdInspectorClosedListener
OnAdInspectorClosedListener:
((error?) => void)
PrecisionType
PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
PrivacyOptionsRequirementStatus
PrivacyOptionsRequirementStatus:
typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
PublisherPrivacyPersonalizationState
PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
ResizeMode
ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
ResolvedAdSize
ResolvedAdSize:
FixedAdSize | FluidAdSize
Para la mayoría de los anuncios, esto se resuelve en un FixedAdSize con dimensiones exactas de
width y height.
En el caso de los anuncios de banner con tamaño dinámico, se resuelve en un objeto FluidAdSize en el que la jerarquía de vistas administra las dimensiones.
SwipeGestureDirection
SwipeGestureDirection:
typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
| Propiedades | |
|---|---|
DOWN
|
Desliza el dedo hacia abajo. |
LEFT
|
Desliza el dedo hacia la izquierda. |
RIGHT
|
Desliza el dedo hacia la derecha. |
UP
|
Desliza el dedo hacia arriba. |
Variables
AdSize
AdSize: {
BANNER: FixedAdSize;
custom: ((width,
height) => FixedAdSize);
FLUID: FluidAdSize;
FULL_BANNER: FixedAdSize;
getCurrentOrientationInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
getInlineAdaptiveBannerAdSize: ((width,
maxHeight) => InlineAdaptiveAdSize);
getLandscapeInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
getLargeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getLargeLandscapeAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getLargePortraitAnchoredAdaptiveBannerAdSize: ((width) => Promise<LargeAnchoredAdaptiveAdSize>);
getPortraitInlineAdaptiveBannerAdSize: ((width) => InlineAdaptiveAdSize);
LARGE_BANNER: FixedAdSize;
LEADERBOARD: FixedAdSize;
MEDIUM_RECTANGLE: FixedAdSize;
}
Funciones
canRequestAds
canRequestAds(): boolean
Verifica si el estado de consentimiento actual te permite solicitar anuncios.
| Muestra | |
|---|---|
boolean
|
true si puedes solicitar anuncios; de lo contrario, false.
|
getConsentStatus
getConsentStatus(): ConsentStatus
Obtiene el estado de consentimiento actual del usuario.
| Muestra | |
|---|---|
ConsentStatus
|
Es el estado de consentimiento actual. |
getInitializationStatus
getInitializationStatus(): InitializationStatus
Obtiene el estado de inicialización del SDK.
Usa este método para verificar si el SDK terminó de inicializarse y para inspeccionar el estado de los adaptadores de mediación individuales.
Usa este método para verificar si el SDK terminó de inicializarse y para inspeccionar el estado de los adaptadores de mediación individuales.
| Muestra | |
|---|---|
InitializationStatus
|
Es el estado de inicialización actual. |
getPrivacyOptionsRequirementStatus
getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Verifica si se requiere un punto de entrada de opciones de privacidad para tu
app.
Si se requiere un punto de entrada, agrega un elemento de IU visible y con el que se pueda interactuar a tu app que llame a showPrivacyOptionsForm para mostrar el formulario de opciones de privacidad. Si no se requiere un punto de entrada, configura el elemento de la IU para que no sea visible ni interactivo.
Si se requiere un punto de entrada, agrega un elemento de IU visible y con el que se pueda interactuar a tu app que llame a showPrivacyOptionsForm para mostrar el formulario de opciones de privacidad. Si no se requiere un punto de entrada, configura el elemento de la IU para que no sea visible ni interactivo.
| Muestra | |
|---|---|
PrivacyOptionsRequirementStatus
|
Es el estado del requisito de opciones de privacidad. |
getRequestConfiguration
getRequestConfiguration(): RequestConfiguration
Obtiene la configuración global de la solicitud.
Usa este método para recuperar la configuración actual de la solicitud que se aplicó de forma global.
Usa este método para recuperar la configuración actual de la solicitud que se aplicó de forma global.
| Muestra | |
|---|---|
RequestConfiguration
|
Es la configuración actual de la solicitud global. |
initialize
initialize(config,
onInitializationComplete?): void
Inicializa el SDK de anuncios de Google para dispositivos móviles.
Llama a este método antes de cargar un anuncio y antes de interactuar con el resto del SDK de anuncios de Google para dispositivos móviles.
Llama a este método antes de cargar un anuncio y antes de interactuar con el resto del SDK de anuncios de Google para dispositivos móviles.
| Parámetros | |
|---|---|
config:
InitializationConfig
|
Son opciones para controlar la inicialización del SDK. |
|
Función de devolución de llamada que se ejecutará cuando el SDK termine de inicializarse. |
isConsentFormAvailable
isConsentFormAvailable(): boolean
Verifica si hay un formulario de consentimiento disponible.
| Muestra | |
|---|---|
boolean
|
true si hay un formulario de consentimiento disponible; de lo contrario, false.
|
loadAndShowConsentFormIfRequired
loadAndShowConsentFormIfRequired(onDismissed?): void
Carga un formulario de consentimiento y se lo presenta al usuario si su estado de consentimiento actual lo requiere (p.ej., el estado es REQUIRED).
| Parámetros | |
|---|---|
|
Función de devolución de llamada que se invoca cuando se descarta el formulario o si no se requiere ningún formulario, con un FormError opcional si falló la presentación. |
openAdInspector
openAdInspector(_listener): void
Abre la capa superpuesta del inspector de anuncios del SDK de anuncios de Google para dispositivos móviles.
Usa este método para depurar la configuración de la mediación y las fuentes de anuncios.
Usa este método para depurar la configuración de la mediación y las fuentes de anuncios.
| Parámetros | |
|---|---|
_listener:
OnAdInspectorClosedListener
|
|
openDebugMenu
openDebugMenu(adUnitId): void
Abre el menú de depuración.
Usa este método para abrir el menú de depuración de una unidad de anuncios específica y, así, facilitar las pruebas y la solución de problemas relacionados con la configuración de anuncios.
Usa este método para abrir el menú de depuración de una unidad de anuncios específica y, así, facilitar las pruebas y la solución de problemas relacionados con la configuración de anuncios.
| Parámetros | |
|---|---|
adUnitId: string
|
Es el ID de la unidad de anuncios para la que se abrirá el menú de depuración. |
parseLoadAdError
parseLoadAdError(error): LoadAdError
Analiza un error nativo que se produjo durante la carga del anuncio y lo encapsula en un objeto LoadAdError.
| Parámetros | |
|---|---|
error: unknown
|
Es el objeto de error que arroja el módulo nativo. |
| Muestra | |
|---|---|
LoadAdError
|
Es un objeto LoadAdError analizado. |
requestConsentInfoUpdate
requestConsentInfoUpdate(params?, onComplete?): void
Solicita una actualización de la información de consentimiento.
Se debe llamar a esta API en cada sesión de la app antes de llamar a getConsentStatus.
Después de llamar a esta API, el valor de devolución de getConsentStatus se actualiza de forma síncrona para contener el estado de consentimiento de la sesión anterior de la app, si existe.
getConsentStatus se puede volver a actualizar al estado actualizado después de que se invoque la devolución de llamada de
Se debe llamar a esta API en cada sesión de la app antes de llamar a getConsentStatus.
Después de llamar a esta API, el valor de devolución de getConsentStatus se actualiza de forma síncrona para contener el estado de consentimiento de la sesión anterior de la app, si existe.
getConsentStatus se puede volver a actualizar al estado actualizado después de que se invoque la devolución de llamada de
onComplete.
| Parámetros | |
|---|---|
|
Son configuraciones opcionales para la depuración y la segmentación. |
|
Función de devolución de llamada que se invoca cuando finaliza la actualización de la información de consentimiento, con un FormError opcional si falló la solicitud. |
reset
reset(): void
Borra todo el estado de consentimiento del almacenamiento persistente.
Úsalo solo para fines de depuración.
Úsalo solo para fines de depuración.
setPublisherFirstPartyIdEnabled
setPublisherFirstPartyIdEnabled(enabled): void
Controla si el ID propio del publicador está habilitado.
Habilita o inhabilita el ID propio del publicador del SDK de anuncios de Google para dispositivos móviles, antes conocido como clave para la misma aplicación.
Habilita o inhabilita el ID propio del publicador del SDK de anuncios de Google para dispositivos móviles, antes conocido como clave para la misma aplicación.
- Consulta también
| Parámetros | |
|---|---|
enabled: boolean
|
Es verdadero para habilitar el ID propio del publicador y falso para inhabilitarlo. La configuración predeterminada es true.
|
setRequestConfiguration
setRequestConfiguration(_config): void
Establece la configuración global de la solicitud para la segmentación y el cumplimiento.
Usa este método para especificar detalles de segmentación, como la clasificación máxima del contenido del anuncio, la configuración de cumplimiento (por ejemplo, la etiqueta para el tratamiento de contenido según la edad) y los IDs de dispositivos de prueba.
Usa este método para especificar detalles de segmentación, como la clasificación máxima del contenido del anuncio, la configuración de cumplimiento (por ejemplo, la etiqueta para el tratamiento de contenido según la edad) y los IDs de dispositivos de prueba.
| Parámetros | |
|---|---|
_config:
RequestConfiguration
|
|
setUserControlledAppVolume
setUserControlledAppVolume(volume): void
Establece el volumen de audio de la aplicación controlada por el usuario.
Usa este método para ajustar el volumen de audio de todos los anuncios en relación con otra salida de audio en el dispositivo.
Usa este método para ajustar el volumen de audio de todos los anuncios en relación con otra salida de audio en el dispositivo.
| Parámetros | |
|---|---|
volume: number
|
Es el nivel de volumen, entre 0.0 (silencio) y 1.0 (máximo). Cualquier valor de punto flotante dentro de este rango es válido (por ejemplo, 0.001 o 0.33333). El valor no se restringe a incrementos específicos del tamaño del paso, como 0.1. |
setUserMutedApp
setUserMutedApp(muted): void
Establece si la aplicación está silenciada.
Usa este método para controlar el estado inicial de silencio del audio de los anuncios posteriores.
Usa este método para controlar el estado inicial de silencio del audio de los anuncios posteriores.
| Parámetros | |
|---|---|
muted: boolean
|
Indica si se debe silenciar el audio de la aplicación. El valor predeterminado es false.
|
showPrivacyOptionsForm
showPrivacyOptionsForm(onDismissed?): void
Muestra el formulario de opciones de privacidad.
Presenta un formulario de opciones de privacidad si getPrivacyOptionsRequirementStatus es
Este método solo se debe llamar en respuesta a la entrada del usuario para solicitar que se muestre un formulario de opciones de privacidad.
El SDK precarga automáticamente el formulario de opciones de privacidad cuando un formulario está disponible. Si no se precargó ningún formulario, el SDK intentará cargar uno de forma asíncrona.
Se llama a la devolución de llamada
Presenta un formulario de opciones de privacidad si getPrivacyOptionsRequirementStatus es
REQUIRED.Este método solo se debe llamar en respuesta a la entrada del usuario para solicitar que se muestre un formulario de opciones de privacidad.
El SDK precarga automáticamente el formulario de opciones de privacidad cuando un formulario está disponible. Si no se precargó ningún formulario, el SDK intentará cargar uno de forma asíncrona.
Se llama a la devolución de llamada
onDismissed después de que se le presenta el formulario al usuario, este selecciona una opción y descarta el formulario. También puede devolver un FormError en los siguientes casos:
- El formulario no está disponible.
- No se muestra el formulario.
- Aún se está precargando el formulario.
| Parámetros | |
|---|---|
|
Función de devolución de llamada que se invoca cuando se descarta el formulario, con un FormError opcional si falló la presentación. |