API Google Mobile Ads React Native

O módulo @google/mobile-ads fornece as principais interfaces, classes e funções de nível superior do TypeScript para integrar os anúncios para dispositivos móveis do Google em aplicativos React Native.

Visão geral

Aliases de tipo
AdapterState
Representa os possíveis estados de inicialização de um adaptador de mediação.
AdChoicesPlacement
Posições do ícone Opções de Anúncios na visualização de anúncio.
AdFormat
Formato do anúncio que está sendo solicitado.
AdInspectorError
Informações sobre o motivo da falha do Ad Inspector.
AdInspectorErrorCode
Erros que afetam a abertura ou a operação do Ad Inspector.
AdOrientation
Opções de orientação para anúncios de banner adaptativo inline e adaptativo fixo grande.
AdSize
Representa as dimensões de um anúncio.
AgeRestrictedTreatment
Define as opções de tratamento com restrição de idade para solicitações de anúncios.
ConsentStatus
Valores de status de consentimento.
DebugGeography
Valores de depuração para testar a geografia.
FormErrorCode
Representa códigos de erro para falhas na operação do formulário da plataforma de mensagens para usuários (UMP).
FullScreenContentErrorCode
LoadAdErrorCode
Representa códigos de erro para falhas na operação de carregamento de anúncios.
MaxAdContentRating
Define a classificação máxima do conteúdo do anúncio para o app, classificando os tipos de anúncios que podem ser mostrados.
NativeAdAssetNames
Nomes usados para identificar recursos de anúncios nativos padrão.
NativeAdType
Identifica o formato de um anúncio nativo carregado.
NativeMediaAspectRatio
Preferências para a proporção da mídia do anúncio nativo retornado.
OnAdInspectorClosedListener
Definição de interface para um callback a ser invocado quando a interface do inspetor de anúncios for fechada.
PrecisionType
A precisão do valor do anúncio informado.
PrivacyOptionsRequirementStatus
Status do requisito de opções de privacidade.
PublisherPrivacyPersonalizationState
Indica os estados de personalização do tratamento de privacidade do publisher.
ResizeMode
Opções para personalizar o modo de redimensionamento do conteúdo da imagem em NativeAdMediaView.
ResolvedAdSize
Representa o estado final resolvido de um tamanho de anúncio depois que um anúncio foi carregado.
SwipeGestureDirection
Instruções para gestos de deslizar e clicar personalizados.
Variáveis
AdSize
Tamanhos de anúncio predefinidos e métodos auxiliares para criar tamanhos adaptáveis e personalizados.
Funções
canRequestAds
Verifica se o status de consentimento atual permite que você solicite anúncios.
getConsentStatus
Recebe o status de consentimento atual do usuário.
getInitializationStatus
Recebe o status de inicialização do SDK.
getPrivacyOptionsRequirementStatus
Verifica se um ponto de entrada de opções de privacidade é necessário para seu app.
getRequestConfiguration
Recebe a configuração global da solicitação.
initialize
Inicializa o SDK do Google Mobile Ads.
isConsentFormAvailable
Verifica se um formulário de consentimento está disponível.
loadAndShowConsentFormIfRequired
Carrega e apresenta um formulário de consentimento ao usuário se o status de consentimento atual exigir isso (por exemplo, o status é REQUIRED).
openAdInspector
Abre a sobreposição do Ad Inspector do SDK do Google Mobile Ads.
openDebugMenu
Abre o menu de depuração.
parseLoadAdError
Analisa um erro nativo gerado durante o carregamento do anúncio e o encapsula em um LoadAdError.
requestConsentInfoUpdate
Solicita uma atualização das informações de consentimento.
reset
Limpa todo o estado de consentimento do armazenamento permanente.
setPublisherFirstPartyIdEnabled
Controla se o ID próprio do publisher está ativado.
setRequestConfiguration
Define a configuração global de solicitação para conformidade e segmentação.
setUserControlledAppVolume
Define o volume de áudio do aplicativo controlado pelo usuário.
setUserMutedApp
Define se o aplicativo está sem som.
showPrivacyOptionsForm
Mostra o formulário de opções de privacidade.

