Evitare errori comuni di implementazione

I seguenti scenari rappresentano alcuni degli errori più comuni osservati quando implementando GPT. Sebbene queste implementazioni possano funzionare correttamente con la versione corrente di GPT, non è garantito che continueranno a farlo anche in futuro. Nei casi più estremi, queste implementazioni potrebbero causare interruzioni della pubblicazione degli annunci in modi imprevedibili. Sono considerate implementazioni non supportate.

Ogni scenario include un approccio suggerito per la risoluzione del problema mostrato.

Tieni presente che questo elenco non rappresenta un elenco completamente esaustivo di potenziali problemi. ma che serva da guida utile per identificare i tipi di problemi che potrebbero richiedere essere gestiti.

Inoltre, a seconda dell'implementazione, potresti dover cercare tutti i punti in cui queste modifiche potrebbero essere necessarie all'interno del tuo sito.

Errori comuni

Scenario 1: utilizzo di copie non ufficiali delle librerie JavaScript GPT

Descrizione del caso d'uso generale Ospitare gpt.js, pubads_impl.js o eventuali librerie che caricano dai tuoi server o caricare questi file da una fonte non ufficiale.
Esempio di snippet di codice con errore 
// Incorrect: Accessing these files from an unofficial source
<script async src="https://www.example.com/tag/js/gpt.js"></script>
Metodi suggeriti per correggere l'errore 
// Correct: Access these files from a Google domain
<script src="https://securepubads.g.doubleclick.net/tag/js/gpt.js" crossorigin="anonymous" async></script>
// Also correct, if using Limited Ads
<script src="https://pagead2.googlesyndication.com/tag/js/gpt.js" async></script>

Scenario 2: utilizzo degli ascoltatori dei tag di script gpt.js

Descrizione del caso d'uso generale Supponendo che l'API GPT sia pronta per essere chiamata quando il file JavaScript Il caricamento di gpt.js non è corretto perché alcune parti dell'API sono fornite dalla pubads_impl.js file. Pertanto, fare affidamento in qualsiasi modo (inclusi i framework) sull'API dagli ascoltatori di eventi associati al tag script non è corretto.
Esempio di snippet di codice con errore 
var tag = document.createElement('script');
tag.type = 'text/javascript';
tag.src = (useSSL ? 'https:' : 'http:') +
        '//www.googletagservices.com/tag/js/gpt.js';
// Incorrect: Attaching a callback to the script's onload event.
tag.onload = callback;
var node = document.getElementsByTagName('script')[0];
node.parentNode.insertBefore(tag, node);
Metodi suggeriti per correggere l'errore 
// Make sure that googletag.cmd exists.
window.googletag = window.googletag || {};
googletag.cmd = googletag.cmd || [];
// Correct: Queueing the callback on the command queue.
googletag.cmd.push(callback);
Spiegazione/descrizione della correzione googletag.cmd gestisce un elenco di comandi che verranno eseguiti non appena GPT è pronto. Questo è il modo corretto per assicurarti che il callback venga eseguito dopo il caricamento di GPT.

Scenario 3: controllo dell'oggetto googletag per sapere se GPT è pronto

Descrizione del caso d'uso generale Poiché l'API GPT potrebbe non essere pronta quando viene caricato il file JavaScript gpt.js, o quando l'oggetto googletag è definito, controllando l'oggetto per vedere se l'API GPT disponibile non è affidabile.
Esempio di snippet di codice con errore 
// Incorrect: Relying on the presence of the googletag object
// as a check for the GPT API.
if (typeof googletag != 'undefined') {
 functionProcessingGPT();
}
Metodi suggeriti per correggere l'errore 
// Correct: Relying on googletag.apiReady as a check for the GPT API.
if (window.googletag && googletag.apiReady) {
 functionProcessingGPT();
}
Spiegazione/descrizione della correzione GPT completerà il flag booleano googletag.apiReady non appena l'API sarà pronta per essere chiamata, in modo da poter fare affermazioni attendibili.

Scenario 4: utilizzo della sintassi del codice offuscato

Descrizione del caso d'uso generale Se fai affidamento sulla sintassi precisa del codice della libreria GPT minimizzata, quasi certamente riscontrerai errori. Limita il tuo utilizzo all'API documentata nella Guida di riferimento API, poiché apportiamo modifiche continue il funzionamento interno di GPT per migliorare continuamente.
Ad esempio, un requisito comune è rilevare quando PubAdsService è completamente caricato per chiamare refresh().
Esempio di snippet di codice con errore 
// Incorrect: Relying on an obfuscated property.
if (googletag.pubads().a != null) {
 functionProcessingGPT();
}
Metodi suggeriti per correggere l'errore 
// Correct: Relying on public GPT API methods
// (i.e. googletag.pubadsReady in this case).
if(window.googletag && googletag.pubadsReady) {
 functionProcessingGPT();
}
Spiegazione/descrizione della correzione È possibile fare affidamento solo sull'API pubblica. Per rilevare se PubAdsService è completamente caricato, abbiamo un valore booleano googletag.pubadsReady.

Scenario 5: sovrascrittura di qualsiasi funzione o variabile di GPT

Descrizione del caso d'uso generale I casi d'uso basati sulla sovrascrittura di qualsiasi funzione o variabile utilizzata da GPT potrebbero interrompere in qualsiasi momento perché non è un caso d'uso supportato. Le modifiche ai tempi nelle strutture interne del GPT possono causare questo tipo di comportamento errato a causa di interruzioni.
Esempio di snippet di codice con errore 
// Incorrect: Haphazardly overwriting a googletag.* property.
googletag.cmd = [];
Metodi suggeriti per correggere l'errore 
// Correct: Never overwrite googletag.* properties if they already exist.
// Always check before assigning to them.
googletag.cmd = googletag.cmd || [];

