Riferimento GPT

Questo riferimento utilizza la notazione TypeScript per descrivere i tipi. La seguente tabella fornisce una breve spiegazione tramite un esempio.

Tipo di espressione
string Il tipo di stringa primitivo.
string[] Un tipo di array in cui i valori possono essere solo stringhe.
number | string Un tipo di unione, in cui il valore può essere un numero o una stringa.
Array<number | string> Un tipo di array in cui i valori sono di tipo complesso (unione).
[number, string] Un tipo di tupla, in cui il valore è una matrice di due elementi che deve contenere un numero e una stringa in questo ordine.
Slot Un tipo di oggetto, in cui il valore è un'istanza di googletag.Slot.
() => void Un tipo di funzione senza argomenti definiti e senza valore restituito.

Per saperne di più sui tipi e sulle espressioni di tipo supportati, consulta il manuale di TypeScript .

Digitare annotazioni

I due punti dopo una variabile, il nome del parametro, il nome della proprietà o la firma della funzione indicano un'annotazione di tipo. Le annotazioni dei tipi descrivono i tipi che l'elemento a sinistra dei due punti può accettare o restituire. La seguente tabella mostra esempi di annotazioni dei tipi che potresti vedere in questo riferimento.

Digita annotazione
param: string Indica che param accetta o restituisce un valore stringa. Questa sintassi viene utilizzata per variabili, parametri, proprietà e tipi restituiti.
param?: number | string Indica che param è facoltativo, ma accetta un numero o una stringa se specificato. Questa sintassi viene utilizzata per i parametri e le proprietà.
...params: Array<() => void> Indica che params è un parametro riposo che accetta funzioni. I parametri rimanenti accettano un numero illimitato di valori del tipo specificato.

Definizioni dei tipi

Tipi
SingleSize | MultiSize

Una configurazione delle dimensioni valida per uno slot, che può avere una o più dimensioni.
SingleSize[]

Un elenco di singole dimensioni valide.
"fluid" | ["fluid"]

Dimensioni denominate che possono avere uno slot. Nella maggior parte dei casi la dimensione è un rettangolo a dimensione fissa, ma in alcuni casi sono necessari altri tipi di specifiche relative alle dimensioni. Solo le seguenti sono dimensioni denominate valide:

  • fluid: il contenitore di annunci occupa il 100% della larghezza del div principale e poi ne ridimensiona l'altezza per adattarla ai contenuti della creatività. Simile al comportamento degli elementi di blocco regolari su una pagina. Utilizzato per gli annunci nativi (consulta l'articolo correlato). Tieni presente che sia fluid che ['fluid'] sono formati accettabili per dichiarare le dimensioni di un'area come fluida.
SingleSizeArray | NamedSize

Un'unica dimensione valida per un'area annuncio.
[number, number]

Array di due numeri che rappresentano [larghezza, altezza].
[SingleSizeArray, GeneralSize]

Una mappatura delle dimensioni dell'area visibile alle dimensioni degli annunci. Utilizzato per gli annunci adattabili.
SizeMapping[]

Un elenco di mappature delle dimensioni.
"unhideWindow" | "navBar"

Attivatori di annunci interstitial supportati.
"disablePersonalization"

Le cure per la privacy dei publisher supportate.
"IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"

Tassonomie supportate per gli indicatori forniti dal publisher (PPS).
BidderSignalProvider | PublisherSignalProvider

Interfaccia per la restituzione di un indicatore sicuro per uno specifico offerente o fornitore. È necessario specificare id o networkCode, ma non entrambi.

Tipi di enumerazione

Enum
googletag.enums.OutOfPageFormat
Formati fuori pagina supportati da GPT.
googletag.enums.TrafficSource
Sorgenti di traffico supportate da GPT.

googletag.enums.OutOfPageFormat

  • Formati fuori pagina supportati da GPT.

  • Vedi anche
  • Valori
    BOTTOM_ANCHOR
    Formato di ancoraggio in cui l'area si fissa alla parte inferiore dell'area visibile.
    INTERSTITIAL
    Formato della creatività interstitial per il web.
    LEFT_SIDE_RAIL
    Formato laterale sinistro.
    REWARDED
    Formato con premio.
    RIGHT_SIDE_RAIL
    Formato laterale destro.
    TOP_ANCHOR
    Formato di ancoraggio in cui l'area si fissa alla parte superiore dell'area visibile.

googletag.enums.TrafficSource

  • Sorgenti di traffico supportate da GPT.

  • Vedi anche
  • Valori
    ORGANIC
    Inserimento diretto di URL, ricerca su sito o download di app.
    PURCHASED
    Traffico reindirizzato da proprietà diverse da quelle possedute (attività acquisita o incentivata in altro modo).

googletag

Lo spazio dei nomi globale utilizzato da Tag publisher di Google per la propria API.

Riepilogo delle variabili
apiReady
Flag che indica che l'API GPT è caricata e pronta per essere chiamata.
cmd
Riferimento alla coda globale dei comandi per l'esecuzione asincrona delle chiamate correlate a GPT.
pubadsReady
Flag che indica che PubAdsService è abilitato, caricato e completamente operativo.
secureSignalProviders
Riferimento all'array dei fornitori di indicatori sicuri.
Riepilogo funzione
companionAds
Restituisce un riferimento a CompanionAdsService.
defineOutOfPageSlot
Crea un'area annuncio fuori pagina con il percorso dell'unità pubblicitaria specificato.
defineSlot
Consente di creare un'area annuncio con una determinata dimensione e un percorso dell'unità pubblicitaria e di associarla all'ID di un elemento div nella pagina che conterrà l'annuncio.
destroySlots
Elimina gli slot specificati, rimuovendo tutti gli oggetti correlati e i riferimenti a questi slot da GPT.
disablePublisherConsole
Disattiva la Google Publisher Console.
display
Indica ai servizi slot di eseguire il rendering dello slot.
enableServices
Attiva tutti i servizi GPT definiti per le aree annuncio nella pagina.
getVersion
Restituisce la versione corrente di GPT.
openConsole
Apre Google Publisher Console.
pubads
Restituisce un riferimento a PubAdsService.
setAdIframeTitle
Imposta il titolo per tutti gli iframe del contenitore di annunci creati da PubAdsService, da questo momento in poi.
setConfig
Consente di impostare le opzioni di configurazione generali per la pagina.
sizeMapping
Crea una nuova SizeMappingBuilder.

googletag.apiReady

  • apiReady: boolean | undefined

  • Flag che indica che l'API GPT è caricata e pronta per essere chiamata. Questa proprietà sarà semplicemente undefined finché l'API non sarà pronta.

    Tieni presente che il modo consigliato per gestire l'asinc è usare googletag.cmd per mettere in coda i callback per quando GPT è pronto. Questi callback non devono necessariamente selezionare googletag.apiReady in quanto ne è garantita l'esecuzione dopo la configurazione dell'API.

  • Esempio

    JavaScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    JavaScript (legacy)

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

    TypeScript

    if (window.googletag && googletag.apiReady) {
  // GPT API can be called safely.
}

googletag.cmd

  • cmd: Array<(this: typeof globalThis) => void> | CommandArray

  • Riferimento alla coda dei comandi globale per l'esecuzione asincrona delle chiamate correlate a GPT.

    La variabile googletag.cmd viene inizializzata in un array JavaScript vuoto dalla sintassi del tag GPT sulla pagina, mentre cmd.push è il metodo Array.push standard che aggiunge un elemento alla fine dell'array. Una volta caricato il codice JavaScript GPT, esamina l'array ed esegue tutte le funzioni in ordine. Lo script sostituisce quindi cmd con un oggetto CommandArray di cui è stato definito il metodo push per eseguire l'argomento della funzione passato all'oggetto. Questo meccanismo consente a GPT di ridurre la latenza percepita recuperando il codice JavaScript in modo asincrono, consentendo al browser di continuare a visualizzare la pagina.

  • Esempio

    JavaScript

    googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

    JavaScript (legacy)

    googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

    TypeScript

    googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

googletag.pubadsReady

  • pubadsReady: boolean | undefined

  • Flag che indica che PubAdsService è abilitato, caricato e completamente operativo. Questa proprietà sarà semplicemente undefined fino alla chiamata di enableServices e al caricamento e all'inizializzazione di PubAdsService.

googletag.secureSignalProviders

  • secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined

  • Riferimento all'array dei fornitori di indicatori sicuri.

    L'array dei fornitori di indicatori sicuri accetta una sequenza di funzioni di generazione di indicatori e le richiama in ordine. È destinato a sostituire un array standard utilizzato per accodare le funzioni di generazione di segnali da richiamare una volta caricato GPT.

  • Esempio

    JavaScript

    window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

    JavaScript (legacy)

    window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    return Promise.resolve("signal");
  },
});

    TypeScript

    window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});
    Vedi anche

googletag.companionAds

googletag.defineOutOfPageSlot

  • defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null

  • Crea un'area annuncio fuori pagina con il percorso dell'unità pubblicitaria specificato.

    Per gli annunci fuori pagina personalizzati, div è l'ID dell'elemento div che conterrà l'annuncio. Per ulteriori dettagli, consulta l'articolo sulle creatività fuori pagina.

    Per gli annunci fuori pagina gestiti da GPT, div è un OutOfPageFormat supportato.

  • Esempio

    JavaScript

    // Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

    JavaScript (legacy)

    // Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

    TypeScript

    // Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
    Vedi anche
  • Parametri
    adUnitPath: string
    Percorso unità pubblicitaria completo con il codice di rete e il codice dell'unità pubblicitaria.
    div?: string | OutOfPageFormat
    ID del div che conterrà questa unità pubblicitaria o OutOfPageFormat.
  • Ritorni
    Slot | null
    L'area appena creata oppure null se non è possibile creare un'area annuncio.

