Struttura dell'API

Video: guarda il talk sui servizi e le risorse del workshop del 2019

Questa guida illustra i componenti principali che compongono l'API Google Ads. L'API Google Ads è composta da risorse e servizi. Una risorsa rappresenta un'entità Google Ads, mentre i servizi recuperano e manipolano le entità Google Ads.

Gerarchia degli oggetti

Un account Google Ads può essere visualizzato come una gerarchia di oggetti.

Modello di campagna

  • La risorsa di primo livello di un account è il cliente.

  • Ogni cliente contiene una o più campagne attive.

  • Ogni campagna contiene uno o più gruppi di annunci, utilizzati per raggruppare gli annunci in raccolte logiche.

  • Un annuncio del gruppo di annunci rappresenta un annuncio che stai pubblicando. Ad eccezione delle campagne per app, che possono avere un solo annuncio per gruppo di annunci, ogni gruppo di annunci contiene uno o più annunci del gruppo di annunci.

Puoi associare uno o più AdGroupCriterion o CampaignCriterion a un gruppo di annunci o a una campagna. Questi rappresentano i criteri che definiscono il modo in cui vengono attivati gli annunci.

Esistono molti tipi di criteri, come parole chiave, fasce d'età e località. I criteri definiti a livello di campagna influiscono su tutte le altre risorse al suo interno. Puoi anche specificare budget e date a livello di campagna.

Infine, puoi allegare le estensioni a livello di account, campagna o gruppo di annunci. Le estensioni ti consentono di fornire informazioni aggiuntive ai tuoi annunci, ad esempio numero di telefono, indirizzo o promozioni.

Risorse

Le risorse rappresentano le entità all'interno del tuo account Google Ads. Campaign e AdGroup sono due esempi di risorse.

ID oggetto

Ogni oggetto in Google Ads è identificato dal proprio ID. Alcuni di questi ID sono univoci a livello globale in tutti gli account Google Ads, mentre altri sono univoci solo all'interno di un ambito limitato.

ID oggetto Ambito dell'unicità È un valore univoco a livello globale?
ID budget Globale Sì
ID campagna Globale Sì
ID gruppo di annunci Globale Sì
ID annuncio Gruppo di annunci No, ma la coppia (AdGroupId, AdId) è univoca a livello globale
ID criterio gruppo di annunci Gruppo di annunci No, ma la coppia (AdGroupId, CriterionId) è univoca a livello globale
ID CampaignCriterion Campagna No, ma la coppia (CampaignId, CriterionId) è univoca a livello globale
Estensioni annuncio Campagna No, ma la coppia (CampaignId, AdExtensionId) è univoca a livello globale
ID feed Globale Sì
ID elemento del feed Globale Sì
ID attributo feed Feed No
ID mappatura feed Globale Sì
ID etichetta Globale Sì
ID elenco utenti Globale Sì

Queste regole ID possono essere utili per progettare lo spazio di archiviazione locale per gli oggetti Google Ads.

Alcuni oggetti possono essere utilizzati per più tipi di entità. In questi casi, l'oggetto contiene un campo type che descrive i relativi contenuti. Ad esempio, AdGroupAd può fare riferimento a un oggetto come un annuncio di testo, un annuncio di hotel o un annuncio locale. È possibile accedere a questo valore tramite il campo AdGroupAd.ad.type e restituisce un valore nell'enum AdType.

Nomi delle risorse

Ogni risorsa è identificata in modo univoco da una stringa resource_name, che concatena la risorsa e le relative risorse padre in un percorso. Ad esempio, i nomi delle risorse della campagna hanno il seguente formato:

customers/customer_id/campaigns/campaign_id

Pertanto, per una campagna con ID 987654 nell'account Google Ads con ID cliente 1234567, resource_name sarà:

customers/1234567/campaigns/987654

Servizi

I servizi ti consentono di recuperare e modificare le entità Google Ads. Esistono tre tipi di servizi: modifica, recupero di oggetti e statistiche e recupero di metadati.

Modificare (mutare) gli oggetti

Questi servizi modificano le istanze di un tipo di risorsa associato utilizzando una richiesta mutate. Forniscono anche una richiesta get che recupera una singola istanza della risorsa, il che può essere utile per esaminare la struttura di una risorsa.

