Questa pagina presuppone una conoscenza delle guide per gli sviluppatori Progettazione orientata alle risorse e Nomi delle risorse e le integra con dettagli di implementazione specifici dell'API Google Ads.
Progettazione orientata alle risorse
In genere, l'API Google Ads segue una progettazione orientata alle risorse, modellata come raccolte di risorse indirizzabili individualmente (i sostantivi dell'API). Le risorse vengono referenziate con i relativi nomi delle risorse 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 API specifico, comprendono gli URL dell'interfaccia REST. Ad esempio, questo URL di esempio può essere suddiviso in questi singoli componenti in base alla tabella seguente:
https://googleads.googleapis.com/v25/customers/1234567890:mutate
| Prefisso della versione API | Nome della risorsa (relativo) | Metodo |
|---|---|---|
https://googleads.googleapis.com/v25
|
customers/1234567890
|
mutate
|
Tutti gli URL REST per una determinata versione dell'API (ad es. v25) condividono un prefisso della versione API comune. Il nome della risorsa e il metodo identificano insieme il servizio API chiamato.
L'API Google Ads utilizza molto i 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 maggiori 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
Per indicazioni su come analizzare ed eseguire il debug di eventuali errori, consulta la pagina Informazioni sugli errori API per
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 rilevamento 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 dalla macchina.