Design dell'interfaccia REST

Questa pagina presuppone che tu abbia familiarità con le risorse Progettazione e delle risorse Nomi, guide per gli sviluppatori e li integra con dettagli specifici di implementazione dell'API Google Ads.

Design orientato alle risorse

Generalmente, l'API Google Ads segue un design orientato alle risorse, modellato come collections di risorse con indirizzi singoli (i sostantivi dell'API). Alle risorse viene fatto riferimento con i rispettivi nomi e manipolate utilizzando una insieme di metodi (noti anche come verbi o operazioni).

Questi nomi delle risorse e metodi, combinati con uno specifico prefisso della versione API, comprendono gli URL dell'interfaccia REST. Ad esempio, il seguente URL può essere suddiviso in singoli componenti in base alla tabella seguente:

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

Tutti gli URL REST per una determinata versione dell'API (ad es. v17 condividono un prefisso di versione API comune. Nome e metodo della risorsa insieme identifica il servizio API chiamato.

L'API Google Ads fa un uso intensivo di metodi personalizzati, diversamente dalla maggior parte le API REST tradizionali che usano 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 sulle risorse dell'API Google Ads nomi, metodi di servizio e Convenzioni di denominazione JSON per illustrarne l'utilizzo per definire gli endpoint dell'interfaccia REST.