googletag.defineSlot

  • defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null

  • Consente di creare un'area annuncio con una determinata dimensione e un percorso dell'unità pubblicitaria e di associarla all'ID di un elemento div nella pagina che conterrà l'annuncio.

  • Esempio

    JavaScript

    googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

    JavaScript (legacy)

    googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

    TypeScript

    googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
    Vedi anche
  • Parametri
    adUnitPath: string
    Percorso unità pubblicitaria completo con il codice di rete e il codice unità.
    size: GeneralSize
    Larghezza e altezza dell'area aggiunta. Si tratta della dimensione utilizzata nella richiesta di annuncio se non viene fornita alcuna mappatura delle dimensioni adattabili o se le dimensioni dell'area visibile sono inferiori alla dimensione più piccola fornita nella mappatura.
    div?: string
    ID del div che conterrà questa unità pubblicitaria.
  • Ritorni
    Slot | null
    L'area appena creata oppure null se non è possibile creare un'area annuncio.

googletag.destroySlots

  • destroySlots(slots?: Slot[]): boolean

  • Elimina gli slot specificati, rimuovendo tutti gli oggetti correlati e i riferimenti a questi slot da GPT. Questa API non supporta gli slot di pass-back e le aree companion.

    La chiamata a questa API in uno slot cancella l'annuncio e rimuove l'oggetto slot dallo stato interno gestito da GPT. La chiamata di altre funzioni sull'oggetto slot produrrà un comportamento indefinito. Tieni presente che il browser potrebbe non liberare la memoria associata a quello slot se nella pagina dell'editore viene fatto riferimento allo slot. Chiamando questa API, il div associato all'area annuncio è disponibile per il riutilizzo.

    In particolare, l'eliminazione di un'area comporta la rimozione dell'annuncio dalla visualizzazione di pagina di lunga durata di GPT, in modo che le richieste future non siano influenzate da roadblock o esclusioni competitive che coinvolgono questo annuncio. Se non si richiama questa funzione prima di rimuovere dalla pagina il div di un'area annuncio, il comportamento non sarà definito.

  • Esempio

    JavaScript

    // The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

    JavaScript (legacy)

    // The calls to construct an ad and display contents.
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

    TypeScript

    // The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();
  • Parametri
    slots?: Slot[]
    L'array di slot da eliminare. L'array è facoltativo; tutti gli slot verranno eliminati se non è specificato.
  • Ritorni
    boolean
    true se gli slot sono stati eliminati, altrimenti false.

googletag.disablePublisherConsole

googletag.display

  • display(divOrSlot: string | Element | Slot): void

  • Indica ai servizi slot di eseguire il rendering dello slot. Ogni area annuncio deve essere visualizzata una sola volta per pagina. Prima di essere visualizzate, tutti gli slot devono essere definiti e avere un servizio associato. La chiamata alla visualizzazione non deve avvenire finché l'elemento non è presente nel DOM. In genere, ciò accade in un blocco di script all'interno dell'elemento div denominato nella chiamata al metodo.

    Se si utilizza l'architettura di richiesta singola (SRA), tutte le aree annuncio non recuperate nel momento in cui viene chiamato questo metodo verranno recuperate contemporaneamente. Per impedire la visualizzazione di un'area annuncio, devi rimuovere l'intero div.

  • Esempio

    JavaScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});

    JavaScript (legacy)

    googletag.cmd.push(function () {
  googletag.display("div-1");
});

    TypeScript

    googletag.cmd.push(() => {
  googletag.display("div-1");
});
    Vedi anche
  • Parametri
    divOrSlot: string | Element | Slot
    L'ID dell'elemento div contenente l'area annuncio, l'elemento div oppure l'oggetto slot. Se viene fornito un elemento div, questo deve avere un attributo "id" corrispondente all'ID trasmesso a defineSlot.

googletag.enableServices

  • enableServices(): void

  • Attiva tutti i servizi GPT definiti per le aree annuncio nella pagina.

googletag.getVersion

  • getVersion(): string

  • Restituisce la versione corrente di GPT.

  • Vedi anche
  • Ritorni
    string
    La stringa di versione GPT attualmente in esecuzione.

googletag.openConsole

  • openConsole(div?: string): void

  • Apre Google Publisher Console.

  • Esempio

    JavaScript

    // Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

    JavaScript (legacy)

    // Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

    TypeScript

    // Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();
    Vedi anche
  • Parametri
    div?: string
    Un ID div dell'area annuncio. Questo valore è facoltativo. Se fornita, la Publisher Console tenterà di aprire con i dettagli dell'area annuncio specificata visibili.

googletag.pubads

googletag.setAdIframeTitle

  • setAdIframeTitle(title: string): void

  • Imposta il titolo per tutti gli iframe del contenitore di annunci creati da PubAdsService, da questo momento in poi.

  • Esempio

    JavaScript

    googletag.setAdIframeTitle("title");

    JavaScript (legacy)

    googletag.setAdIframeTitle("title");

    TypeScript

    googletag.setAdIframeTitle("title");
  • Parametri
    title: string
    Il nuovo titolo per tutti gli iframe dei contenitori di annunci.

googletag.setConfig

googletag.sizeMapping

googletag.CommandArray

L'array di comandi accetta una sequenza di funzioni e le richiama in ordine. È destinato a sostituire un array standard utilizzato per accodare le funzioni da richiamare una volta caricato GPT.

Riepilogo del metodo
push
Esegue la sequenza di funzioni specificate negli argomenti in ordine.