Aliases de tipo

AdapterState

AdapterState: typeof AdapterState[keyof typeof AdapterState]
Representa os possíveis estados de inicialização de um adaptador de mediação.
Propriedades
NOT_READY
Indica que o adaptador de mediação ainda não foi inicializado ou não conseguiu ser inicializado.
READY
Indica que o adaptador de mediação foi inicializado e está pronto para veicular anúncios.

AdChoicesPlacement

AdChoicesPlacement: typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
Posições do ícone Opções de Anúncios na visualização de anúncio.
Propriedades
BOTTOM_LEFT
Canto inferior esquerdo do anúncio.
BOTTOM_RIGHT
Canto inferior direito do anúncio.
TOP_LEFT
Canto superior esquerdo do anúncio.
TOP_RIGHT
Canto superior direito do anúncio.

AdFormat

AdFormat: typeof AdFormat[keyof typeof AdFormat]
Formato do anúncio que está sendo solicitado.
Propriedades
APP_OPEN
Formato de anúncio de abertura do app.
BANNER
Formato de anúncio de banner.
INTERSTITIAL
Formato de anúncio intersticial.
NATIVE
Formato de anúncio nativo.
REWARDED
Formato de anúncio premiado.
REWARDED_INTERSTITIAL
Formato de anúncio intersticial premiado.

AdInspectorError

AdInspectorError: BaseError<AdInspectorErrorCode>
Informações sobre o motivo da falha do Ad Inspector.

AdInspectorErrorCode

AdInspectorErrorCode: typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
Erros que afetam a abertura ou a operação do Ad Inspector.
Propriedades
ALREADY_OPEN
Não é possível abrir o Ad Inspector porque ele já está aberto.
FAILED_TO_LOAD
Não foi possível carregar o Ad Inspector.
INTERNAL_ERROR
O Ad Inspector teve um erro interno.
NOT_IN_TEST_MODE
Não é possível abrir o Ad Inspector porque o dispositivo não está no modo de teste.

AdOrientation

AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
Opções de orientação para anúncios de banner adaptativo inline e adaptativo fixo grande.
Propriedades
CURRENT
LANDSCAPE
PORTRAIT

AdSize

Representa as dimensões de um anúncio.

Pode ser um de um conjunto predefinido de tamanhos (por exemplo, AdSize.LARGE_BANNER) ou um tamanho adaptável.

AgeRestrictedTreatment

AgeRestrictedTreatment: typeof AgeRestrictedTreatment[keyof typeof AgeRestrictedTreatment]
Define as opções de tratamento com restrição de idade para solicitações de anúncios.
Propriedades
CHILD
Indica que as solicitações de anúncio devem receber tratamento para crianças.
TEEN
Indica que as solicitações de anúncio devem receber tratamento para adolescentes.
UNSPECIFIED
Indica que nenhum indicador de tratamento com restrição de idade específico se aplica à solicitação de anúncio.

ConsentStatus

ConsentStatus: typeof ConsentStatus[keyof typeof ConsentStatus]
Valores de status de consentimento.
Propriedades
NOT_REQUIRED
Não é necessário consentimento.
OBTAINED
Consentimento do usuário obtido, personalizado x não personalizado undefined.
REQUIRED
O consentimento do usuário é obrigatório, mas ainda não foi obtido.
UNKNOWN
Status de consentimento desconhecido.

DebugGeography

DebugGeography: typeof DebugGeography[keyof typeof DebugGeography]
Valores de depuração para testar a geografia.
Propriedades
DISABLED
A geografia de depuração foi desativada para dispositivos de depuração.
EEA
A geografia aparece como no EEE para dispositivos de depuração.
OTHER
A geografia aparece como em uma região sem regulamentação em vigor para o dispositivo de depuração.
REGULATED_US_STATE
A geografia aparece como em um estado regulamentado dos EUA para dispositivos de depuração.

FormErrorCode

