Il modulo @google/mobile-ads fornisce le interfacce, le classi e le funzioni di primo livello principali di TypeScript per l'integrazione di Google Mobile Ads nelle applicazioni React Native.
Panoramica
-
Ciclo di vita e inizializzazione dell'SDK: utilizza
initializeconInitializationConfigper inizializzare l'SDK e ispezionare gli stati di inizializzazione dell'adattatore congetInitializationStatuseInitializationStatus. -
User Messaging Platform (UMP): gestisci il consenso degli utenti
con
requestConsentInfoUpdate,loadAndShowConsentFormIfRequired,showPrivacyOptionsForme ispeziona lo stato del consenso congetConsentStatusecanRequestAds. -
Configurazione richiesta: definisci le impostazioni globali di targeting e delle policy con
setRequestConfigurationeRequestConfiguration, configurando opzioni comeAgeRestrictedTreatment,MaxAdContentRatingePublisherPrivacyPersonalizationState. -
Formati degli annunci: carica e presenta gli annunci utilizzando classi di formato
come
AppOpenAd,InterstitialAd,RewardedAdeRewardedInterstitialAd. -
Strumenti per sviluppatori: ispeziona la pubblicazione degli annunci, lo stato dell'adattatore e le configurazioni dell'SDK in tempo reale utilizzando
openAdInspectoroopenDebugMenu.
| Alias del tipo | |
|---|---|
Adapter
|
Rappresenta i possibili stati di inizializzazione di un adattatore di mediazione.
|
Ad
|
Posizioni dell'icona Scegli Tu! nella visualizzazione di annuncio. |
Ad
|
Formato dell'annuncio richiesto. |
Ad
|
Informazioni sull'errore che indica il motivo per cui lo strumento di controllo degli annunci non è riuscito.
|
Ad
|
Errori che influiscono sull'apertura o sul funzionamento dello strumento di controllo degli annunci.
|
Ad
|
Opzioni di orientamento per gli annunci banner adattivi in linea e ancorati di grandi dimensioni.
|
Ad
|
Rappresenta le dimensioni di un annuncio. |
Age
|
Definisce le opzioni di trattamento con limiti di età per le richieste di annunci.
|
Consent
|
Valori dello stato del consenso. |
Debug
|
Valori di debug per testare la geografia. |
Form
|
Rappresenta i codici di errore per gli errori di
operazione del modulo User Messaging Platform (UMP).
|
Full
|
|
Load
|
Rappresenta i codici di errore per gli errori dell'operazione di caricamento degli annunci.
|
Max
|
Definisce la classificazione massima dei contenuti degli annunci per l'app, classificando
i tipi di annunci che possono essere mostrati.
|
Native
|
Nomi utilizzati per identificare gli asset annuncio nativi standard.
|
Native
|
Identifica il formato di un annuncio nativo caricato. |
Native
|
Preferenze per le proporzioni dei contenuti multimediali degli annunci nativi restituiti.
|
On
|
Definizione dell'interfaccia per un callback da richiamare quando l'UI
dello strumento di controllo degli annunci si chiude.
|
Precision
|
La precisione del valore dell'annuncio riportato. |
Privacy
|
Stato dei requisiti delle opzioni per la privacy. |
Publisher
|
Indica gli stati di personalizzazione del trattamento della privacy
dell'editore.
|
Resize
|
Opzioni per personalizzare la modalità di ridimensionamento dei contenuti delle immagini in
NativeAdMediaView.
|
Resolved
|
Rappresenta lo stato finale risolto di una dimensione dell'annuncio dopo il caricamento
di un annuncio.
|
Swipe
|
Indicazioni per i gesti di scorrimento personalizzati per fare clic. |
| Variabili | |
|---|---|
Ad
|
Dimensioni degli annunci predefinite e metodi helper per la creazione di dimensioni adattive e
personalizzate.
|
| Funzioni | |
|---|---|
can
|
Verifica se lo stato attuale del consenso ti consente di richiedere
annunci.
|
get
|
Restituisce lo stato attuale del consenso dell'utente. |
get
|
Restituisce lo stato di inizializzazione dell'SDK. |
get
|
Verifica se è necessario un punto di accesso alle opzioni sulla privacy per
la tua app.
|
get
|
Recupera la configurazione globale delle richieste. |
initialize
|
Inizializza l'SDK Google Mobile Ads. |
is
|
Controlla se è disponibile un modulo di consenso. |
load
|
Carica un modulo di consenso e lo presenta all'utente se il suo
stato attuale del consenso lo richiede (ad es. lo stato è REQUIRED).
|
open
|
Apre la sovrapposizione dello strumento di controllo degli annunci dell'SDK Google Mobile Ads.
|
open
|
Apre il menu di debug. |
parse
|
Analizza un errore nativo generato durante il caricamento dell'annuncio e lo racchiude in un
LoadAdError.
|
request
|
Richiede un aggiornamento delle informazioni sul consenso. |
reset
|
Cancella tutto lo stato del consenso dallo spazio di archiviazione permanente.
|
set
|
Controlla se l'ID proprietario del publisher è attivato.
|
set
|
Imposta la configurazione globale delle richieste per la conformità e
il targeting.
|
set
|
Imposta il volume audio dell'applicazione controllata dall'utente.
|
set
|
Determina se l'applicazione è disattivata. |
show
|
Mostra il modulo delle opzioni per la privacy. |
Alias del tipo
AdapterState
AdapterState: typeof AdapterState[keyof typeof AdapterState]
AdChoicesPlacement
AdChoicesPlacement:
typeof AdChoicesPlacement[keyof typeof AdChoicesPlacement]
AdFormat
Formato dell'annuncio richiesto.
AdInspectorError
AdInspectorError:
BaseError<AdInspectorErrorCode>
AdInspectorErrorCode
AdInspectorErrorCode:
typeof AdInspectorErrorCode[keyof typeof AdInspectorErrorCode]
AdOrientation
AdOrientation: typeof AdOrientation[keyof typeof AdOrientation]
| Proprietà | |
|---|---|
CURRENT
|
|
LANDSCAPE
|
|
PORTRAIT
|
|
AdSize
Rappresenta le dimensioni di un annuncio.
Può essere uno di un insieme predefinito di dimensioni (ad es. AdSize.LARGE_BANNER) o una dimensione adattabile.
Può essere uno di un insieme predefinito di dimensioni (ad es. AdSize.LARGE_BANNER) o una dimensione adattabile.
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]
| Proprietà | |
|---|---|
AD_
|
L'annuncio è già stato mostrato. |
AD_
|
L'annuncio non è pronto per essere pubblicato. |
AD_
|
L'annuncio è troppo grande per la scena (solo iOS). |
APP_
|
L'app non è in primo piano. |
INTERNAL_
|
Si è verificato un problema interno, ad esempio un'eccezione
durante la preparazione alla visualizzazione dei contenuti dell'annuncio.
|
MEDIATION_
|
L'adattatore di mediazione non è riuscito a mostrare l'annuncio. Consulta
FullScreenContentError.mediationAdError
per la causa sottostante.
|
UNKNOWN
|
Impossibile mappare il codice di errore a un codice di errore noto.
|
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]
| Proprietà | |
|---|---|
BANNER
|
Annuncio banner. |
CUSTOM_
|
Annuncio nel formato nativo personalizzato. |
NATIVE
|
Annuncio 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
Per la maggior parte degli annunci, questo si risolve in un FixedAdSize con dimensioni
width e height esatte.
Per gli annunci banner con dimensioni dinamiche, questo valore viene risolto in un
FluidAdSize
in cui le dimensioni vengono gestite dalla gerarchia di oggetti View.
SwipeGestureDirection
SwipeGestureDirection:
typeof SwipeGestureDirection[keyof typeof SwipeGestureDirection]
| Proprietà | |
|---|---|
DOWN
|
Scorri verso il basso. |
LEFT
|
Scorri a sinistra. |
RIGHT
|
Scorri verso destra. |
UP
|
Scorri verso l'alto. |
Variabili
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;
}
Funzioni
canRequestAds
canRequestAds(): boolean
Verifica se lo stato attuale del consenso ti consente di richiedere
annunci.
| Resi | |
|---|---|
boolean
|
true se puoi richiedere annunci,
false altrimenti.
|
getConsentStatus
getConsentStatus(): ConsentStatus
Restituisce lo stato attuale del consenso dell'utente.
| Resi | |
|---|---|
ConsentStatus
|
Lo stato attuale del consenso. |
getInitializationStatus
getInitializationStatus(): InitializationStatus
Restituisce lo stato di inizializzazione dell'SDK.
Utilizza questo metodo per verificare se l'inizializzazione dell'SDK è terminata e per esaminare lo stato dei singoli adattatori di mediazione.
Utilizza questo metodo per verificare se l'inizializzazione dell'SDK è terminata e per esaminare lo stato dei singoli adattatori di mediazione.
| Resi | |
|---|---|
InitializationStatus
|
Lo stato di inizializzazione attuale. |
getPrivacyOptionsRequirementStatus
getPrivacyOptionsRequirementStatus(): PrivacyOptionsRequirementStatus
Verifica se è necessario un punto di accesso alle opzioni sulla privacy per la tua
app.
Se è necessario un punto di accesso, aggiungi un elemento dell'interfaccia utente visibile e interattivo alla tua app che chiama showPrivacyOptionsForm per visualizzare il modulo delle opzioni sulla privacy. Se un punto di ingresso non è obbligatorio, configura l'elemento UI in modo che non sia visibile e interattivo.
Se è necessario un punto di accesso, aggiungi un elemento dell'interfaccia utente visibile e interattivo alla tua app che chiama showPrivacyOptionsForm per visualizzare il modulo delle opzioni sulla privacy. Se un punto di ingresso non è obbligatorio, configura l'elemento UI in modo che non sia visibile e interattivo.
| Resi | |
|---|---|
PrivacyOptionsRequirementStatus
|
Lo stato dei requisiti delle opzioni per la privacy. |
getRequestConfiguration
getRequestConfiguration(): RequestConfiguration
Recupera la configurazione globale delle richieste.
Utilizza questo metodo per recuperare la configurazione delle richieste attuale che è stata applicata a livello globale.
Utilizza questo metodo per recuperare la configurazione delle richieste attuale che è stata applicata a livello globale.
| Resi | |
|---|---|
RequestConfiguration
|
La configurazione attuale della richiesta globale. |
initialize
initialize(config,
onInitializationComplete?): void
Inizializza l'SDK Google Mobile Ads.
Chiama questo metodo prima di caricare un annuncio e prima di interagire con il resto dell'SDK Google Mobile Ads.
Chiama questo metodo prima di caricare un annuncio e prima di interagire con il resto dell'SDK Google Mobile Ads.
| Parametri | |
|---|---|
config:
InitializationConfig
|
Opzioni per controllare l'inizializzazione dell'SDK. |
|
Una funzione di callback da eseguire al termine dell'inizializzazione dell'SDK. |
isConsentFormAvailable
isConsentFormAvailable(): boolean
Controlla se è disponibile un modulo di consenso.
| Resi | |
|---|---|
boolean
|
true se è disponibile un modulo di consenso,
false altrimenti.
|
loadAndShowConsentFormIfRequired
loadAndShowConsentFormIfRequired(onDismissed?): void
Carica un modulo di consenso e lo presenta all'utente se il suo stato
attuale del consenso lo richiede (ad es. lo stato è REQUIRED).
| Parametri | |
|---|---|
|
Funzione di callback richiamata quando il modulo viene chiuso o se non è richiesto alcun modulo, con un FormError facoltativo se la presentazione non è riuscita. |
openAdInspector
openAdInspector(_listener): void
Apre la sovrapposizione dello strumento di controllo degli annunci dell'SDK Google Mobile Ads.
Utilizza questo metodo per eseguire il debug delle configurazioni di mediazione e delle origini annuncio.
Utilizza questo metodo per eseguire il debug delle configurazioni di mediazione e delle origini annuncio.
| Parametri | |
|---|---|
_listener:
OnAdInspectorClosedListener
|
|
openDebugMenu
openDebugMenu(adUnitId): void
Apre il menu di debug.
Utilizza questo metodo per aprire il menu di debug per un'unità pubblicitaria specifica per facilitare il test e la risoluzione dei problemi relativi alle configurazioni degli annunci.
Utilizza questo metodo per aprire il menu di debug per un'unità pubblicitaria specifica per facilitare il test e la risoluzione dei problemi relativi alle configurazioni degli annunci.
| Parametri | |
|---|---|
adUnitId: string
|
L'ID unità pubblicitaria per cui aprire il menu di debug. |
parseLoadAdError
parseLoadAdError(error): LoadAdError
Analizza un errore nativo generato durante il caricamento dell'annuncio e lo racchiude in un
LoadAdError.
| Parametri | |
|---|---|
error: unknown
|
L'oggetto di errore generato dal modulo nativo. |
| Resi | |
|---|---|
LoadAdError
|
Un oggetto LoadAdError analizzato. |
requestConsentInfoUpdate
requestConsentInfoUpdate(params?, onComplete?): void
Richiede un aggiornamento delle informazioni sul consenso.
Questa API deve essere chiamata in ogni sessione dell'app prima di chiamare getConsentStatus.
Dopo aver chiamato questa API, il valore restituito di getConsentStatus viene aggiornato in modo sincrono per contenere lo stato del consenso della sessione dell'app precedente, se esistente.
getConsentStatus può essere aggiornato di nuovo allo stato aggiornato dopo l'invocazione del callback
Questa API deve essere chiamata in ogni sessione dell'app prima di chiamare getConsentStatus.
Dopo aver chiamato questa API, il valore restituito di getConsentStatus viene aggiornato in modo sincrono per contenere lo stato del consenso della sessione dell'app precedente, se esistente.
getConsentStatus può essere aggiornato di nuovo allo stato aggiornato dopo l'invocazione del callback
onComplete.
| Parametri | |
|---|---|
|
Configurazioni facoltative per il debug e il targeting. |
|
Funzione di callback richiamata al termine dell'aggiornamento delle informazioni sul consenso, con un FormError facoltativo se la richiesta non è riuscita. |
reset
reset(): void
Cancella tutti gli stati del consenso dallo spazio di archiviazione permanente.
Utilizza solo a scopo di debug.
Utilizza solo a scopo di debug.
setPublisherFirstPartyIdEnabled
setPublisherFirstPartyIdEnabled(enabled): void
Controlla se l'ID proprietario del publisher è abilitato.
Attiva o disattiva l'ID proprietario del publisher dell'SDK Google Mobile Ads, precedentemente noto come stessa chiave dell'app.
Attiva o disattiva l'ID proprietario del publisher dell'SDK Google Mobile Ads, precedentemente noto come stessa chiave dell'app.
- Vedi anche
| Parametri | |
|---|---|
enabled: boolean
|
Vero per attivare l'ID proprietario del publisher; falso per
disattivarlo. Il valore predefinito è true.
|
setRequestConfiguration
setRequestConfiguration(_config): void
Imposta la configurazione globale delle richieste per la conformità e
il targeting.
Utilizza questo metodo per specificare i dettagli del targeting, ad esempio la classificazione massima dei contenuti degli annunci, le impostazioni di conformità, come il tag per il trattamento in base all'età, e gli ID dispositivo di test.
Utilizza questo metodo per specificare i dettagli del targeting, ad esempio la classificazione massima dei contenuti degli annunci, le impostazioni di conformità, come il tag per il trattamento in base all'età, e gli ID dispositivo di test.
| Parametri | |
|---|---|
_config:
RequestConfiguration
|
|
setUserControlledAppVolume
setUserControlledAppVolume(volume): void
Imposta il volume audio dell'applicazione controllata dall'utente.
Utilizza questo metodo per regolare il volume audio di tutti gli annunci rispetto ad altri output audio sul dispositivo.
Utilizza questo metodo per regolare il volume audio di tutti gli annunci rispetto ad altri output audio sul dispositivo.
| Parametri | |
|---|---|
volume: number
|
Il livello di volume, compreso tra 0,0 (silenzioso) e 1,0 (massimo). Qualsiasi valore in virgola mobile compreso in questo intervallo è valido (ad esempio 0,001 o 0,33333). Il valore non è limitato a incrementi specifici della dimensione del passo, ad esempio 0,1. |
setUserMutedApp
setUserMutedApp(muted): void
Imposta se l'applicazione è disattivata.
Utilizza questo metodo per controllare lo stato iniziale di disattivazione dell'audio degli annunci successivi.
Utilizza questo metodo per controllare lo stato iniziale di disattivazione dell'audio degli annunci successivi.
| Parametri | |
|---|---|
muted: boolean
|
Indica se l'audio dell'applicazione deve essere disattivato. Il valore predefinito è
false.
|
showPrivacyOptionsForm
showPrivacyOptionsForm(onDismissed?): void
Mostra il modulo delle opzioni per la privacy.
Presenta un modulo delle opzioni per la privacy se getPrivacyOptionsRequirementStatus è
Questo metodo deve essere chiamato solo in risposta all'input dell'utente per richiedere la visualizzazione di un modulo delle opzioni per la privacy.
Il modulo delle opzioni per la privacy viene precaricato automaticamente dall'SDK quando un modulo diventa disponibile. Se non è stato precaricato alcun modulo, l'SDK tenterà di caricarne uno in modo asincrono.
Il callback
Presenta un modulo delle opzioni per la privacy se getPrivacyOptionsRequirementStatus è
REQUIRED.Questo metodo deve essere chiamato solo in risposta all'input dell'utente per richiedere la visualizzazione di un modulo delle opzioni per la privacy.
Il modulo delle opzioni per la privacy viene precaricato automaticamente dall'SDK quando un modulo diventa disponibile. Se non è stato precaricato alcun modulo, l'SDK tenterà di caricarne uno in modo asincrono.
Il callback
onDismissed viene chiamato dopo che all'utente viene presentato il modulo, seleziona un'opzione e chiude il modulo. Può anche restituire un
FormError
se:
- Il modulo non è disponibile.
- Il modulo non viene visualizzato.
- Il modulo è ancora in fase di precaricamento.
| Parametri | |
|---|---|
|
Funzione di callback richiamata quando il modulo viene chiuso, con un FormError opzionale se la presentazione non è riuscita. |