push

  • push(...f: Array<(this: typeof globalThis) => void>): number

  • Esegue la sequenza di funzioni specificate negli argomenti in ordine.

  • Esempio

    JavaScript

    googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

    JavaScript (legacy)

    googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

    TypeScript

    googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});
  • Parametri
    ...f: Array<(this: typeof globalThis) => void>
    Una funzione JavaScript da eseguire. L'associazione di runtime sarà sempre globalThis. Valuta la possibilità di passare una funzione freccia per mantenere il valore this del contesto lessicale che lo include.
  • Ritorni
    number
    Il numero di comandi elaborati finora. È compatibile con il valore restituito di Array.push (la lunghezza attuale dell'array).

googletag.CompanionAdsService

Estensioni Service

Servizio di annunci companion. Questo servizio viene utilizzato dagli annunci video per mostrare annunci companion.

Riepilogo del metodo
addEventListener
Registra un listener che consente di configurare e chiamare una funzione JavaScript quando si verifica un evento GPT specifico nella pagina.
getSlots
Recupera l'elenco degli slot associati a questo servizio.
removeEventListener
Rimuove un listener registrato in precedenza.
setRefreshUnfilledSlots
Consente di impostare se verrà eseguito automaticamente il backfill delle aree companion che non sono state riempite.
Vedi anche

setRefreshUnfilledSlots

  • setRefreshUnfilledSlots(value: boolean): void

  • Consente di stabilire se verrà eseguito automaticamente il backfill delle aree companion che non sono state riempite.

    Questo metodo può essere chiamato più volte durante il ciclo di vita della pagina per attivare e disattivare il backfill. Verrà eseguito il backfill solo delle aree annuncio registrate con PubAdsService. A causa di limitazioni previste dalle norme, questo metodo non è progettato per riempire le aree companion vuote quando viene pubblicato un video Ad Exchange.

  • Esempio

    JavaScript

    googletag.companionAds().setRefreshUnfilledSlots(true);

    JavaScript (legacy)

    googletag.companionAds().setRefreshUnfilledSlots(true);

    TypeScript

    googletag.companionAds().setRefreshUnfilledSlots(true);
  • Parametri
    value: boolean
    true per eseguire automaticamente il backfill delle aree vuote, false per lasciarle invariate.

googletag.PrivacySettingsConfig

Oggetto di configurazione per le impostazioni della privacy.

Riepilogo proprietà
childDirectedTreatment
Indica se la pagina deve essere trattata come rivolta ai minori.
limitedAds
Consente l'esecuzione della pubblicazione in modalità di annunci con limitazioni per soddisfare le esigenze di conformità alle normative del publisher.
nonPersonalizedAds
Consente l'esecuzione della pubblicazione in modalità di annunci non personalizzati per soddisfare le esigenze di conformità alle normative del publisher.
restrictDataProcessing
Consente l'esecuzione della pubblicazione in modalità di trattamento limitato per soddisfare le esigenze di conformità alle normative del publisher.
trafficSource
Indica se le richieste rappresentano traffico organico o acquistato.
underAgeOfConsent
Indica se contrassegnare le richieste di annunci come provenienti da utenti di età inferiore a quella del consenso digitale.
Vedi anche

childDirectedTreatment

  • childDirectedTreatment: null | boolean

  • Indica se la pagina deve essere trattata come rivolta ai minori. Imposta il valore null per cancellare la configurazione.

limitedAds

nonPersonalizedAds

  • nonPersonalizedAds: boolean

  • Consente l'esecuzione della pubblicazione in modalità di annunci non personalizzati per soddisfare le esigenze di conformità alle normative del publisher.

restrictDataProcessing

  • restrictDataProcessing: boolean

  • Consente l'esecuzione della pubblicazione in modalità di trattamento limitato per soddisfare le esigenze di conformità alle normative del publisher.

trafficSource

  • trafficSource: TrafficSource

  • Indica se le richieste rappresentano traffico organico o acquistato. Questo valore compila la dimensione Sorgente di traffico nei report di Ad Manager. Se non viene configurato, l'impostazione predefinita della sorgente di traffico è undefined nei report.

  • Esempio

    JavaScript

    // Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

    JavaScript (legacy)

    // Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

    TypeScript

    // Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

underAgeOfConsent

googletag.PubAdsService

Estensioni Service

il servizio di annunci per i publisher. Questo servizio viene utilizzato per recuperare e mostrare gli annunci dal tuo account Google Ad Manager.

Riepilogo del metodo
addEventListener
Registra un listener che consente di configurare e chiamare una funzione JavaScript quando si verifica un evento GPT specifico nella pagina.
clear
Rimuove gli annunci dalle aree specificate e li sostituisce con contenuti vuoti.
clearCategoryExclusions
Cancella tutte le etichette di esclusione delle categorie di annunci a livello di pagina.
clearTargeting
Cancella i parametri di targeting personalizzato per una chiave specifica o per tutte le chiavi.
collapseEmptyDivs
Consente la compressione dei div dell'area annuncio in modo che non occupino spazio sulla pagina quando non ci sono contenuti dell'annuncio da visualizzare.
disableInitialLoad
Disattiva le richieste di annunci al caricamento della pagina, ma consente di richiedere annunci con una chiamata PubAdsService.refresh.
display
Consente di creare e visualizzare un'area annuncio con il percorso e le dimensioni dell'unità pubblicitaria specificati.
enableLazyLoad
Attiva il caricamento lento in GPT come definito dall'oggetto config.
enableSingleRequest
Attiva la modalità di richiesta singola per recuperare più annunci contemporaneamente.
enableVideoAds
Indica a GPT che nella pagina saranno presenti annunci video.
get
Restituisce il valore dell'attributo AdSense associato alla chiave specificata.
getAttributeKeys
Restituisce le chiavi degli attributi che sono state impostate su questo servizio.
getSlots
Recupera l'elenco degli slot associati a questo servizio.
getTargeting
Restituisce uno specifico parametro di targeting a livello di servizio personalizzato che è stato impostato.
getTargetingKeys
Restituisce l'elenco di tutte le chiavi di targeting a livello di servizio personalizzate che sono state impostate.
isInitialLoadDisabled
Indica se le richieste iniziali di annunci sono state disattivate o meno da una chiamata PubAdsService.disableInitialLoad precedente.
refresh
Recupera e visualizza nuovi annunci per aree specifiche o per tutte le aree della pagina.
removeEventListener
Rimuove un listener registrato in precedenza.
set
Consente di impostare i valori per gli attributi di AdSense che si applicano a tutte le aree annuncio nel servizio Annunci del publisher.
setCategoryExclusion
Consente di impostare un'esclusione di categoria di annunci a livello di pagina per il nome dell'etichetta specificato.
setCentering
Attiva e disattiva la centratura orizzontale degli annunci.
setForceSafeFrame
Consente di stabilire se forzare il rendering di tutti gli annunci sulla pagina usando un contenitore SafeFrame.
setLocation
Trasferisce i dati sulla posizione dai siti web in modo da poter applicare il targeting geografico degli elementi pubblicitari a posizioni specifiche.
setPrivacySettings
Consente di configurare tutte le impostazioni della privacy da una singola API utilizzando un oggetto config.
setPublisherProvidedId
Imposta il valore per l'ID fornito dal publisher.
setSafeFrameConfig
Imposta le preferenze a livello di pagina per la configurazione di SafeFrame.
setTargeting
Imposta i parametri di targeting personalizzato per una determinata chiave che si applicano a tutte le aree annuncio del servizio Annunci dei publisher.
setVideoContent
Consente di impostare le informazioni sui contenuti video da inviare insieme alle richieste di annuncio ai fini del targeting e dell'esclusione di contenuti.
updateCorrelator
Modifica il correlatore inviato con le richieste di annunci, avviando di fatto una nuova visualizzazione di pagina.

clear

  • clear(slots?: Slot[]): boolean

  • Rimuove gli annunci dalle aree specificate e li sostituisce con contenuti vuoti. Le aree verranno contrassegnate come non recuperate.

    In particolare, la cancellazione di un'area comporta la rimozione dell'annuncio dalla visualizzazione di pagina di lunga durata di GPT, in modo che le richieste future non siano influenzate da roadblock o esclusioni competitive che coinvolgono questo annuncio.

  • Esempio

    JavaScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

    JavaScript (legacy)

    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

    TypeScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();
  • Parametri
    slots?: Slot[]
    L'array di slot da cancellare. L'array è facoltativo; tutti gli slot verranno cancellati se non è specificato.
  • Ritorni
    boolean
    Restituisce true se gli slot sono stati cancellati, in caso contrario false.

clearCategoryExclusions

  • clearCategoryExclusions(): PubAdsService

  • Cancella tutte le etichette di esclusione delle categorie di annunci a livello di pagina. Questa opzione è utile se vuoi aggiornare l'area annuncio.

  • Esempio

    JavaScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.

    JavaScript (legacy)

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.

    TypeScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.
    Vedi anche
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stato chiamato il metodo.

clearTargeting

  • clearTargeting(key?: string): PubAdsService

  • Cancella i parametri di targeting personalizzato per una chiave specifica o per tutte le chiavi.

  • Esempio

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

    JavaScript (legacy)

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.
    Vedi anche
  • Parametri
    key?: string
    Chiave del parametro di targeting. La chiave è facoltativa. Se non è specificata, tutti i parametri di targeting vengono cancellati.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stato chiamato il metodo.

collapseEmptyDivs

  • collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean

  • Consente la compressione dei div dell'area annuncio in modo che non occupino spazio sulla pagina quando non ci sono contenuti dell'annuncio da visualizzare. Questa modalità deve essere impostata prima di abilitare il servizio.

  • Vedi anche
  • Parametri
    collapseBeforeAdFetch?: boolean
    Indica se comprimere le aree anche prima del recupero degli annunci. Questo parametro è facoltativo; se non viene fornito, verrà utilizzato false come valore predefinito.
  • Ritorni
    boolean
    Restituisce true se la modalità di compressione div è stata attivata e false se non è possibile abilitarla perché il metodo è stato richiamato dopo l'attivazione del servizio.

disableInitialLoad

display

  • display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void

  • Consente di creare e visualizzare un'area annuncio con il percorso e le dimensioni dell'unità pubblicitaria specificati. Questo metodo non funziona in modalità di richiesta singola.

    Nota: quando questo metodo viene richiamato, viene creata un'istantanea dello stato dell'area e della pagina per garantire la coerenza durante l'invio della richiesta di annuncio e il rendering della risposta. Eventuali modifiche apportate allo stato dell'area o della pagina dopo la chiamata di questo metodo (inclusi targeting, impostazioni della privacy, forzatura di SafeFrame e così via) verranno applicate soltanto alle successive richieste display() o refresh().

  • Esempio

    JavaScript

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

    JavaScript (legacy)

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

    TypeScript

    googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
    Vedi anche
  • Parametri
    adUnitPath: string
    Il percorso dell'unità pubblicitaria dell'area da visualizzare.
    size: GeneralSize
    Larghezza e altezza dell'area annuncio.
    div?: string | Element
    L'ID del div contenente l'area annuncio o l'elemento div stesso.
    clickUrl?: string
    L'URL di clic da utilizzare per questa area.

enableLazyLoad

  • enableLazyLoad(config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }): void

  • Attiva il caricamento lento in GPT come definito dall'oggetto config. Per esempi più dettagliati, consulta l'esempio di caricamento lento.

    Nota: il recupero lento in SRA funziona solo se tutti gli slot non rientrano nel margine di recupero.

  • Esempio

    JavaScript

    googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});

    JavaScript (legacy)

    googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});

    TypeScript

    googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});
    Vedi anche
  • Parametri
    config?: { fetchMarginPercent: number, mobileScaling: number, renderMarginPercent: number }
    L'oggetto Configuration consente la personalizzazione del comportamento lento. Eventuali configurazioni omesse utilizzeranno un insieme predefinito da Google che verrà ottimizzato nel tempo. Per disattivare un'impostazione particolare, ad esempio un margine di recupero, imposta il valore su -1.
    • fetchMarginPercent

      La distanza minima dall'area visibile corrente che deve trovarsi prima di poter recuperare l'annuncio, espressa come percentuale delle dimensioni dell'area visibile. Il valore 0 significa "quando l'area annuncio entra nell'area visibile", 100 significa "quando l'annuncio è a 1 area visibile" e così via.
    • renderMarginPercent

      La distanza minima dall'area visibile corrente che deve trovarsi prima che venga eseguito il rendering di un annuncio. In questo modo è possibile precaricare l'annuncio, ma in attesa del rendering e del download di altre sottorisorse. Il valore funziona come fetchMarginPercent come percentuale dell'area visibile.
    • mobileScaling

      Moltiplicatore applicato ai margini sui dispositivi mobili. Ciò consente margini diversi su dispositivi mobili rispetto a computer. Ad esempio, un valore pari a 2,0 moltiplicherà tutti i margini per 2 sui dispositivi mobili, aumentando la distanza minima che può essere uno slot prima del recupero e del rendering.

enableSingleRequest

  • enableSingleRequest(): boolean

  • Attiva la modalità di richiesta singola per recuperare più annunci contemporaneamente. Ciò richiede che tutte le aree degli annunci del publisher siano definite e aggiunte a PubAdsService prima di abilitare il servizio. La modalità di richiesta singola deve essere impostata prima dell'attivazione del servizio.

  • Vedi anche
  • Ritorni
    boolean
    Restituisce true se la modalità di richiesta singola è stata attivata e false se è impossibile abilitarla perché il metodo è stato chiamato dopo l'abilitazione del servizio.

enableVideoAds

  • enableVideoAds(): void

  • Indica a GPT che nella pagina saranno presenti annunci video. Ciò consente vincoli di esclusione competitiva per gli annunci display e video. Se i contenuti del video sono noti, chiama PubAdsService.setVideoContent per poter utilizzare l'esclusione di contenuti per gli annunci display.

get

  • get(key: string): null | string

  • Restituisce il valore dell'attributo AdSense associato alla chiave specificata.

  • Esempio

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

    JavaScript (legacy)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.
    Vedi anche
  • Parametri
    key: string
    Nome dell'attributo da cercare.
  • Ritorni
    null | string
    Valore attuale per la chiave dell'attributo o null se la chiave non è presente.

getAttributeKeys

  • getAttributeKeys(): string[]

  • Restituisce le chiavi degli attributi che sono state impostate su questo servizio.

  • Esempio

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

    JavaScript (legacy)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
  • Ritorni
    string[]
    Array di chiavi di attributo impostate su questo servizio. L'ordine non è definito.

getTargeting

  • getTargeting(key: string): string[]

  • Restituisce uno specifico parametro di targeting a livello di servizio personalizzato che è stato impostato.

  • Esempio

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

    JavaScript (legacy)

    googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).
  • Parametri
    key: string
    La chiave di targeting da cercare.
  • Ritorni
    string[]
    I valori associati a questa chiave o un array vuoto se non esiste.