FormErrorCode: typeof FormErrorCode[keyof typeof FormErrorCode]
Representa códigos de erro para falhas na operação do formulário da plataforma de mensagens para usuários (UMP).
Propriedades
ALREADY_USED
O formulário de consentimento já foi usado.
INTERNAL_ERROR
Algo aconteceu internamente no SDK.
INVALID_OPERATION
A operação era inválida.
NETWORK_ERROR
A operação de formulário falhou devido à conectividade de rede.
TIMEOUT
O tempo limite da operação de formulário expirou.
UNAVAILABLE
Nenhum formulário de consentimento está disponível.
UNKNOWN
Não foi possível mapear o código de erro para um código conhecido.

FullScreenContentErrorCode

FullScreenContentErrorCode: typeof FullScreenContentErrorCode[keyof typeof FullScreenContentErrorCode]
Propriedades
AD_ALREADY_USED
O anúncio já foi mostrado.
AD_NOT_READY
O anúncio não está pronto para ser exibido.
AD_TOO_LARGE
O anúncio é muito grande para a cena (somente iOS).
APP_NOT_FOREGROUND
O app não está em primeiro plano.
INTERNAL_ERROR
Algo aconteceu internamente. Por exemplo, uma exceção ocorreu ao se preparar para mostrar o conteúdo do anúncio.
MEDIATION_ERROR
O adaptador de mediação não mostrou o anúncio. Consulte FullScreenContentError.mediationAdError para saber a causa.
UNKNOWN
Não foi possível mapear o código de erro para um código conhecido.

LoadAdErrorCode

LoadAdErrorCode: typeof LoadAdErrorCode[keyof typeof LoadAdErrorCode]
Representa códigos de erro para falhas na operação de carregamento de anúncios.
Propriedades
AD_ALREADY_USED
A resposta do anúncio já foi usada para carregar um anúncio.
APP_ID_MISSING
A solicitação de anúncio não foi feita porque o ID do aplicativo está faltando.
CANCELLED
A solicitação de anúncio foi cancelada (somente no Android).
INTERNAL_ERROR
Algo aconteceu internamente no SDK.
INVALID_REQUEST
A solicitação de anúncio era inválida. Por exemplo, o ID do bloco de anúncios estava incorreto.
INVALID_RESPONSE
A resposta do anúncio de servidor para servidor é inválida. Por exemplo, não há um ID de solicitação na resposta do anúncio.
MEDIATION_ERROR
Não foi possível encontrar o adaptador de mediação ou realizar a solicitação de anúncio.
NETWORK_ERROR
A solicitação de anúncio não foi concluída devido à conectividade de rede.
NO_FILL
A solicitação de anúncio foi bem-sucedida, mas nenhum anúncio foi retornado devido à falta de inventário de anúncios.
TIMEOUT
O tempo limite da solicitação de anúncio expirou.
UNKNOWN
Não foi possível mapear o código de erro para um código conhecido.

MaxAdContentRating

MaxAdContentRating: typeof MaxAdContentRating[keyof typeof MaxAdContentRating]
Define a classificação máxima do conteúdo do anúncio para o app, classificando os tipos de anúncios que podem ser mostrados.
Propriedades
G
Conteúdo adequado para o público em geral, incluindo famílias e crianças.
MA
Conteúdo adequado somente para o público adulto.
PG
Conteúdo adequado para a maioria dos públicos com supervisão de adultos.
T
Conteúdo adequado para adolescentes e público adulto.
UNSPECIFIED
Nenhuma classificação do conteúdo especificada.

NativeAdAssetNames

NativeAdAssetNames: typeof NativeAdAssetNames[keyof typeof NativeAdAssetNames]
Nomes usados para identificar recursos de anúncios nativos padrão.
Propriedades
ADCHOICES_CONTAINER_VIEW
O contêiner da sobreposição das Opções de anúncios.
ADVERTISER
É o nome do anunciante.
BODY
É o texto principal do anúncio.
CALL_TO_ACTION
O texto da call-to-action do anúncio (por exemplo, "Instalar" ou "Saiba mais").
HEADLINE
O título do anúncio.
ICON
A imagem do ícone do anúncio.
MEDIA_CONTENT
O conteúdo de mídia principal do anúncio (imagem ou vídeo).
PRICE
O preço do app ou produto anunciado.
STAR_RATING
A nota do app ou produto anunciado.
STORE
O nome da loja.

