Best practice

Video: guarda il discorso sulle best practice del workshop del 2019

Questa guida illustra alcune best practice che puoi implementare per ottimizzare l'efficienza e il rendimento delle tue app.

Manutenzione costante

Per garantire che la tua app funzioni senza interruzioni:

  • Mantieni aggiornata l'email di contatto dello sviluppatore nel Centro API. Questo è l'alias che utilizziamo per contattarti. Se non riusciamo a contattarti in merito alla conformità ai Termini e condizioni dell'API, il tuo accesso all'API potrebbe essere revocato a tua insaputa. Evita di utilizzare un indirizzo email personale collegato a un account individuale o non monitorato. Per visualizzare il Centro API, devi aver eseguito l'accesso al tuo account amministratore.

  • Per essere informato di problemi quali modifiche ai prodotti, tempi di inattività per manutenzione, date di ritiro e così via, iscriviti al nostro

Il forum viene monitorato regolarmente dal team dell'API Google Ads, il che lo rende il luogo ideale per pubblicare domande sull'API.

  • Mantieni la tua app conforme ai Termini e condizioni (T&C) dell'API Google Ads. Se necessario, il team di revisione e conformità dei token ti contatterà utilizzando il tuo indirizzo email di contatto. Se hai domande o dubbi in merito ai Termini e condizioni, puoi contattare il team di revisione rispondendo all'email che ti ha inviato durante la revisione della tua richiesta di token sviluppatore.

Ottimizzazione

Puoi ottimizzare la tua app eseguendo operazioni batch e, se opportuno, inviando oggetti sparsi.

Operazioni batch

L'invio di una richiesta all'API comporta una serie di costi fissi, ad esempio la latenza di rete round trip, l'elaborazione di serializzazione e deserializzazione e le chiamate ai sistemi di backend. Per ridurre l'impatto di questi costi fissi e aumentare le prestazioni complessive, la maggior parte dei metodi di mutazione nell'API è progettata per accettare un array di operazioni. Raggruppando più operazioni in ogni richiesta, puoi ridurre il numero di richieste che effettui e i costi fissi associati. Se possibile, evita di effettuare richieste con una sola operazione.

Ad esempio, supponiamo di aggiungere 50.000 parole chiave a una campagna in più gruppi di annunci. Invece di effettuare 50.000 richieste con una parola chiave ciascuna, effettua 100 richieste con 500 parole chiave ciascuna o anche 10 richieste con 5000 parole chiave ciascuna. Esistono limiti al numero di operazioni consentite in una richiesta, pertanto potrebbe essere necessario modificare le dimensioni del batch per ottenere prestazioni ottimali.

Inviare oggetti sparsi

Quando gli oggetti vengono inviati all'API, i campi devono essere deserializzati, convalidati e archiviati nel database. Il passaggio di oggetti completi quando vuoi aggiornare solo alcuni campi può comportare tempi di elaborazione aggiuntivi e un calo delle prestazioni. Per risolvere questo problema, l'API Google Ads supporta gli aggiornamenti sparsi, consentendoti di compilare solo i campi di un oggetto che devi modificare o che sono obbligatori. Gli aggiornamenti sparsi vengono elaborati più rapidamente e hanno meno probabilità di produrre errori. I campi che non si trovano in update_mask (nota anche come FieldMask) rimangono invariati.

Ad esempio, un'app che aggiorna le offerte a livello di parola chiave può trarre vantaggio dall'utilizzo di aggiornamenti sparsi, in quanto è necessario compilare solo i campi ID gruppo di annunci, ID criterio e offerte.

Gestione degli errori

Durante lo sviluppo, è probabile che si verifichino errori. Questa sezione descrive considerazioni e strategie per integrare la gestione degli errori nella tua app. Oltre a questa sezione, consulta la guida alla risoluzione dei problemi per saperne di più sulla gestione degli errori.

Distinguere le origini delle richieste

Alcune app sono principalmente interattive ed eseguono chiamate API direttamente in risposta alle azioni avviate dall'utente in un'interfaccia utente. Altri funzionano principalmente offline, emettendo chiamate API nell'ambito di un processo di backend periodico. Molte app combinano le due funzionalità. Quando pensi alla gestione degli errori, può essere utile distinguere questi diversi tipi di richieste.

Per le richieste avviate dagli utenti, la tua preoccupazione principale dovrebbe essere quella di fornire una buona esperienza ai tuoi utenti. Utilizza l'errore specifico che si è verificato per fornire all'utente il maggior contesto possibile nell'interfaccia utente. Offri passaggi semplici da seguire per risolvere l'errore (consulta i suggerimenti riportati di seguito).

Per le richieste avviate nel backend, implementa i gestori per i diversi tipi di errori che la tua app potrebbe riscontrare. Includi sempre un gestore predefinito per risolvere errori rari o mai riscontrati in precedenza. Un buon approccio per un gestore predefinito è aggiungere l'operazione non riuscita e l'errore a una coda in modo che un operatore umano possa esaminarli e determinare una risoluzione appropriata.

Distinguere i tipi di errore

Conoscere le differenze tra i tipi di errore nell'API Google Ads è fondamentale per creare una gestione degli errori efficace. Alcuni dei tipi di errore più comuni sono:

  1. Errori di autenticazione
  2. Errori riproducibili
  3. Errori di convalida
  4. Errori relativi alla sincronizzazione

Per maggiori dettagli, consulta le sezioni Tipi di errori ed Errori comuni.

Sincronizzazione dei backend

Se gli utenti della tua app hanno accesso manuale agli account Google Ads, potrebbero apportare modifiche di cui la tua app non è a conoscenza, causando la mancata sincronizzazione del database locale dell'app. Come indicato nella nostra guida Tipi di errori, puoi risolvere gli errori relativi alla sincronizzazione in modo reattivo quando si verificano, ma puoi anche cercare di prevenirli in modo proattivo. Una strategia proattiva consiste nell'eseguire un job di sincronizzazione notturno su tutti gli account, recuperando gli oggetti Google Ads negli account e confrontandoli con il database locale.

Errori nei log

Tutti gli errori devono essere registrati per facilitare il debug e il monitoraggio. Registra almeno l'ID richiesta, le operazioni che hanno causato l'errore e l'errore stesso. Altre informazioni da registrare includono l'ID cliente, il servizio API, la latenza della richiesta di andata e ritorno, il numero di tentativi e la richiesta e la risposta non elaborate.

Assicurati di monitorare le tendenze negli errori API per poter rilevare e risolvere i problemi con la tua app. Valuta la possibilità di creare una soluzione personalizzata o di utilizzare uno dei numerosi strumenti commerciali disponibili che possono utilizzare i log per produrre dashboard interattive e inviare avvisi automatici.

Sviluppo

Utilizza account di test durante lo sviluppo.

Utilizzare account di prova

Gli account di test sono account Google Ads che non pubblicano effettivamente annunci. Puoi utilizzare un account di test per sperimentare l'API Google Ads e verificare che la connettività, la logica di gestione delle campagne o altre elaborazioni della tua app funzionino come previsto. Il tuo token sviluppatore non deve essere approvato per essere utilizzato su un account di prova, quindi puoi iniziare a sviluppare con l'API Google Ads immediatamente dopo aver richiesto un token sviluppatore, anche prima che la tua app venga esaminata.