Scenario 6: ordine errato delle chiamate al GPT

Descrizione del caso d'uso generale Le condizioni di gara possono creare malfunzionamenti con l’evoluzione dei componenti interni di GPT. Un errore un insieme ordinato di istruzioni operative a causa di tempistiche specifiche di esecuzione potrebbero non rimanere operativi in futuro.
Esempio di snippet di codice con errore 
// Incorrect: Setting page-level key-value targeting after calling
// googletag.enableServices().
googletag.enableServices();
googletag.defineSlot(...);
googletag.pubads().setTargeting(e, a);
Metodi suggeriti per correggere l'errore 
// Correct: Setting page-level key-value targeting before calling
// googletag.enableServices().
googletag.pubads().setTargeting(e, a);
googletag.defineSlot(...);
googletag.enableServices();
Spiegazione / descrizione della correzione Evita le condizioni di gara assicurandoti di rispettare le tempistiche abituali del GPT. Ecco alcuni esempi di ordini parziali validi:
  • Definisci-Attiva-Display
    1. Definisci le impostazioni a livello di pagina
    2. Definisci gli slot
    3. enableServices()
    4. Slot di visualizzazione
  • Attiva-Definisci-Visualizza
    1. Definire le impostazioni a livello di pagina
    2. enableServices()
    3. Definire gli slot
    4. Slot di visualizzazione

Scenario 7: uso improprio delle chiusure e dell'ambito delle variabili JavaScript

Descrizione del caso d'uso generale Ipotesi errate sulla definizione dell'ambito delle variabili JavaScript e sul valore delle variabili acquisito nella funzione passata a googletag.cmd.push.
Esempio di snippet di codice con errore 
// Incorrect: Variable x is declared outside the anonymous function
// but referenced within it.
for (var x = 0; x < slotCount; x++) {
 window.googletag.cmd.push(
  function(){
    // If GPT is not yet loaded, this code will be executed subsequently when
    // the command queue is processed. Every queued function will use the last value
    // assigned to x (most likely slotCount).
    // This is because the function closure captures the reference to x,
    // not the current value of x.
    window.googletag.display(slot[x]);
  })
 }
}
Metodi suggeriti per correggere l'errore 
window.googletag.cmd.push(
 function(){
  // Correct: We both declare and reference x inside the context of the function.
  for (var x = 0; x < slotCount; x++){
   window.googletag.display(slot[x]);
  }
 }
)
Spiegazione/descrizione della correzione

In JavaScript, le chiusure acquisiscono le variabili per riferimento anziché per valore. Ciò significa che se una variabile viene rias assegnata, il suo nuovo valore verrà utilizzato quando la chiusura della funzione che la ha acquisita verrà eseguita in un secondo momento. Pertanto, il comportamento del codice nella chiusura può cambiare a seconda che il callback venga eseguito immediatamente o in ritardo.

Nel caso di GPT caricato in modo asincrono, a seconda della velocità di caricamento del GPT, i callback nella coda di comando potrebbero essere eseguiti o meno immediatamente. Nell'esempio precedente, questo modifica il comportamento dei comandi in coda.

Per evitare problemi, il codice deve essere scritto senza presupporre che le funzioni messe nella coda di comandi vengano eseguite immediatamente e occorre prestare attenzione alle regole di ambito di JavaScript.

Scenario 8: spostamento dei contenitori degli slot all'interno del DOM dopo la visualizzazione della chiamata

Descrizione del caso d'uso generale Lo spostamento o l'inserimento di contenitori degli slot nel DOM dopo aver chiamato il metodo display può portare a un reflow indesiderato e a un comportamento imprevedibile in GPT.
Esempio di snippet di codice con errore 
// Incorrect: Moving slot containers after calling display
googletag.defineSlot("/1234/travel/asia", [728, 90], "div-gpt-ad-123456789-0");
googletag.enableServices();
googletag.display("div-gpt-ad-123456789-0");
...
// Inserting another element before the slot container, pushing the slot container down the page.
document.body.insertBefore(someOtherElement, document.getElementById("div-gpt-ad-123456789-0"));
Metodi suggeriti per correggere l'errore 
// Correct: Make any DOM order changes before calling display

document.body.insertBefore(someOtherElement, document.getElementById("div-gpt-ad-123456789-0"));
...
googletag.defineSlot("/1234/travel/asia", [728, 90], "div-gpt-ad-123456789-0");
googletag.enableServices();
googletag.display("div-gpt-ad-123456789-0");

Scenario 9: sovrascrittura delle API del browser

Descrizione del caso d'uso di alto livello La sovrascrittura (ovvero applicazione di patch a scimmia, polyfill) delle API del browser non è supportata in GPT. Questa pratica ha il potenziale per interrompere gli script di terze parti come GPT in modi inaspettati.
Esempio di snippet di codice con errore 
// Incorrect: Overwriting window.fetch
const { fetch: originalFetch } = window;
window.fetch = (...args) => {
 console.log('Fetching!');
 return originalFetch(resource, config);
};
Metodi suggeriti per correggere l'errore 
// Correct: Avoid making changes to browser APIs.
// If you need custom logic, consider leaving the browser API intact.
const myFetch = (...args) => {
  console.log('Fetching!');
  return window.fetch(...args);
}
Indietro
Monitorare il rendimento