Questa pagina presuppone una certa familiarità con le guide per gli sviluppatori Resource Oriented Design e Resource Names 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 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, costituiscono gli URL dell'interfaccia REST. Ad esempio, l'URL riportato di seguito può essere suddiviso nei seguenti singoli componenti in base alla tabella seguente:
https://googleads.googleapis.com/v21/customers/1234567890:mutate
| Prefisso della versione dell'API | Nome risorsa (relativo) | Metodo |
|---|---|---|
https://googleads.googleapis.com/v21
|
customers/1234567890
|
mutate
|
Tutti gli URL REST per una determinata versione dell'API (ad es. v21)
condividere un prefisso comune della versione dell'API. Il nome della risorsa e il metodo insieme
identificano il servizio API chiamato.
L'API Google Ads utilizza molto i metodi personalizzati, a differenza della maggior parte delle API REST tradizionali 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.