NativeAdType

NativeAdType: typeof NativeAdType[keyof typeof NativeAdType]
Identifica o formato de um anúncio nativo carregado.
Propriedades
BANNER
Anúncio de banner.
CUSTOM_NATIVE
Anúncio de formato nativo personalizado.
NATIVE
Anúncio nativo.

NativeMediaAspectRatio

NativeMediaAspectRatio: typeof NativeMediaAspectRatio[keyof typeof NativeMediaAspectRatio]
Preferências para a proporção da mídia do anúncio nativo retornado.
Propriedades
ANY
Nenhuma preferência pela proporção da mídia do anúncio nativo retornado.
LANDSCAPE
Solicita uma proporção paisagem para a mídia de anúncio nativo retornada.
PORTRAIT
Solicite uma proporção retrato para a mídia do anúncio nativo retornada.
SQUARE
Solicitar uma proporção quadrada para a mídia do anúncio nativo retornada.
UNKNOWN
A proporção é desconhecida.

OnAdInspectorClosedListener

OnAdInspectorClosedListener: ((error?) => void)
Definição de interface para um callback a ser invocado quando a interface do inspetor de anúncios for fechada.

PrecisionType

PrecisionType: typeof PrecisionType[keyof typeof PrecisionType]
A precisão do valor do anúncio informado.
Propriedades
ESTIMATED
É um valor de anúncio estimado com base nos dados agregados.
PRECISE
O valor exato pago pelo anúncio.
PUBLISHER_PROVIDED
Um valor de anúncio fornecido pelo publisher, como CPMs manuais em um grupo de mediação.
UNKNOWN
Um valor de anúncio com precisão desconhecida.

PrivacyOptionsRequirementStatus

PrivacyOptionsRequirementStatus: typeof PrivacyOptionsRequirementStatus[keyof typeof PrivacyOptionsRequirementStatus]
Status do requisito de opções de privacidade.
Propriedades
NOT_REQUIRED
O ponto de entrada de opções de privacidade não é obrigatório.
REQUIRED
O ponto de entrada de opções de privacidade é obrigatório.
UNKNOWN
O status do requisito de opções de privacidade é desconhecido.

PublisherPrivacyPersonalizationState

PublisherPrivacyPersonalizationState: typeof PublisherPrivacyPersonalizationState[keyof typeof PublisherPrivacyPersonalizationState]
Indica os estados de personalização do tratamento de privacidade do publisher.
Propriedades
DEFAULT
Indica que a solicitação de anúncio deve receber o tratamento de privacidade padrão do publisher.
DISABLED
Indica que a solicitação de anúncio deve receber o tratamento de privacidade do publisher não personalizado.
ENABLED
Indica que a solicitação de anúncio deve receber o tratamento de privacidade do publisher personalizado.

ResizeMode

ResizeMode: typeof ResizeMode[keyof typeof ResizeMode]
Opções para personalizar o modo de redimensionamento do conteúdo da imagem em NativeAdMediaView.
Propriedades
CONTAIN
Dimensionar de maneira uniforme para caber na visualização.

A altura e a largura da imagem são dimensionadas juntas para que cada dimensão seja menor ou igual à dimensão correspondente da visualização. A imagem é dimensionada para caber dentro da visualização sem distorcer a proporção ou ser cortada.
COVER
Dimensionar uniformemente para cobrir a visualização.

A altura e a largura da imagem são dimensionadas juntas para que cada dimensão seja igual ou maior que a dimensão correspondente da visualização. A imagem é cortada para se ajustar à visualização sem distorcer a proporção.
STRETCH
Dimensione a largura e a altura de forma independente para preencher a visualização.