Esempi di servizi:

Ogni richiesta mutate deve includere gli oggetti operation corrispondenti. Ad esempio, il metodo CampaignService.MutateCampaigns prevede una o più istanze di CampaignOperation. Per una discussione dettagliata delle operazioni, consulta Modificare e ispezionare gli oggetti.

Mutazioni simultanee

Un oggetto Google Ads non può essere modificato contemporaneamente da più origini. Ciò potrebbe causare errori se più utenti aggiornano lo stesso oggetto con la tua app o se stai modificando gli oggetti Google Ads in parallelo utilizzando più thread. Ciò include l'aggiornamento dell'oggetto da più thread nella stessa applicazione o da applicazioni diverse (ad esempio la tua app e una sessione dell'interfaccia utente di Google Ads simultanea).

L'API non fornisce un modo per bloccare un oggetto prima dell'aggiornamento. Se due origini tentano di modificare contemporaneamente un oggetto, l'API genera un DatabaseError.CONCURRENT_MODIFICATION_ERROR.

Modifiche asincrone e sincrone

I metodi di mutazione dell'API Google Ads sono sincroni. Le chiamate API restituiscono una risposta solo dopo la mutazione degli oggetti, quindi devi attendere una risposta per ogni richiesta. Sebbene questo approccio sia relativamente semplice da codificare, potrebbe avere un impatto negativo sul bilanciamento del carico e sprecare risorse se le procedure sono costrette ad attendere il completamento delle chiamate.

Un approccio alternativo è modificare gli oggetti in modo asincrono utilizzando BatchJobService, che esegue batch di operazioni su più servizi senza attendere il loro completamento. Una volta inviato un job batch, i server dell'API Google Ads eseguono le operazioni in modo asincrono, liberando le risorse per l'esecuzione di altre operazioni. Puoi controllare periodicamente lo stato del compito per verificare il completamento.

Per scoprire di più sull'elaborazione asincrona, consulta la guida all'elaborazione batch.

Convalida della modifica

La maggior parte delle richieste di mutazione può essere convalidata senza eseguire effettivamente la chiamata su dati reali. Puoi verificare la richiesta per verificare la presenza di parametri mancanti e valori di campo errati senza eseguire effettivamente l'operazione.

Per utilizzare questa funzionalità, imposta il campo booleano facoltativo validate_only della richiesta su true. La richiesta verrà quindi convalidata completamente come se dovesse essere eseguita, ma l'esecuzione finale viene saltata. Se non vengono rilevati errori, viene restituita una risposta vuota. Se la convalida non va a buon fine, i messaggi di errore nella risposta indicano i punti di errore.

validate_only è particolarmente utile per verificare se gli annunci violano le norme comuni. Gli annunci vengono rifiutati automaticamente se violano le norme, ad esempio se contengono parole, punteggiatura, lettere maiuscole o lunghezza specifiche. Un singolo annuncio con problemi potrebbe causare l'errore di un intero lotto. Il test di un nuovo annuncio all'interno di una validate_only richiesta può rivelare eventuali violazioni di questo tipo. Per vedere come funziona, consulta l'esempio di codice per la gestione degli errori di violazione delle norme.

Visualizzare gli oggetti e le statistiche sul rendimento

GoogleAdsService è il servizio unico e unificato per il recupero di oggetti e statistiche sul rendimento.

Tutte le richieste Search e SearchStream per GoogleAdsService richiedono una query che specifichi la risorsa su cui eseguire la query, gli attributi della risorsa e le metriche sul rendimento da recuperare, i predicati da utilizzare per filtrare la richiesta e i segmenti da utilizzare per suddividere ulteriormente le statistiche sul rendimento. Per saperne di più sul formato delle query, consulta la guida al linguaggio di query di Google Ads.

Recuperare i metadati

GoogleAdsFieldService recupera i metadati relativi alle risorse nell'API Google Ads, ad esempio gli attributi disponibili per una risorsa e il relativo tipo di dati.

Questo servizio fornisce le informazioni necessarie per la creazione di una query per GoogleAdsService. Per comodità, le informazioni restituite da GoogleAdsFieldService sono disponibili anche nella documentazione di riferimento dei campi.

Indietro
Panoramica
Avanti
Controllo delle versioni