Classe: ImaSdkSettings

google.ima.ImaSdkSettings

class pubblico statico

Questo corso contiene impostazioni a livello di SDK.

Enumerazioni

Modalità Backfill companion

costante statico

string

Definisce un insieme di costanti per l'impostazione di backfill companion. Questa impostazione indica se è necessario eseguire il backfill dei companion in vari scenari.

Se il valore è ALWAYS, verrà effettuato un tentativo di backfill companion in tutte le situazioni, anche quando non viene restituito alcun annuncio principale.

Se il valore è ON_MASTER_AD, verrà effettuato un tentativo di backfill companion se è presente un annuncio principale con meno companion rispetto agli slot companion. Verrà eseguito il backfill delle creatività companion mancanti.

Il valore predefinito è ALWAYS.

Tieni presente che per il backfill companion lato client è necessario taggare correttamente i companion con un tag publisher di Google (GPT). Per abilitare il backfill, sono necessarie le seguenti modifiche alla configurazione dei tag GPT standard:

...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();

Per i video con riproduzione automatica, consigliamo di apportare la seguente modifica aggiuntiva per evitare che le aree companion vengano precaricate e poi sostituite immediatamente con le creatività companion.

googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Valore
SEMPRE
ANNUNCIO_MASTER_AD

Modalità a pagamento

costante statico

number

Un insieme di costanti per l'attivazione della funzionalità VPAID.

Valore
DISABILITATA	Gli annunci VPAID non verranno riprodotti e verrà restituito un errore.
ATTIVATO	Gli annunci VPAID sono abilitati utilizzando un iframe interdominio. L'annuncio VPAID non può accedere al sito. Gli annunci VPAID che dipendono dall'accesso agli iframe semplici potrebbero contenere errori. Si tratta dell'impostazione predefinita.
INSECURO	Gli annunci VPAID sono attivati utilizzando un iframe semplice. Ciò consente l'accesso all'annuncio al sito tramite JavaScript.

Proprietà

Modalità Backfill companion

costante statico

string

Definisce un insieme di costanti per l'impostazione di backfill companion. Questa impostazione indica se è necessario eseguire il backfill dei companion in vari scenari.

Se il valore è ALWAYS, verrà effettuato un tentativo di backfill companion in tutte le situazioni, anche quando non viene restituito alcun annuncio principale.

Se il valore è ON_MASTER_AD, verrà effettuato un tentativo di backfill companion se è presente un annuncio principale con meno companion rispetto agli slot companion. Verrà eseguito il backfill delle creatività companion mancanti.

Il valore predefinito è ALWAYS.

Tieni presente che per il backfill companion lato client è necessario taggare correttamente i companion con un tag publisher di Google (GPT). Per abilitare il backfill, sono necessarie le seguenti modifiche alla configurazione dei tag GPT standard:

...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();

Per i video con riproduzione automatica, consigliamo di apportare la seguente modifica aggiuntiva per evitare che le aree companion vengano precaricate e poi sostituite immediatamente con le creatività companion.

googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

Valore
SEMPRE
ANNUNCIO_MASTER_AD

Modalità a pagamento

costante statico

number

Un insieme di costanti per l'attivazione della funzionalità VPAID.

Valore
DISABILITATA	Gli annunci VPAID non verranno riprodotti e verrà restituito un errore.
ATTIVATO	Gli annunci VPAID sono abilitati utilizzando un iframe interdominio. L'annuncio VPAID non può accedere al sito. Gli annunci VPAID che dipendono dall'accesso agli iframe semplici potrebbero contenere errori. Si tratta dell'impostazione predefinita.
INSECURO	Gli annunci VPAID sono attivati utilizzando un iframe semplice. Ciò consente l'accesso all'annuncio al sito tramite JavaScript.

Metodi

getBackBackfill

getCompanionBackfill() restituisce CompanionBackfillMode

Restituisce la modalità di backfill companion corrente.

Valori restituiti