A altura e a largura da imagem são dimensionadas separadamente para corresponder às dimensões da visualização. A imagem é dimensionada para preencher a visualização completamente sem corte. No entanto, a proporção da imagem não é mantida.

ResolvedAdSize

ResolvedAdSize: FixedAdSize | FluidAdSize
Representa o estado final resolvido de um tamanho de anúncio depois que ele é carregado.

Para a maioria dos anúncios, isso resulta em um FixedAdSize com dimensões width e height exatas. Para anúncios de banner com tamanho dinâmico, isso resulta em um FluidAdSize em que as dimensões são gerenciadas pela hierarquia de visualização.

SwipeGestureDirection

SwipeGestureDirection: typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
Instruções para gestos de deslizar e clicar personalizados.
Propriedades
DOWN
Deslize para baixo.
LEFT
Deslize para a esquerda.
RIGHT
Deslize para a direita.
UP
Deslize para cima.

Variáveis

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;
}
Tamanhos de anúncio predefinidos e métodos auxiliares para criar tamanhos adaptáveis e personalizados.

Funções

canRequestAds

canRequestAds(): boolean
Verifica se o status de consentimento atual permite que você solicite anúncios.
Retorna
boolean true se você puder solicitar anúncios, false caso contrário.

getConsentStatus

getConsentStatus(): ConsentStatus
Recebe o status de consentimento atual do usuário.
Retorna
ConsentStatus O status de consentimento atual.

getInitializationStatus

getInitializationStatus(): InitializationStatus
Recebe o status de inicialização do SDK.

Use esse método para verificar se o SDK terminou de ser inicializado e inspecionar o status de adaptadores de mediação individuais.
Retorna
InitializationStatus O status atual da inicialização.

getPrivacyOptionsRequirementStatus

getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Verifica se um ponto de entrada de opções de privacidade é necessário para seu app.

Se um ponto de entrada for necessário, adicione um elemento da interface visível e interativo ao app que chame showPrivacyOptionsForm para mostrar o formulário de opções de privacidade. Se um ponto de entrada não for necessário, configure o elemento da interface para não ficar visível e interagível.
Retorna
PrivacyOptionsRequirementStatus O status do requisito de opções de privacidade.

getRequestConfiguration

getRequestConfiguration(): RequestConfiguration
Recebe a configuração global da solicitação.

Use esse método para recuperar a configuração de solicitação atual que foi aplicada globalmente.
Retorna
RequestConfiguration A configuração global atual da solicitação.

initialize

initialize(config, onInitializationComplete?): void
Inicializa o SDK do Google Mobile Ads.

Chame esse método antes de carregar um anúncio e antes de interagir com o restante do SDK do Google Mobile Ads.
Parâmetros
config: InitializationConfig Opções para controlar a inicialização do SDK.
Optional onInitializationComplete: ((status) => void) Uma função de callback a ser executada quando o SDK terminar a inicialização.

isConsentFormAvailable

isConsentFormAvailable(): boolean
Verifica se um formulário de consentimento está disponível.
Retorna
boolean true se um formulário de consentimento estiver disponível, false caso contrário.

loadAndShowConsentFormIfRequired

loadAndShowConsentFormIfRequired(onDismissed?): void
Carrega e apresenta um formulário de consentimento ao usuário se o status de consentimento atual exigir isso (por exemplo, o status é REQUIRED).
Parâmetros
Optional onDismissed: ((error?) => void) Função de callback invocada quando o formulário é dispensado ou se nenhum formulário é necessário, com um FormError opcional se a apresentação falhar.

openAdInspector

openAdInspector(_listener): void
Abre a sobreposição do Ad Inspector do SDK do Google Mobile Ads.

Use esse método para depurar configurações de mediação e origens de anúncios.
Parâmetros
_listener: OnAdInspectorClosedListener

openDebugMenu

openDebugMenu(adUnitId): void
Abre o menu de depuração.