getTargetingKeys

  • getTargetingKeys(): string[]

  • Restituisce l'elenco di tutte le chiavi di targeting a livello di servizio personalizzate che sono state impostate.

  • Esempio

    JavaScript

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

    JavaScript (legacy)

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

    TypeScript

    googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].
  • Ritorni
    string[]
    Array di chiavi di targeting. L'ordine non è definito.

isInitialLoadDisabled

refresh

  • refresh(slots?: null | Slot[], options?: { changeCorrelator: boolean }): void

  • Recupera e visualizza nuovi annunci per aree specifiche o per tutte le aree della pagina. Funziona solo in modalità di rendering asincrono.

    Per un comportamento corretto in tutti i browser, la chiamata a refresh deve essere preceduta da una chiamata all'area annuncio display. Se la chiamata a display viene omessa, refresh potrebbe avere un comportamento imprevisto. Se vuoi, puoi utilizzare il metodo PubAdsService.disableInitialLoad per impedire a display di recuperare un annuncio.

    L'aggiornamento di un'area rimuove il vecchio annuncio dalla visualizzazione di pagina di lunga durata di GPT, in modo che le richieste future non siano influenzate da roadblock o esclusioni competitive che coinvolgono quell'annuncio.

  • Esempio

    JavaScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

    JavaScript (legacy)

    var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

    TypeScript

    const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });
    Vedi anche
  • Parametri
    slots?: null | Slot[]
    Le aree da aggiornare. L'array è facoltativo; tutti gli slot verranno aggiornati se non è specificato.
    options?: { changeCorrelator: boolean }
    Opzioni di configurazione associate a questa chiamata di aggiornamento.
    • changeCorrelator

      Specifica se è necessario generare o meno un nuovo correlatore per il recupero degli annunci. I nostri ad server mantengono questo valore correlatore per un breve momento (attualmente per 30 secondi, ma soggetti a modifiche), per cui le richieste con lo stesso correlatore ricevute da vicino verranno considerate come una singola visualizzazione di pagina. Per impostazione predefinita, viene generato un nuovo correlatore per ogni aggiornamento.

      Nota: questa opzione non influisce sulla visualizzazione di pagina di lunga durata di GPT, che riflette automaticamente gli annunci attualmente presenti sulla pagina e non ha una data di scadenza.

set

  • set(key: string, value: string): PubAdsService

  • Imposta i valori per gli attributi di AdSense che si applicano a tutte le aree annuncio nel servizio Annunci del publisher.

    Se chiami questa opzione più di una volta per la stessa chiave, i valori precedentemente impostati per quella chiave verranno sostituiti. Tutti i valori devono essere impostati prima della chiamata a display o refresh.

  • Esempio

    JavaScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");

    JavaScript (legacy)

    googletag.pubads().set("adsense_background_color", "#FFFFFF");

    TypeScript

    googletag.pubads().set("adsense_background_color", "#FFFFFF");
    Vedi anche
  • Parametri
    key: string
    Il nome dell'attributo.
    value: string
    Valore dell'attributo.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stato chiamato il metodo.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): PubAdsService

  • Consente di impostare un'esclusione di categoria di annunci a livello di pagina per il nome dell'etichetta specificato.

  • Esempio

    JavaScript

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

    JavaScript (legacy)

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

    TypeScript

    // Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
    Vedi anche
  • Parametri
    categoryExclusion: string
    L'etichetta di esclusione della categoria di annunci da aggiungere.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stato chiamato il metodo.

setCentering

  • setCentering(centerAds: boolean): void

  • Attiva e disattiva la centratura orizzontale degli annunci. La centratura è disattivata per impostazione predefinita. Nella versione precedente di gpt_mobile.js, la centratura è abilitata per impostazione predefinita.

    Questo metodo deve essere richiamato prima di chiamare display o refresh perché verranno centrati solo gli annunci richiesti dopo la chiamata a questo metodo.

  • Esempio

    JavaScript

    // Make ads centered.
googletag.pubads().setCentering(true);

    JavaScript (legacy)

    // Make ads centered.
googletag.pubads().setCentering(true);

    TypeScript

    // Make ads centered.
googletag.pubads().setCentering(true);
  • Parametri
    centerAds: boolean
    true per centrare gli annunci, false per allinearli a sinistra.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): PubAdsService

  • Consente di stabilire se forzare il rendering di tutti gli annunci sulla pagina usando un contenitore SafeFrame.

    Quando usi questa API, tieni presente quanto segue:

    • Questa impostazione avrà effetto solo per le richieste di annunci successive effettuate per le rispettive aree.
    • L'impostazione a livello di area annuncio, se specificata, sostituirà sempre l'impostazione a livello di pagina.
    • Se impostato su true (a livello di area annuncio o di pagina), l'annuncio verrà sempre visualizzato utilizzando un contenitore SafeFrame, indipendentemente dalla scelta effettuata nell'interfaccia utente di Google Ad Manager.
    • Tuttavia, se il criterio viene impostato su false o se non viene specificato, l'annuncio verrà visualizzato utilizzando un contenitore SafeFrame, a seconda del tipo di creatività e della selezione effettuata nell'interfaccia utente di Google Ad Manager.
    • Questa API deve essere utilizzata con cautela, in quanto potrebbe influire sul comportamento delle creatività che tentano di uscire dagli iframe o di fare affidamento sul rendering diretto nella pagina di un publisher.

  • Esempio

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    JavaScript (legacy)

    googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
    Vedi anche
  • Parametri
    forceSafeFrame: boolean
    true per forzare il rendering di tutti gli annunci sulla pagina in SafeFrame e false per cambiare l'impostazione precedente su false. Se imposti questo valore su false se non specificato in precedenza, non cambierà nulla.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stata chiamata la funzione.

setLocation

  • setLocation(address: string): PubAdsService

  • Trasferisce i dati sulla posizione dai siti web in modo da poter applicare il targeting geografico degli elementi pubblicitari a posizioni specifiche.

  • Esempio

    JavaScript

    // Postal code:
googletag.pubads().setLocation("10001,US");

    JavaScript (legacy)

    // Postal code:
googletag.pubads().setLocation("10001,US");

    TypeScript

    // Postal code:
googletag.pubads().setLocation("10001,US");
  • Parametri
    address: string
    Indirizzo in formato libero.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stato chiamato il metodo.

setPrivacySettings

  • setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService

  • Consente di configurare tutte le impostazioni della privacy da una singola API utilizzando un oggetto config.

  • Esempio

    JavaScript

    googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

    JavaScript (legacy)

    googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

    TypeScript

    googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});
    Vedi anche
  • Parametri
    privacySettings: PrivacySettingsConfig
    Oggetto contenente la configurazione delle impostazioni della privacy
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stata chiamata la funzione.

setPublisherProvidedId

  • setPublisherProvidedId(ppid: string): PubAdsService

  • Imposta il valore per l'ID fornito dal publisher.

  • Esempio

    JavaScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

    JavaScript (legacy)

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

    TypeScript

    googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
    Vedi anche
  • Parametri
    ppid: string
    Un ID alfanumerico fornito dal publisher. Deve avere una lunghezza compresa tra 32 e 150 caratteri.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stato chiamato il metodo.

setSafeFrameConfig

  • setSafeFrameConfig(config: SafeFrameConfig): PubAdsService

  • Imposta le preferenze a livello di pagina per la configurazione di SafeFrame. Eventuali chiavi non riconosciute nell'oggetto config verranno ignorate. Se viene passato un valore non valido per una chiave riconosciuta, l'intera configurazione verrà ignorata.

    Queste preferenze a livello di pagina saranno sostituite da quelle a livello di area annuncio, se specificate.

  • Esempio

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    JavaScript (legacy)

    googletag.pubads().setForceSafeFrame(true);

var pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
    Vedi anche
  • Parametri
    config: SafeFrameConfig
    L'oggetto di configurazione.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stato chiamato il metodo.

setTargeting

  • setTargeting(key: string, value: string | string[]): PubAdsService

  • Imposta i parametri di targeting personalizzato per una determinata chiave che si applicano a tutte le aree annuncio del servizio Annunci dei publisher. Se richiami più volte questa chiave per la stessa chiave, i valori precedenti verranno sovrascritti. Queste chiavi sono definite nel tuo account Google Ad Manager.

  • Esempio

    JavaScript

    // Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

    JavaScript (legacy)

    // Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

    TypeScript

    // Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);
    Vedi anche
  • Parametri
    key: string
    Chiave del parametro di targeting.
    value: string | string[]
    Valore del parametro di targeting o array di valori.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stato chiamato il metodo.

setVideoContent

  • setVideoContent(videoContentId: string, videoCmsId: string): void

  • Consente di impostare le informazioni sui contenuti video da inviare insieme alle richieste di annuncio ai fini del targeting e dell'esclusione di contenuti. Gli annunci video verranno attivati automaticamente quando viene richiamato questo metodo. Per videoContentId e videoCmsId, utilizza i valori forniti al servizio di importazione dei contenuti di Google Ad Manager.

  • Vedi anche
  • Parametri
    videoContentId: string
    L'ID dei contenuti video.
    videoCmsId: string
    L'ID CMS del video.

updateCorrelator

  • updateCorrelator(): PubAdsService

  • Modifica il correlatore inviato con le richieste di annunci, avviando di fatto una nuova visualizzazione di pagina. Il correlatore è uguale per tutte le richieste di annunci provenienti da un'unica visualizzazione di pagina e univoco nelle visualizzazioni di pagina. Si applica solo alla modalità asincrona.

    Nota: questa operazione non ha alcun effetto sulla visualizzazione di pagina di lunga durata di GPT, che riflette automaticamente gli annunci effettivamente presenti sulla pagina e non ha una data di scadenza.

  • Esempio

    JavaScript

    // Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

    JavaScript (legacy)

    // Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

    TypeScript

    // Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.
  • Ritorni
    PubAdsService
    L'oggetto di servizio su cui è stata chiamata la funzione.