non-null CompanionBackfillMode Il valore corrente.

getDisabilitaCustomCustomForIOS10Plus

getdisableCustomCopyForIOS10Plus() restituisce booleano

Indica se disattivare la riproduzione personalizzata nei browser iOS 10 e successivi. Il valore predefinito è false.

Valori restituiti

boolean 

Flag getfeature

getFeatureFlags() restituisce l'oggetto con qualsiasi proprietà di tipo

Restituisce un oggetto con chiavi come flag delle funzionalità e valori come relativi allo stato attuale.

Valori restituiti

non-null Object with any type properties 

getLocale

getLocale() restituisce la stringa

Restituisce la lingua fornita dal publisher.

Valori restituiti

string Impostazioni internazionali fornite dal publisher.

getNumRedirects

getNumRedirects() restituisce il numero

Restituisce il numero massimo di reindirizzamenti per i successivi reindirizzamenti che verranno rifiutati.

Valori restituiti

number il numero massimo di reindirizzamenti.

getPlayerType

getPlayerType() restituisce stringa

Restituisce il tipo di player fornito dal partner.

Valori restituiti

string Tipo di partner partner.

getPlayerVersion

getPlayerVersion() restituisce stringa

Restituisce la versione del player fornita dal partner.

Valori restituiti

string Versione del player del partner.

getPpid

getPpid() restituisce (null o stringa)

Restituisce l'ID fornito dal publisher.

Valori restituiti

(null or string) ID fornito dal publisher.

isCookiesEnabled

isCookiesEnabled() restituisce un valore booleano

Valori restituiti

boolean Indica se l'editore consente l'utilizzo dei cookie.

impostaAutoPlayAdBreaks

setAutoPlayAdBreaks(autoPlayAdBreaks) restituisce nullo

Imposta se le interruzioni pubblicitarie VMAP e delle regole annunci vengono riprodotte automaticamente

Parametro
interruzioni pubblicitarie automatiche	boolean Indica se riprodurre automaticamente le interruzioni pubblicitarie.

Valori restituiti

void 

setCompanionBackfill

setCompanionBackfill(mode) restituisce vuoto

Imposta la modalità di backfill companion. Scopri le varie modalità disponibili in ImaSdkSettings.CompanionBackfillMode.

La modalità predefinita è ImaSdkSettings.CompanionBackfillMode.ALWAYS.

Parametro
modalità	Modalità Backfill companion La modalità di backfill companion scelta. Il valore non deve essere null.

Valori restituiti

void 

impostatoCookieCookie

setCookiesEnabled(cookiesEnabled) restituisce vuoto

Indica se l'SDK deve memorizzare un cookie Google Ad Manager (cookie GFP) nel dominio del publisher, come cookie originale. Ciò consente la persistenza di più visite allo stesso dominio senza l'utilizzo di cookie di terze parti. Il valore predefinito è true.

Questa impostazione non influisce sugli altri cookie che potrebbero essere impostati da altre parti o per altri scopi. Il consenso e le disattivazioni degli utenti possono anche disattivare l'utilizzo dei cookie originali. che verranno raccolti dall'utilizzo da parte dell'editore di un fornitore di servizi di gestione del consenso conforme allo IAB, se nello stesso frame.

Parametro
cookieAttivato	boolean

Valori restituiti

void 

impostaDisabilita la riproduzione personalizzataPer iOS10 Plus

setDisabledCustomCustomForIOS10Plus(disable) returns void

Consente di stabilire se disattivare la riproduzione personalizzata nei browser iOS 10 e successivi. Se true, gli annunci vengono riprodotti in linea se il video è incorporato. In questo modo, vengono attivati gli annunci TrueView ignorabili. Tuttavia, l'annuncio rimarrà in linea e non supporterà la modalità a schermo intero nativa di iOS. Se il valore è false, gli annunci vengono riprodotti nello stesso player dei contenuti. Il valore impostato qui quando viene creato un AdDisplayContainer viene utilizzato per tutta la durata del container. Il valore predefinito è false.

