Struttura dell'API

Video: scopri la presentazione di servizi e risorse del workshop del 2019

Questa guida introduce i componenti principali che costituiscono l'API Google Ads. L'API Google Ads è costituita 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 considerato 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.

Puoi allegare uno o più AdGroupCriterion o CampaignCriterion a un gruppo di annunci o a una campagna. Questi rappresentano i criteri che definiscono l'attivazione degli annunci.

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

Infine, puoi allegare estensioni a livello di account, campagna o gruppo di annunci. Le estensioni ti consentono di fornire informazioni aggiuntive ai tuoi annunci, come 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 da un 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à 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 AdGroupCriterion 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 etichetta Globale Sì
ID elenco utenti Globale Sì
ID risorsa Globale Sì

Queste regole ID possono essere utili per progettare l'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 suoi contenuti. Ad esempio, AdGroupAd può fare riferimento a un oggetto come un annuncio di testo, un annuncio per hotel o un annuncio locale. È possibile accedere a questo valore tramite il campo AdGroupAd.ad.type e restituisce un valore nell'enumerazione AdType.

Nomi delle risorse

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

customers/customer_id/campaigns/campaign_id

Quindi, per una campagna con ID 987654 nell'account Google Ads con ID cliente 1234567, il resource_name sarebbe:

customers/1234567/campaigns/987654

Servizi

I servizi ti consentono di recuperare e modificare le entità Google Ads. Esistono tre tipi di servizi: servizi di 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 di risorsa, 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. Consulta Modifica e ispezione degli oggetti per una discussione dettagliata delle operazioni.

Modifiche simultanee

Un oggetto Google Ads non può essere modificato contemporaneamente da più di un'origine. Ciò potrebbe causare errori se più utenti aggiornano lo stesso oggetto con la tua app o se modifichi 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 simultanea dell'interfaccia utente di Google Ads).

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

Mutazioni asincrone e sincrone

I metodi mutate dell'API Google Ads sono sincroni. Le chiamate API restituiscono una risposta solo dopo la mutazione degli oggetti, il che ti costringe ad attendere una risposta a ogni richiesta. Sebbene questo approccio sia relativamente semplice da codificare, potrebbe influire negativamente sul bilanciamento del carico e sprecare risorse se i processi sono costretti ad attendere il completamento delle chiamate.

Un approccio alternativo consiste nel 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 i processi per eseguire altre operazioni. Puoi controllare periodicamente lo stato del job per verificare il completamento.

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

Convalida della modifica

La maggior parte delle richieste di modifica può essere convalidata senza eseguire effettivamente la chiamata rispetto ai dati reali. Puoi testare la richiesta di parametri mancanti e valori dei campi 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 ignorata. Se non vengono trovati errori, viene restituita una risposta vuota. Se la convalida non va a buon fine, i messaggi di errore nella risposta indicheranno i punti di errore.

validate_only è particolarmente utile per testare gli annunci in relazione a violazioni comuni delle norme. Gli annunci vengono rifiutati automaticamente se violano norme come l'utilizzo di parole, punteggiatura, maiuscole o lunghezza specifiche. Un singolo annuncio non valido potrebbe causare l'errore dell'intero batch. Il test di un nuovo annuncio all'interno di una validate_only richiesta può rivelare eventuali violazioni di questo tipo. Per vedere questo in azione, consulta l'esempio di codice per la gestione degli errori di violazione delle norme.

Visualizzare statistiche sugli oggetti e sul rendimento

GoogleAdsService è l'unico servizio 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 analizzare 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 sulle 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 creare 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