googletag.ResponseInformation

Un oggetto che rappresenta una singola risposta di annuncio.

Riepilogo proprietà
advertiserId
L'ID dell'inserzionista.
campaignId
L'ID della campagna.
creativeId
L'ID della creatività.
creativeTemplateId
L'ID modello dell'annuncio.
lineItemId
L'ID dell'elemento pubblicitario.
Vedi anche

advertiserId

  • advertiserId: null | number

  • L'ID dell'inserzionista.

campaignId

  • campaignId: null | number

  • L'ID della campagna.

creativeId

  • creativeId: null | number

  • L'ID della creatività.

creativeTemplateId

  • creativeTemplateId: null | number

  • L'ID modello dell'annuncio.

lineItemId

  • lineItemId: null | number

  • L'ID dell'elemento pubblicitario.

googletag.RewardedPayload

Un oggetto che rappresenta il premio associato a un annuncio con premio

Riepilogo proprietà
amount
Il numero di articoli inclusi nel premio.
type
Il tipo di articolo incluso nel premio (ad es. "moneta").
Vedi anche

amount

  • amount: number

  • Il numero di articoli inclusi nel premio.

type

  • type: string

  • Il tipo di articolo incluso nel premio (ad es. "moneta").

googletag.SafeFrameConfig

Oggetto di configurazione per i container SafeFrame.

Riepilogo proprietà
allowOverlayExpansion
Se SafeFrame deve consentire l'espansione dei contenuti dell'annuncio sovrapponendo i contenuti della pagina.
allowPushExpansion
Se SafeFrame deve consentire l'espansione dei contenuti dell'annuncio tramite push dei contenuti della pagina.
sandbox
Indica se SafeFrame deve utilizzare l'attributo sandbox HTML5 per impedire la navigazione di primo livello senza l'interazione dell'utente.
useUniqueDomain
Obsoleta. Indica se SafeFrame deve utilizzare sottodomini casuali per le creatività di prenotazione.
Vedi anche

allowOverlayExpansion

  • allowOverlayExpansion: boolean

  • Se SafeFrame deve consentire l'espansione dei contenuti dell'annuncio sovrapponendo i contenuti della pagina.

allowPushExpansion

  • allowPushExpansion: boolean

  • Se SafeFrame deve consentire l'espansione dei contenuti dell'annuncio tramite push dei contenuti della pagina.

sandbox

  • sandbox: boolean

  • Indica se SafeFrame deve utilizzare l'attributo sandbox HTML5 per impedire la navigazione di primo livello senza l'interazione dell'utente. L'unico valore valido è true (non può essere forzato a false). Tieni presente che l'attributo sandbox disattiva i plug-in (ad esempio Flash).

useUniqueDomain

  • useUniqueDomain: null | boolean

  • Indica se SafeFrame deve utilizzare sottodomini casuali per le creatività di prenotazione. Passa in null per cancellare il valore memorizzato.

    Nota: questa funzionalità è attivata per impostazione predefinita.

  • Vedi anche

googletag.Service

Classe di servizio di base che contiene metodi comuni per tutti i servizi.

Riepilogo del metodo
addEventListener
Registra un listener che consente di configurare e chiamare una funzione JavaScript quando si verifica un evento GPT specifico nella pagina.
getSlots
Recupera l'elenco degli slot associati a questo servizio.
removeEventListener
Rimuove un listener registrato in precedenza.

addEventListener

  • addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (arg: EventTypeMap[K]) => void): Service

  • Registra un listener che consente di configurare e chiamare una funzione JavaScript quando si verifica un evento GPT specifico nella pagina. Sono supportati i seguenti eventi:

    Quando viene chiamato, un oggetto con il tipo di evento appropriato viene passato al listener.

  • Esempio

    JavaScript

    // 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

    JavaScript (legacy)

    // 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", function (event) {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

    TypeScript

    // 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});
    Vedi anche
  • Parametri
    eventType: K
    Una stringa che rappresenta il tipo di evento generato da GPT. I tipi di eventi sono sensibili alle maiuscole.
    listener: (arg: EventTypeMap[K]) => void
    Funzione che accetta un singolo argomento di oggetto evento.
  • Ritorni
    Service
    L'oggetto di servizio su cui è stato chiamato il metodo.

getSlots

  • getSlots(): Slot[]

  • Recupera l'elenco degli slot associati a questo servizio.

  • Ritorni
    Slot[]
    Aree nell'ordine in cui sono state aggiunte al servizio.

removeEventListener

  • removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: (event: EventTypeMap[K]) => void): void

  • Rimuove un listener registrato in precedenza.

  • Esempio

    JavaScript

    googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

    JavaScript (legacy)

    googletag.cmd.push(function () {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  var onViewableListener = function (event) {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(function () {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

    TypeScript

    googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag
    .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
    .addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});
  • Parametri
    eventType: K
    Una stringa che rappresenta il tipo di evento generato da GPT. I tipi di eventi sono sensibili alle maiuscole.
    listener: (event: EventTypeMap[K]) => void
    Funzione che accetta un singolo argomento di oggetto evento.

googletag.SizeMappingBuilder

Builder per gli oggetti con le specifiche di mappatura delle dimensioni. Questo generatore viene fornito per semplificare la creazione delle specifiche delle dimensioni.

Riepilogo del metodo
addSize
Aggiunge una mappatura da un array di una sola dimensione (che rappresenta l'area visibile) a un array di una o più dimensioni che rappresenta l'area annuncio.
build
Crea una specifica della mappa dimensioni dalle mappature aggiunte a questo builder.
Vedi anche

addSize

  • addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder

  • Aggiunge una mappatura da un array di una sola dimensione (che rappresenta l'area visibile) a un array di una o più dimensioni che rappresenta l'area annuncio.

  • Esempio

    JavaScript

    // Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

    JavaScript (legacy)

    // Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

    TypeScript

    // Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports < 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]
  • Parametri
    viewportSize: SingleSizeArray
    Le dimensioni dell'area visibile per questa voce di mappatura.
    slotSize: GeneralSize
    Le dimensioni dell'area per questa voce di mappatura.
  • Ritorni
    SizeMappingBuilder
    Un riferimento a questo builder.

build

  • build(): null | SizeMappingArray

  • Crea una specifica della mappa dimensioni dalle mappature aggiunte a questo builder.

    Se sono state fornite mappature non valide, questo metodo restituirà null. In caso contrario, restituisce una specifica nel formato corretto da passare a Slot.defineSizeMapping.

    Nota: il comportamento dello strumento di creazione dopo la chiamata di questo metodo non è definito.

  • Ritorni
    null | SizeMappingArray
    Il risultato creato da questo builder. Può essere nullo se sono state fornite mappature delle dimensioni non valide.

googletag.Slot

Un'area annuncio è un oggetto che rappresenta una singola area annuncio su una pagina.

Riepilogo del metodo
addService
Aggiunge un elemento Service a questo spazio.
clearCategoryExclusions
Cancella tutte le etichette di esclusione di categoria di annunci a livello di area per quest'area.
clearTargeting
Cancella i parametri di targeting a livello di area annuncio specifici o personalizzati per questa area annuncio.
defineSizeMapping
Consente di impostare un array di mappature da una dimensione minima dell'area visibile alla dimensione dell'area annuncio per questa area.
get
Restituisce il valore dell'attributo AdSense associato alla chiave specificata per questa area annuncio.
getAdUnitPath
Restituisce il percorso completo dell'unità pubblicitaria, con il codice di rete e il percorso dell'unità pubblicitaria.
getAttributeKeys
Restituisce l'elenco di chiavi di attributo impostate per questo slot.
getCategoryExclusions
Restituisce le etichette di esclusione della categoria di annunci per questa area.
getResponseInformation
Restituisce le informazioni della risposta all'annuncio.
getSlotElementId
Restituisce l'ID dell'area div fornito al momento della definizione dell'area.
getTargeting
Restituisce uno specifico parametro di targeting personalizzato impostato per questa area.
getTargetingKeys
Restituisce l'elenco di tutte le chiavi di targeting personalizzate impostate in questa area.
set
Imposta un valore per un attributo AdSense in questa area annuncio.
setCategoryExclusion
Consente di impostare un'etichetta di esclusione della categoria di annunci a livello di area su questa area.
setClickUrl
Imposta l'URL di clic a cui gli utenti vengono reindirizzati dopo aver fatto clic sull'annuncio.
setCollapseEmptyDiv
Consente di impostare se l'area div deve essere nascosta quando non ci sono annunci nell'area.
setConfig
Consente di impostare le opzioni di configurazione generali per questo slot.
setForceSafeFrame
Consente di stabilire se eseguire o meno il rendering degli annunci in quest'area usando un contenitore SafeFrame.
setSafeFrameConfig
Consente di impostare le preferenze a livello di area per la configurazione di SafeFrame.
setTargeting
Imposta un parametro di targeting personalizzato per questa area.
updateTargetingFromMap
Imposta i parametri di targeting personalizzato per questa area da una mappa chiave-valore in un oggetto JSON.

addService

  • addService(service: Service): Slot

  • Aggiunge un elemento Service a questo spazio.

  • Esempio

    JavaScript

    googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

    JavaScript (legacy)

    googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

    TypeScript

    googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
    Vedi anche
  • Parametri
    service: Service
    Il servizio da aggiungere.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

clearCategoryExclusions

  • clearCategoryExclusions(): Slot

  • Cancella tutte le etichette di esclusione di categoria di annunci a livello di area per quest'area.

  • Esempio

    JavaScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.

    JavaScript (legacy)

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.

    TypeScript

    // Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

clearTargeting

  • clearTargeting(key?: string): Slot

  • Cancella i parametri di targeting a livello di area annuncio specifici o personalizzati per questa area annuncio.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.
    Vedi anche
  • Parametri
    key?: string
    Chiave del parametro di targeting. La chiave è facoltativa. Se non è specificata, tutti i parametri di targeting vengono cancellati.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

defineSizeMapping

  • defineSizeMapping(sizeMapping: SizeMappingArray): Slot

  • Consente di impostare un array di mappature da una dimensione minima dell'area visibile alla dimensione dell'area annuncio per questa area.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ]
  )
  .build();

slot.defineSizeMapping(mapping);

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

var mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ]
  )
  .build();

slot.defineSizeMapping(mapping);

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ]
  )
  .build();

