Design dell'interfaccia REST

Questa pagina presuppone la conoscenza delle guide per sviluppatori Design orientato alle risorse e Nomi risorse e le completa con dettagli specifici di implementazione dell'API Google Ads.

Progettazione orientata 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 richiamate 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, l'URL riportato di seguito può essere suddiviso nei seguenti singoli componenti in base alla seguente tabella:

https://googleads.googleapis.com/v18/customers/1234567890:mutate
Prefisso della versione dell'API Nome risorsa (relativo) Metodo
https://googleads.googleapis.com/v18 customers/1234567890 mutate

Tutti gli URL REST per una determinata versione dell'API (ad es. v18) condividono un prefisso della versione dell'API comune. Il nome e il metodo della risorsa insieme identificano il servizio API chiamato.

L'API Google Ads fa un uso intensivo di metodi personalizzati, a differenza della maggior parte delle API REST tradizionali che utilizzano metodi REST standard come list, get, create, update e delete. Alcuni esempi di metodi personalizzati nell'API Google Ads sono 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.