Questa pagina presuppone una certa familiarità con le guide per gli sviluppatori Progettazione orientata alle risorse e Nomi delle risorse e le integra con dettagli di implementazione specifici dell'API Google Ads.
Design orientato alle risorse
In genere, l'API Google Ads segue un design orientato alle risorse, modellato come raccolte di risorse indirizzabili singolarmente (i nomi dell'API). Le risorse vengono indicate con i relativi nomi e manipolate utilizzando un piccolo insieme di metodi (noti anche come verbi o operazioni). Questi nomi delle risorse e metodi, combinati con un prefisso della versione dell'API specifico, costituiscono gli URL dell'interfaccia REST. Ad esempio, questo URL di esempio può essere suddiviso nei singoli componenti in base alla seguente tabella:
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| Prefisso della versione dell'API | Nome risorsa (relativo) | Metodo |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
Tutti gli URL REST per una determinata versione dell'API (ad es. v26) condividono un prefisso di versione dell'API comune. Il nome della risorsa e il metodo identificano insieme il servizio API chiamato.
L'API Google Ads fa un uso intensivo di metodi personalizzati, a differenza della maggior parte delle API REST che utilizzano metodi REST standard come list, get, create, update e delete. Esempi di metodi personalizzati nell'API Google Ads
includono search, searchStream e mutate.
Le pagine seguenti forniscono ulteriori dettagli sui nomi delle risorse, sui metodi di servizio e sulle convenzioni di denominazione JSON dell'API Google Ads per illustrare come vengono utilizzati insieme per definire gli endpoint dell'interfaccia REST.
Gestione degli errori
Consulta Informazioni sugli errori dell'API per indicazioni su come analizzare ed eseguire il debug di eventuali errori che si verificano.
Documento di rilevamento
Per facilitare e automatizzare il rilevamento dei metodi disponibili nell'API Google Ads, puoi utilizzare il documento di rilevamento pubblicato per ogni versione.
È disponibile all'indirizzo https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Ad esempio, questo è il documento di rilevamento per l'ultima versione dell'API Google Ads.
Il documento di discovery contiene informazioni su tutti i servizi, i metodi, le risorse e le entità utilizzati nell'API Google Ads, come la documentazione di riferimento, ma in un formato JSON leggibile da macchina.