slot.defineSizeMapping(mapping!);
    Vedi anche
  • Parametri
    sizeMapping: SizeMappingArray
    Array di mappature delle dimensioni. Puoi usare SizeMappingBuilder per crearla. Ogni mappatura delle dimensioni è un array di due elementi: SingleSizeArray e GeneralSize.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

get

  • get(key: string): null | string

  • Restituisce il valore dell'attributo AdSense associato alla chiave specificata per questa area annuncio. Per visualizzare gli attributi del livello di servizio ereditati da questo slot, utilizza PubAdsService.get.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.
    Vedi anche
  • Parametri
    key: string
    Nome dell'attributo da cercare.
  • Ritorni
    null | string
    Valore attuale per la chiave dell'attributo o null se la chiave non è presente.

getAdUnitPath

  • getAdUnitPath(): string

  • Restituisce il percorso completo dell'unità pubblicitaria, con il codice di rete e il percorso dell'unità pubblicitaria.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.
  • Ritorni
    string
    Percorso unità pubblicitaria.

getAttributeKeys

  • getAttributeKeys(): string[]

  • Restituisce l'elenco di chiavi di attributo impostate per questo slot. Per visualizzare le chiavi degli attributi a livello di servizio ereditate da questo slot, utilizza PubAdsService.getAttributeKeys.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
  • Ritorni
    string[]
    Array di chiavi di attributi. L'ordine non è definito.

getCategoryExclusions

  • getCategoryExclusions(): string[]

  • Restituisce le etichette di esclusione della categoria di annunci per questa area.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].
  • Ritorni
    string[]
    Le etichette di esclusione della categoria di annunci per questa area o un array vuoto se non ne è stata impostata nessuna.

getResponseInformation

  • getResponseInformation(): null | ResponseInformation

  • Restituisce le informazioni della risposta all'annuncio. Si basa sull'ultima risposta di annuncio per l'area. Se viene chiamato quando l'area non contiene annunci, verrà restituito null.

  • Ritorni
    null | ResponseInformation
    Le informazioni più recenti sulla risposta all'annuncio oppure null se l'area non contiene annunci.

getSlotElementId

  • getSlotElementId(): string

  • Restituisce l'ID dell'area div fornito al momento della definizione dell'area.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div-1'.

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div-1'.

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div-1'.
  • Ritorni
    string
    ID area annuncio div.

getTargeting

  • getTargeting(key: string): string[]

  • Restituisce uno specifico parametro di targeting personalizzato impostato per questa area. I parametri di targeting a livello di servizio non sono inclusi.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).
  • Parametri
    key: string
    La chiave di targeting da cercare.
  • Ritorni
    string[]
    I valori associati a questa chiave o un array vuoto se non esiste.

getTargetingKeys

  • getTargetingKeys(): string[]

  • Restituisce l'elenco di tutte le chiavi di targeting personalizzate impostate in questa area. Le chiavi di targeting a livello di servizio non sono incluse.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].
  • Ritorni
    string[]
    Array di chiavi di targeting. L'ordine non è definito.

set

  • set(key: string, value: string): Slot

  • Imposta un valore per un attributo AdSense in questa area annuncio. Verranno sostituiti tutti i valori impostati a livello di servizio per questa chiave.

    Se chiami questo metodo più di una volta per la stessa chiave, i valori precedentemente impostati per quella chiave verranno sostituiti. Tutti i valori devono essere impostati prima della chiamata a display o refresh.

  • Esempio

    JavaScript

    // Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

    JavaScript (legacy)

    // Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

    TypeScript

    // Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());
    Vedi anche
  • Parametri
    key: string
    Il nome dell'attributo.
    value: string
    Valore dell'attributo.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

setCategoryExclusion

  • setCategoryExclusion(categoryExclusion: string): Slot

  • Consente di impostare un'etichetta di esclusione della categoria di annunci a livello di area su questa area.

  • Esempio

    JavaScript

    // Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

    JavaScript (legacy)

    // Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

    TypeScript

    // Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());
    Vedi anche
  • Parametri
    categoryExclusion: string
    L'etichetta di esclusione della categoria di annunci da aggiungere.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

setClickUrl

  • setClickUrl(value: string): Slot

  • Imposta l'URL di clic a cui gli utenti verranno reindirizzati dopo aver fatto clic sull'annuncio.

    I server di Google Ad Manager registrano comunque un clic anche se l'URL di clic viene sostituito. Qualsiasi URL pagina di destinazione associato alla creatività pubblicata viene aggiunto al valore fornito. Le chiamate successive sovrascriveranno il valore. Questa opzione funziona solo per le richieste non SRA.

  • Esempio

    JavaScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());

    JavaScript (legacy)

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());

    TypeScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());
  • Parametri
    value: string
    L'URL di clic da impostare.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

setCollapseEmptyDiv

  • setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot

  • Consente di impostare se l'area div deve essere nascosta quando non ci sono annunci nell'area. Questa operazione sostituisce le impostazioni a livello di servizio.

  • Esempio

    JavaScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

    JavaScript (legacy)

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

    TypeScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.
    Vedi anche
  • Parametri
    collapse: boolean
    Indica se comprimere l'area se non viene restituito alcun annuncio.
    collapseBeforeAdFetch?: boolean
    Indica se comprimere l'area anche prima che l'annuncio venga recuperato. Ignorato se la compressione non è true.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

setConfig

  • setConfig(slotConfig: SlotSettingsConfig): void

  • Consente di impostare le opzioni di configurazione generali per questo slot.

  • Parametri
    slotConfig: SlotSettingsConfig
    L'oggetto di configurazione.

setForceSafeFrame

  • setForceSafeFrame(forceSafeFrame: boolean): Slot

  • Consente di stabilire se eseguire o meno il rendering degli annunci in quest'area usando un contenitore SafeFrame.

    Quando usi questa API, tieni presente quanto segue:

    • Questa impostazione avrà effetto solo per le richieste di annunci successive effettuate per le rispettive aree.
    • L'impostazione a livello di area annuncio, se specificata, sostituirà sempre l'impostazione a livello di pagina.
    • Se impostato su true (a livello di area annuncio o di pagina), l'annuncio verrà sempre visualizzato utilizzando un contenitore SafeFrame, indipendentemente dalla scelta effettuata nell'interfaccia utente di Google Ad Manager.
    • Tuttavia, se il criterio viene impostato su false o se non viene specificato, l'annuncio verrà visualizzato utilizzando un contenitore SafeFrame, a seconda del tipo di creatività e della selezione effettuata nell'interfaccia utente di Google Ad Manager.
    • Questa API deve essere utilizzata con cautela, in quanto potrebbe influire sul comportamento delle creatività che tentano di uscire dagli iframe o di fare affidamento sul rendering diretto nella pagina di un publisher.

  • Esempio

    JavaScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

    JavaScript (legacy)

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

    TypeScript

    googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());
    Vedi anche
  • Parametri
    forceSafeFrame: boolean
    true per forzare la visualizzazione di tutti gli annunci in quest'area in SafeFrame e false per disattivare un'impostazione a livello di pagina (se presente). Se questa opzione è impostata su false se non specificata a livello di pagina, non viene apportata alcuna modifica.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

setSafeFrameConfig

  • setSafeFrameConfig(config: null | SafeFrameConfig): Slot

  • Consente di impostare le preferenze a livello di area per la configurazione di SafeFrame. Eventuali chiavi non riconosciute nell'oggetto config verranno ignorate. Se viene passato un valore non valido per una chiave riconosciuta, l'intera configurazione verrà ignorata.

    Queste preferenze a livello di area annuncio, se specificate, sostituiranno tutte le preferenze a livello di pagina.

  • Esempio

    JavaScript

    googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    JavaScript (legacy)

    googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

    TypeScript

    googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
    Vedi anche
  • Parametri
    config: null | SafeFrameConfig
    L'oggetto di configurazione.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

setTargeting

  • setTargeting(key: string, value: string | string[]): Slot

  • Imposta un parametro di targeting personalizzato per questa area. Se questo metodo viene chiamato più volte per la stessa chiave, i valori precedenti verranno sovrascritti. I valori impostati qui sovrascriveranno i parametri di targeting impostati a livello di servizio. Queste chiavi sono definite nel tuo account Google Ad Manager.

  • Esempio

    JavaScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);

    JavaScript (legacy)

    var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);

    TypeScript

    const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);
    Vedi anche
  • Parametri
    key: string
    Chiave del parametro di targeting.
    value: string | string[]
    Valore del parametro di targeting o array di valori.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

updateTargetingFromMap

  • updateTargetingFromMap(map: {  [adUnitPath: string]: string | string[] }): Slot

  • Imposta i parametri di targeting personalizzato per questa area da una mappa chiave-valore in un oggetto JSON. Equivale a chiamare Slot.setTargeting per tutte le coppie chiave-valore dell'oggetto. Queste chiavi sono definite nel tuo account Google Ad Manager.

    Note:

    • In caso di sovrascrittura, verrà mantenuto solo l'ultimo valore.
    • Se il valore è un array, qualsiasi valore precedente verrà sovrascritto, non unito.
    • I valori impostati qui sovrascriveranno i parametri di targeting impostati a livello di servizio.

  • Esempio

    JavaScript

    const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

    JavaScript (legacy)

    var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

    TypeScript

    const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});
  • Parametri
    map: {  [adUnitPath: string]: string | string[] }
    Mappa chiave:valore dei parametri di targeting.
  • Ritorni
    Slot
    L'oggetto slot su cui è stato chiamato il metodo.

googletag,config.AdExpansionConfig

Impostazioni per controllare l'espansione dell'annuncio.