Use esse método para abrir o menu de depuração de um bloco de anúncios específico e ajudar a testar e resolver problemas nas configurações de anúncios.
Parâmetros
adUnitId: string O ID do bloco de anúncios para abrir o menu de depuração.

parseLoadAdError

parseLoadAdError(error): LoadAdError
Analisa um erro nativo gerado durante o carregamento do anúncio e o encapsula em um LoadAdError.
Parâmetros
error: unknown O objeto de erro gerado pelo módulo nativo.
Retorna
LoadAdError Um objeto LoadAdError analisado.

requestConsentInfoUpdate

requestConsentInfoUpdate(params?, onComplete?): void
Solicita uma atualização das informações de consentimento.

Essa API precisa ser chamada em cada sessão do app antes de chamar getConsentStatus.

Depois que essa API é chamada, o valor de retorno getConsentStatus é atualizado de forma síncrona para manter o estado de consentimento da sessão anterior do app, se houver.

getConsentStatus pode ser atualizado novamente para o status atualizado depois que o callback onComplete é invocado.
Parâmetros
Optional params: ConsentRequestParameters Configurações opcionais para depuração e segmentação.
Optional onComplete: ((error?) => void) Função de callback invocada quando a atualização das informações de consentimento termina, com um FormError opcional se a solicitação falhar.

reset

reset(): void
Limpa todo o estado de consentimento do armazenamento persistente.

Use apenas para fins de depuração.

setPublisherFirstPartyIdEnabled

setPublisherFirstPartyIdEnabled(enabled): void
Controla se o ID próprio do publisher está ativado.

Ativa ou desativa o ID próprio do publisher do SDK do Google Mobile Ads, antes conhecido como mesma chave de app.
Consulte também
Parâmetros
enabled: boolean "True" para ativar o ID próprio do publisher; "false" para desativar. O valor padrão é true.

setRequestConfiguration

setRequestConfiguration(_config): void
Define a configuração global de solicitação para conformidade e segmentação.

Use esse método para especificar detalhes de segmentação, como classificação máxima do conteúdo do anúncio, configurações de conformidade (por exemplo, tag para tratamento por idade) e IDs de dispositivos de teste.
Parâmetros
_config: RequestConfiguration

setUserControlledAppVolume

setUserControlledAppVolume(volume): void
Define o volume de áudio do aplicativo controlado pelo usuário.

Use esse método para ajustar o volume de áudio de todos os anúncios em relação a outras saídas de áudio no dispositivo.
Parâmetros
volume: number O nível de volume, entre 0,0 (silencioso) e 1,0 (máximo). Qualquer valor de ponto flutuante dentro desse intervalo é válido (por exemplo, 0,001 ou 0,33333). O valor não é restrito a incrementos de taxa de aprendizado específicos, como 0,1.

setUserMutedApp

setUserMutedApp(muted): void
Define se o aplicativo está sem som.

Use esse método para controlar o estado inicial de silenciamento de áudio dos anúncios subsequentes.
Parâmetros
muted: boolean Se o áudio do aplicativo deve ser silenciado. O padrão é false.

showPrivacyOptionsForm

showPrivacyOptionsForm(onDismissed?): void
Mostra o formulário de opções de privacidade.

Apresenta um formulário de opções de privacidade se getPrivacyOptionsRequirementStatus for REQUIRED.

Esse método só deve ser chamado em resposta à entrada do usuário para solicitar que um formulário de opções de privacidade seja mostrado.

O formulário de opções de privacidade é pré-carregado automaticamente pelo SDK quando um formulário fica disponível. Se nenhum formulário tiver sido pré-carregado, o SDK vai tentar carregar um de forma assíncrona.

O callback onDismissed é chamado depois que o usuário recebe o formulário, seleciona uma opção e dispensa o formulário. Ele também pode retornar com um FormError se:
  • O formulário não está disponível.
  • O formulário não aparece.
  • O formulário ainda está sendo pré-carregado.
Parâmetros
Optional onDismissed: ((error?) => void) Função de callback invocada quando o formulário é dispensado, com um FormError opcional se a apresentação falhar.