Best practice

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

Gestire l'app

Per assicurarti che la tua app funzioni senza interruzioni:

  • Assicurati che l'elenco dei proprietari e degli editor del tuo progetto Google Cloud sia aggiornato. Contatteremo questi utenti in caso di emergenze o argomenti relativi alla conformità ai Termini e condizioni dell'API. Se non riusciamo a contattarti in merito alla conformità ai Termini e condizioni dell'API, il tuo accesso all'API potrebbe essere ridotto o revocato.

  • Per essere informato su problemi quali modifiche ai prodotti, tempi di inattività per manutenzione e date di ritiro, iscriviti al nostro blog API e al blog sui prodotti.

  • Mantieni la tua app conforme ai Termini e condizioni (T&C) dell'API Google Ads. Se necessario, il team di conformità API contatterà i proprietari e gli editor del tuo progetto Google Cloud con accesso API. Se hai domande o dubbi in merito ai Termini e condizioni, puoi contattare il team di conformità rispondendo all'email che ti ha inviato durante la revisione della tua richiesta di accesso all'API.

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, come 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 il rendimento complessivo, la maggior parte dei metodi di modifica dell'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 potresti dover 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 memorizzati nel database. Il passaggio di oggetti completi quando vuoi aggiornare solo alcuni campi può comportare tempi di elaborazione aggiuntivi e prestazioni ridotte. Per mitigare 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 sono presenti in update_mask (noto 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 solo i campi ID gruppo di annunci, ID criterio e offerte devono essere compilati.

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 ad 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 cose. 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 nella UI. Offri passaggi chiari che possono seguire per risolvere l'errore (vedi i suggerimenti di seguito).

Per le richieste avviate sul 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 affinché 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:

Per saperne di più, consulta le sezioni Tipi di errori ed Errori comuni.

Sincronizzare i 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 provare a prevenirli in modo proattivo. Una strategia proattiva consiste nell'eseguire un job di sincronizzazione periodica per riconciliare il database locale con gli oggetti Google Ads nei tuoi account. Per le gerarchie di account di grandi dimensioni, evita di estrarre tutti gli oggetti di ogni account ogni notte per non esaurire le quote giornaliere. Esegui invece query ChangeStatus o filtra le entità modificate di recente per sincronizzare le modifiche in modo incrementale.

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 ID cliente, servizio API, latenza della richiesta di andata e ritorno, numero di tentativi e richiesta e risposta non elaborate sanificate (assicurati di oscurare le credenziali sensibili come i token OAuth, i token sviluppatore se ancora inclusi nelle intestazioni delle richieste legacy e qualsiasi PII).

Assicurati di monitorare le tendenze degli 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 prova durante lo sviluppo.

Utilizzare gli account di prova

Gli account di test sono account Google Ads che non pubblicano 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 progetto Google Cloud deve avere solo l'accesso di test per essere utilizzato su un account di test, in modo da poter iniziare subito a sviluppare con l'API Google Ads, in attesa che Google esamini la tua richiesta per livelli di accesso API più elevati.