Riepilogo proprietà
enabled
Indica se l'espansione dell'annuncio è attivata o disattivata.
Esempio

JavaScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

JavaScript (legacy)

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

enabled

googletag,config.ComponentAuctionConfig

Un oggetto che rappresenta l'asta di un singolo componente in un'asta dell'annuncio on-device.

Riepilogo proprietà
auctionConfig
Un oggetto di configurazione dell'asta per questo componente.
configKey
La chiave di configurazione associata all'asta di questo componente.
Vedi anche

auctionConfig

  • auctionConfig: null | { auctionSignals: unknown, decisionLogicUrl: string, interestGroupBuyers: string[], perBuyerExperimentGroupIds: {  [buyer: string]: number }, perBuyerGroupLimits: {  [buyer: string]: number }, perBuyerSignals: {  [buyer: string]: unknown }, perBuyerTimeouts: {  [buyer: string]: number }, seller: string, sellerExperimentGroupId: number, sellerSignals: unknown, sellerTimeout: number, trustedScoringSignalsUrl: string }

  • Un oggetto di configurazione dell'asta per questa asta del componente.

    Se questo valore è impostato su null, verrà eliminata l'eventuale configurazione esistente per il configKey specificato.

  • Esempio

    JavaScript

    const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

    JavaScript (legacy)

    var componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

    TypeScript

    const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicUrl's origin
  seller: "https://testSeller.com",
  decisionLogicUrl: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});
    Vedi anche

configKey

  • configKey: string

  • La chiave di configurazione associata a questa asta del componente.

    Questo valore non deve essere vuoto e deve essere univoco. Se due oggetti ComponentAuctionConfig condividono lo stesso valore configKey, l'ultimo da impostare sovrascriverà le configurazioni precedenti.

googletag,config.InterstitialConfig

Un oggetto che definisce il comportamento di una singola area annuncio interstitial.

Riepilogo proprietà
triggers
La configurazione dell'attivatore interstitial per questo annuncio interstitial.

triggers

  • triggers: Partial<Record<InterstitialTrigger, boolean>>

  • La configurazione dell'attivatore interstitial per questo annuncio interstitial.

    Se imposti il valore di un attivatore interstitial su true, verrà attivato e false lo disattiverà. Verranno sostituiti i valori predefiniti configurati in Google Ad Manager.

  • Esempio

    JavaScript

    // Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

    JavaScript (legacy)

    // Define a GPT managed web interstitial ad slot.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
var enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

    TypeScript

    // Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL
)!;

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});
    Vedi anche

googletag,config.PageSettingsConfig

Interfaccia di configurazione principale per le impostazioni a livello di pagina.

Consente di impostare più funzionalità con una singola chiamata API.

Tutte le proprietà elencate di seguito sono esempi e non riflettono le funzionalità effettive che utilizzano setConfig. Per l'insieme delle funzionalità, vedi i campi relativi al tipo PageSettingsConfig di seguito.

Esempi:

  • Vengono modificate solo le funzionalità specificate nella chiamata a setConfig. 
      // Configure feature alpha.
  googletag.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  googletag.setConfig({
     bravo: {...}
  });
  • Tutte le impostazioni di una determinata funzionalità vengono aggiornate con ogni chiamata al numero setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  googletag.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  googletag.setConfig({
      charlie: {
          echo: 2
      }
  });
  • Tutte le impostazioni di una funzionalità possono essere cancellate passando null. 
      // Configure features delta, golf, and hotel.
  googletag.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  googletag.setConfig({
      delta: null,
      hotel: null,
  });

Riepilogo proprietà
adExpansion
Impostazioni per controllare l'espansione dell'annuncio.
pps
Impostazioni per controllare gli indicatori forniti dal publisher (PPS).
privacyTreatments
Impostazioni per controllare le opzioni di trattamento della privacy dei publisher.

adExpansion

  • adExpansion: null | AdExpansionConfig

  • Impostazioni per controllare l'espansione dell'annuncio.

pps

privacyTreatments

  • privacyTreatments: null | PrivacyTreatmentsConfig

  • Impostazioni per controllare le opzioni di trattamento della privacy dei publisher.

googletag,config.PrivacyTreatmentsConfig

Impostazioni per controllare le opzioni di trattamento della privacy dei publisher.

Riepilogo proprietà
treatments
Una serie di opzioni di trattamento della privacy per i publisher da attivare.

treatments

  • treatments: "disablePersonalization"[]

  • Una serie di opzioni di trattamento della privacy per i publisher da attivare.

  • Esempio

    JavaScript

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

    JavaScript (legacy)

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

    TypeScript

    // Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

googletag,config.PublisherProvidedSignalsConfig

Oggetto di configurazione degli indicatori forniti dal publisher (PPS).

Riepilogo proprietà
taxonomies
Un oggetto che contiene mappature della Tassonomia.
Esempio

JavaScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

JavaScript (legacy)

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 18-20'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
Vedi anche

taxonomies

googletag,config.SlotSettingsConfig

Interfaccia di configurazione principale per le impostazioni a livello di slot.

Consente di impostare più funzionalità con una singola chiamata API per un singolo slot.

Tutte le proprietà elencate di seguito sono degli esempi e non riflettono le funzionalità effettive che utilizzano setConfig. Per l'insieme delle funzionalità, vedi i campi relativi al tipo SlotSettingsConfig di seguito.

Esempi:

  • Vengono modificate solo le funzionalità specificate nella chiamata a Slot.setConfig. 
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);

  // Configure feature alpha.
  slot.setConfig({
      alpha: {...}
  });

  // Configure feature bravo. Feature alpha is unchanged.
  slot.setConfig({
     bravo: {...}
  });
  • Tutte le impostazioni di una determinata funzionalità vengono aggiornate con ogni chiamata al numero Slot.setConfig. 
      // Configure feature charlie to echo = 1, foxtrot = true.
  slot.setConfig({
      charlie: {
          echo: 1,
          foxtrot: true,
      }
  });

  // Update feature charlie to echo = 2. Since foxtrot was not specified,
  // the value is cleared.
  slot.setConfig({
      charlie: {
          echo: 2
      }
  });
  • Tutte le impostazioni di una funzionalità possono essere cancellate passando null. 
      // Configure features delta, golf, and hotel.
  slot.setConfig({
      delta: {...},
      golf: {...},
      hotel: {...},
  });

  // Feature delta and hotel are cleared, but feature golf remains set.
  slot.setConfig({
      delta: null,
      hotel: null,
  });

Riepilogo proprietà
adExpansion
Impostazioni per controllare l'espansione dell'annuncio.
componentAuction
Un array di aste dei componenti da includere in un'asta dell'annuncio on-device.
interstitial
Impostazioni che controllano il comportamento dell'area annuncio interstitial.

adExpansion

  • adExpansion: AdExpansionConfig

  • Impostazioni per controllare l'espansione dell'annuncio.

componentAuction

  • componentAuction: ComponentAuctionConfig[]

  • Un array di aste dei componenti da includere in un'asta dell'annuncio on-device.

interstitial

  • interstitial: InterstitialConfig

  • Impostazioni che controllano il comportamento dell'area annuncio interstitial.

googletag,config.TaxonomyData

Un oggetto che contiene i valori di una singola Tassonomia.

Riepilogo proprietà
values
Un elenco di valori della Tassonomia.

values

  • values: string[]

  • Un elenco di valori della Tassonomia.

googletag,events.Event

Interfaccia di base per tutti gli eventi GPT. Tutti gli eventi GPT riportati di seguito avranno i campi seguenti.

Riepilogo proprietà
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Vedi anche

serviceName

  • serviceName: string

  • Nome del servizio che ha attivato l'evento.

slot

  • slot: Slot

  • Lo spazio che ha attivato l'evento.

googletag,events.EventTypeMap

Si tratta di uno pseudo-tipo che mappa il nome di un evento al tipo di oggetto evento corrispondente per Service.addEventListener e Service.removeEventListener. È documentato solo a scopo di sicurezza di riferimento e tipo.

Riepilogo proprietà
impressionViewable
rewardedSlotClosed
rewardedSlotGranted
rewardedSlotReady
slotOnload
slotRenderEnded
slotRequested
slotResponseReceived
slotVisibilityChanged

impressionViewable

rewardedSlotClosed

rewardedSlotGranted

rewardedSlotReady

slotOnload

slotRenderEnded

slotRequested

slotResponseReceived

slotVisibilityChanged

googletag,events.ImpressionViewableEvent

Estensioni Event

Questo evento viene attivato quando un'impressione diventa visibile, in base ai criteri di Visualizzazione attiva.

Riepilogo proprietà
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Esempio

JavaScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called when an impression becomes viewable.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", function (event) {
  var slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

googletag,events.RewardedSlotClosedEvent

Estensioni Event

Questo evento viene attivato quando un'area annuncio con premio viene chiusa dall'utente. Può attivarsi prima o dopo l'assegnazione di un premio. Per determinare se è stato concesso un premio, utilizza invece events.RewardedSlotGrantedEvent.

Riepilogo proprietà
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Esempio

JavaScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called when the user closes a rewarded ad slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when the user closes a rewarded ad slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

googletag,events.RewardedSlotGrantedEvent

Estensioni Event

Questo evento viene attivato quando viene concesso un premio per la visualizzazione di un annuncio con premio. Se l'annuncio viene chiuso prima che vengano soddisfatti i criteri per l'assegnazione di un premio, questo evento non verrà attivato.

Riepilogo proprietà
payload
Un oggetto contenente informazioni sul premio che è stato concesso.
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Esempio

JavaScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called whenever a reward is granted for a
// rewarded ad.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
  var _a, _b;
  var slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
  console.log(
    "Reward amount:",
    (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount
  );
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called whenever a reward is granted for a
// rewarded ad.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
  const slot = event.slot;
  console.group("Reward granted for slot", slot.getSlotElementId(), ".");

  // Log details of the reward.
  console.log("Reward type:", event.payload?.type);
  console.log("Reward amount:", event.payload?.amount);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

payload

  • payload: null | RewardedPayload

  • Un oggetto contenente informazioni sul premio che è stato concesso.

googletag,events.RewardedSlotReadyEvent

Estensioni Event

Questo evento viene attivato quando un annuncio con premio è pronto per essere visualizzato. Il publisher ha la responsabilità di presentare all'utente un'opzione per visualizzare l'annuncio prima di farlo.

Riepilogo proprietà
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Riepilogo del metodo
makeRewardedVisible
Mostra l'annuncio con premio.
Esempio

JavaScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  const userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
  var slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  var userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
  const slot = event.slot;
  console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

  // Replace with custom logic.
  const userHasConsented = true;
  if (userHasConsented) {
    event.makeRewardedVisible();
  }

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

makeRewardedVisible

  • makeRewardedVisible(): void

  • Mostra l'annuncio con premio. Questo metodo non deve essere chiamato finché l'utente non ha acconsentito a visualizzare l'annuncio.

googletag,events.SlotOnloadEvent

Estensioni Event

Questo evento viene attivato quando l'iframe della creatività attiva il suo evento di caricamento. Quando esegui il rendering degli annunci rich media in modalità di rendering sincrono, non viene utilizzato alcun iframe e, di conseguenza, non verrà attivato alcun SlotOnloadEvent.

Riepilogo proprietà
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Esempio

JavaScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called when a creative iframe load event fires.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  var slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

googletag,events.SlotRenderEndedEvent

Estensioni Event

Questo evento viene attivato quando il codice creatività viene inserito in un'area annuncio. Questo evento si verifica prima del recupero delle risorse della creatività, pertanto la creatività potrebbe non essere ancora visibile. Se devi sapere quando è terminato il caricamento di tutte le risorse della creatività di un'area, prendi in considerazione events.SlotOnloadEvent.

Riepilogo proprietà
advertiserId
ID inserzionista dell'annuncio visualizzato.
campaignId
ID campagna dell'annuncio pubblicato.
companyIds
ID delle aziende che fanno offerte per l'annuncio backfill visualizzato.
creativeId
ID creatività dell'annuncio basato su prenotazione visualizzato.
creativeTemplateId
ID modello di creatività dell'annuncio basato su prenotazione visualizzato.
isBackfill
Se un annuncio era un annuncio backfill.
isEmpty
Indica se è stato restituito un annuncio per l'area.
labelIds
ID etichetta dell'annuncio visualizzato.
lineItemId
ID dell'elemento pubblicitario dell'annuncio basato su prenotazione visualizzato.
serviceName
Nome del servizio che ha attivato l'evento.
size
Indica le dimensioni in pixel della creatività visualizzata.
slot
Lo spazio che ha attivato l'evento.
slotContentChanged
Indica se i contenuti dell'area sono stati modificati con l'annuncio visualizzato.
sourceAgnosticCreativeId
ID creatività dell'annuncio di prenotazione o backfill visualizzato.
sourceAgnosticLineItemId
ID dell'elemento pubblicitario dell'annuncio di prenotazione o backfill visualizzato.
yieldGroupIds
ID dei gruppi di rendimento per l'annuncio backfill sottoposto a rendering.
Esempio

JavaScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called when a slot has finished rendering.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", function (event) {
  var slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Label IDs:", event.labelIds);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

advertiserId

  • advertiserId: null | number

  • ID inserzionista dell'annuncio visualizzato. Il valore è null per aree vuote, annunci backfill e creatività visualizzate da servizi diversi da PubAdsService.

campaignId

  • campaignId: null | number

  • ID campagna dell'annuncio pubblicato. Il valore è null per aree vuote, annunci backfill e creatività visualizzate da servizi diversi da PubAdsService.

companyIds

  • companyIds: null | number[]

  • ID delle aziende che fanno offerte per l'annuncio backfill visualizzato. Il valore è null per aree vuote, annunci basati su prenotazione e creatività visualizzate da servizi diversi da PubAdsService.

creativeId

  • creativeId: null | number

  • ID creatività dell'annuncio basato su prenotazione visualizzato. Il valore è null per aree vuote, annunci backfill e creatività visualizzate da servizi diversi da PubAdsService.

creativeTemplateId

  • creativeTemplateId: null | number

  • ID modello di creatività dell'annuncio basato su prenotazione visualizzato. Il valore è null per aree vuote, annunci backfill e creatività visualizzate da servizi diversi da PubAdsService.

isBackfill

  • isBackfill: boolean

  • Se un annuncio era un annuncio backfill. Il valore è true se l'annuncio era un annuncio backfill, altrimenti false.

isEmpty

  • isEmpty: boolean

  • Indica se è stato restituito un annuncio per l'area. Il valore è true se non è stato restituito alcun annuncio, altrimenti false.

labelIds

  • labelIds: null | number[]

  • ID etichetta dell'annuncio visualizzato. Il valore è null per aree vuote, annunci backfill e creatività visualizzate da servizi diversi da PubAdsService.

lineItemId

  • lineItemId: null | number

  • ID dell'elemento pubblicitario dell'annuncio basato su prenotazione visualizzato. Il valore è null per aree vuote, annunci backfill e creatività visualizzate da servizi diversi da PubAdsService.

size

  • size: null | string | number[]

  • Indica le dimensioni in pixel della creatività visualizzata. Esempio: [728, 90]. Il valore per le aree annuncio vuote è null.

slotContentChanged

  • slotContentChanged: boolean

  • Indica se i contenuti dell'area sono stati modificati con l'annuncio visualizzato. Il valore è true se i contenuti sono stati modificati, altrimenti false.

sourceAgnosticCreativeId

  • sourceAgnosticCreativeId: null | number

  • ID creatività dell'annuncio di prenotazione o backfill visualizzato. Il valore è null se l'annuncio non è un backfill di elementi pubblicitari o di prenotazione oppure se la creatività viene visualizzata da servizi diversi da PubAdsService.

sourceAgnosticLineItemId

  • sourceAgnosticLineItemId: null | number

  • ID dell'elemento pubblicitario dell'annuncio di prenotazione o backfill visualizzato. Il valore è null se l'annuncio non è un backfill di elementi pubblicitari o di prenotazione oppure se la creatività viene visualizzata da servizi diversi da PubAdsService.

yieldGroupIds

  • yieldGroupIds: null | number[]

  • ID dei gruppi di rendimento per l'annuncio backfill sottoposto a rendering. Il valore è null per aree vuote, annunci basati su prenotazione e creatività visualizzate da servizi diversi da PubAdsService.

googletag,events.SlotRequestedEvent

Estensioni Event

Questo evento viene attivato quando è stato richiesto un annuncio per un'area specifica.

Riepilogo proprietà
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Esempio

JavaScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", function (event) {
  var slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

googletag,events.SlotResponseReceived

Estensioni Event

Questo evento viene attivato quando viene ricevuta una risposta di annuncio per un'area specifica.

Riepilogo proprietà
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Esempio

JavaScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called when an ad response has been received
// for a slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", function (event) {
  var slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

googletag,events.SlotVisibilityChangedEvent

Estensioni Event

Questo evento viene attivato ogni volta che la percentuale sullo schermo dell'area di un'area annuncio cambia. L'evento è limitato e non si attiva più di una volta ogni 200 ms.

Riepilogo proprietà
inViewPercentage
La percentuale dell'area dell'annuncio visibile.
serviceName
Nome del servizio che ha attivato l'evento.
slot
Lo spazio che ha attivato l'evento.
Esempio

JavaScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (legacy)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
Vedi anche

inViewPercentage

  • inViewPercentage: number

  • La percentuale dell'area dell'annuncio visibile. Il valore è un numero compreso tra 0 e 100.

googletag,secureSignals.BidderSignalProvider

Restituisce un indicatore sicuro per uno specifico offerente.

Un fornitore di indicatori sicuri dell'offerente è composto da due parti:

  1. Una funzione collector, che restituisce un Promise che si risolve in un indicatore sicuro.
  2. Un id che identifica l'offerente associato all'indicatore.
Per restituire un indicatore sicuro per un publisher, usa invece secureSignals.PublisherSignalProvider.

Riepilogo proprietà
collectorFunction
.
id
Un identificatore univoco del raccoglitore associato a questo indicatore sicuro, come registrato in Google Ad Manager.
Esempio

JavaScript

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (legacy)

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
Vedi anche

collectorFunction

  • collectorFunction: () => Promise<string>

id

  • id: string

  • Un identificatore univoco del raccoglitore associato a questo indicatore sicuro, come registrato in Google Ad Manager.

googletag,secureSignals.PublisherSignalProvider

Restituisce un indicatore sicuro per un publisher specifico.

Un fornitore di indicatori del publisher è composto da due parti:

  1. Una funzione collector, che restituisce un Promise che si risolve in un indicatore sicuro.
  2. Un networkCode che identifica il publisher associato all'indicatore.
Per restituire un indicatore sicuro per un offerente, utilizza invece secureSignals.BidderSignalProvider.

Riepilogo proprietà
collectorFunction
.
networkCode
Il codice di rete (indicato nel percorso dell'unità pubblicitaria) per il publisher associato a questo indicatore sicuro.
Esempio

JavaScript

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (legacy)

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// networkCode is provided
googletag.secureSignalProviders!.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
Vedi anche

collectorFunction

  • collectorFunction: () => Promise<string>

networkCode

  • networkCode: string

  • Il codice di rete (indicato nel percorso dell'unità pubblicitaria) per il publisher associato a questo indicatore sicuro.

googletag,secureSignals.SecureSignalProvidersArray

Un'interfaccia per la gestione degli indicatori sicuri.

Riepilogo del metodo
clearAllCache
Cancella tutti gli indicatori memorizzati nella cache dallo spazio di archiviazione locale.
push
Aggiunge un nuovo secureSignals.SecureSignalProvider all'array del fornitore di indicatori e avvia il processo di generazione degli indicatori.

clearAllCache

  • clearAllCache(): void

  • Cancella tutti gli indicatori memorizzati nella cache dallo spazio di archiviazione locale.

push