Best practice

Video: dai un'occhiata al discorso sulle best practice del workshop 2019

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

Manutenzione costante

Per assicurarti 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. Qualora non riuscissimo a contattarti in merito alla conformità ai Termini e condizioni dell'API, l'accesso all'API potrebbe essere revocato a tua insaputa. Evita di utilizzare un indirizzo email personale associato a un account individuale o non monitorato.

  • Per ricevere informazioni su problemi quali modifiche al prodotto, tempi di inattività per la manutenzione, date di deprecazione e così via,

Il forum è monitorato regolarmente dal team dell'API Google Ads ed è il luogo ideale per pubblicare domande sulle API.

  • Mantieni la tua app conforme ai Termini e condizioni dell'API Google Ads. Se necessario, il team di revisione e conformità del token ti contatterà al tuo indirizzo email. Se hai domande o dubbi in merito a Termini e condizioni, puoi contattare il team di revisori rispondendo all'email che ti è stata inviata durante l'esame della tua richiesta di token sviluppatore.

Ottimizzazione

Operazioni batch

Una richiesta all'API comporta una serie di costi fissi, come la latenza di rete andata e ritorno, l'elaborazione di serializzazione e deserializzazione e le chiamate ai sistemi back-end. Per ridurre l'impatto di questi costi fissi e aumentare le prestazioni complessive, la maggior parte dei metodi mutati nell'API è progettata per accettare un array di operazioni. Raggruppando più operazioni in ogni richiesta, puoi ridurre il numero di richieste effettuate e i costi fissi associati. Se puoi, evita di effettuare richieste con una sola operazione.

Ad esempio, supponi 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, quindi potresti dover regolare le dimensioni del batch per ottenere prestazioni ottimali.

Invia oggetti sparsi

Quando gli oggetti vengono inviati all'API, i campi devono essere deserializzati, convalidati e archiviati nel database. Il trasferimento di oggetti pieni quando vuoi aggiornare solo alcuni campi può comportare tempi di elaborazione aggiuntivi e prestazioni inferiori. Per limitare questo problema, l'API Google Ads supporta aggiornamenti sparsi, che ti consentono di compilare solo i campi di un oggetto che devi modificare o che sono obbligatori. Gli aggiornamenti sparsi vengono elaborati più velocemente e hanno meno probabilità di generare errori. I campi non presenti in update_mask (noti anche come FieldMask) non vengono modificati.

Ad esempio, un'app che aggiorna le offerte a livello di parola chiave può trarre vantaggio dall'utilizzo di pochi aggiornamenti, poiché solo i campi ID gruppo di annunci, ID criterio e offerte dovrebbero essere compilati.

Gestione e gestione degli errori

Durante lo sviluppo, è probabile che si verifichino errori. Questa sezione descrive le considerazioni e le strategie per la gestione degli errori nell'app. Oltre a questa sezione, consulta la Guida alla risoluzione dei problemi per ulteriori informazioni sulla gestione degli errori.

Distinguere le origini delle richieste

Alcune app sono principalmente interattive e inviano chiamate API direttamente in risposta ad azioni avviate dall'utente in una UI. Altre funzionano principalmente offline, inviando chiamate API nell'ambito di un processo di back-end periodico. Molte app le uniscono. 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 deve essere quella di offrire una buona esperienza agli utenti. Utilizza l'errore specifico che si è verificato per fornire all'utente quanto più contesto possibile nella UI. Indica semplici passaggi che possono seguire per risolvere l'errore (dai un'occhiata ai suggerimenti di seguito).

Per le richieste avviate dal 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 non rilevati in precedenza. Un buon approccio per un gestore predefinito è aggiungere l'operazione non riuscita e l'errore a una coda per consentire a un operatore umano di esaminarla 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 solida. Alcuni dei tipi di errore più comuni sono:

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

Per ulteriori dettagli, consulta Tipi di errore ed Errori comuni.

Backend di sincronizzazione

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 errore, puoi correggere gli errori di sincronizzazione in modo reattivo quando si verificano, ma puoi anche cercare di evitarli in modo proattivo. Una strategia proattiva consiste nell'eseguire un job di sincronizzazione notturna su tutti gli account, recuperando gli oggetti Google Ads e confrontandoli con il database locale.

Errori di log

Tutti gli errori devono essere registrati per facilitare il debug e il monitoraggio. Come minimo, registra 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 delle richieste di round trip, il numero di nuovi tentativi e la richiesta e la risposta non elaborate.

Assicurati di monitorare le tendenze degli errori dell'API in modo da poter rilevare e risolvere i problemi dell'app. Valuta la possibilità di creare una soluzione personalizzata o di utilizzare uno dei tanti strumenti commerciali disponibili in grado di utilizzare i log per produrre dashboard interattive e inviare avvisi automatici.

Sviluppo

Utilizzare gli account di prova

Gli account di prova sono account Google Ads che non pubblicano effettivamente annunci. Puoi utilizzare un account di prova per fare esperimenti con l'API Google Ads e verificare che la connettività dell'app, la logica di gestione delle campagne o altre elaborazioni 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 subito dopo aver richiesto un token sviluppatore, anche prima che l'app venga esaminata.