Parametro
Disattiva	boolean Indica se disattivare o meno la riproduzione personalizzata.

Valori restituiti

void 

setFlag

setFeatureFlags(featureFlags) restituisce nullo

Imposta il valore di tutti i flag di funzionalità. Deve essere impostato il prima possibile, prima di richiedere annunci. Le impostazioni rimarranno costanti fino alla successiva richiesta di annuncio. In tal caso, tutti i flag di funzionalità verranno reimpostati per la richiesta di annuncio successiva.

Parametro
flag funzionalità	Oggetto con proprietà di qualsiasi tipo Il valore non deve essere null.

Valori restituiti

void 

impostaLocale

setLocale(locale) void void

Imposta le impostazioni internazionali fornite dal publisher. Deve essere chiamato prima di creare AdsLoader o AdDisplayContainer. Le impostazioni internazionali specificano la lingua in cui visualizzare gli elementi dell'interfaccia utente. I codici supportati sono disponibili nella sezione Localizzazione per lingua e lingua.

Parametro
locale	string Impostazioni internazionali fornite dal publisher.

Valori restituiti

void 

setNumRedirects

setNumRedirects(numRedirects) restituisce nullo

Specifica il numero massimo di reindirizzamenti prima che i successivi reindirizzamenti vengano rifiutati e il carico dell'annuncio è stato interrotto. Il numero di reindirizzamenti influisce direttamente sulla latenza e quindi sull'esperienza utente. Questo vale per tutti gli annunci wrapper VAST.

Parametro
numReindirizzamenti	number il numero massimo di reindirizzamenti.

Valori restituiti

void 

SetPlayerType

setPlayerType(playerType) returnsvoid

Imposta il tipo di player fornito dal partner. Questa impostazione deve essere utilizzata per specificare il nome del player da integrare con l'SDK. Il tipo di player superiore a 20 caratteri verrà troncato. Il tipo di player specificato deve essere breve e univoco. Si tratta di un'impostazione facoltativa utilizzata per migliorare l'usabilità dell'SDK monitorando i tipi di player.

Esempio:

settings.setPlayerType('google/gmf-player');

Parametro
playerType	string Il tipo di player del partner.

Valori restituiti

void 

setPlayerVersion

setPlayerVersion(playerVersion) returns void

Imposta la versione del player fornita dal partner. Questa impostazione deve essere utilizzata per specificare la versione del player del partner che viene integrata con l'SDK. Le versioni del player superiori a 20 caratteri verranno troncate. Si tratta di un'impostazione facoltativa utilizzata per migliorare l'usabilità dell'SDK monitorando la versione del player.

Esempio:

settings.setPlayerVersion('1.0.0');

Parametro
PlayerVersion	string La versione del player del partner.

Valori restituiti

void 

impostaPpid

setPpid(ppid) restituisce vuoto

Imposta l'ID fornito dal publisher.

Parametro
ppi	string ID fornito dal publisher.

Valori restituiti

void 

ID sessione

setSessionId(sessionId) returnsvoid

L'ID sessione è un ID casuale temporaneo. Viene utilizzato esclusivamente per la quota limite. L'ID sessione deve essere un UUID.

Parametro
ID sessione	string Un UUID temporaneo utilizzato per la quota limite.

Valori restituiti

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid) restituisce vuoto

Deprecato. Usa setVpaidMode. Consente di stabilire se le creatività VPAID sono consentite.

Parametro
allowVpaid	boolean Indica se consentire le creatività VPAID.

Valori restituiti

void 

Imposta modalità a pagamento

setVpaidMode(vpaidMode) restituisce vuoto

Imposta la modalità di riproduzione VPAID.

Parametro
Modalità vpaid	Modalità a pagamento Imposta la riproduzione degli annunci VPAID. L'impostazione predefinita è la modalità protetta. Il valore non deve essere null.

Valori restituiti

void