Questa pagina presuppone una conoscenza delle guide per gli sviluppatori sulla progettazione orientata alle risorse e sui nomi delle risorse e le integra con dettagli specifici di implementazione 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 con indirizzi singoli (i sostantivi dell'API). Alle risorse viene fatto riferimento con i rispettivi 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, il seguente URL può essere suddiviso in questi singoli componenti in base alla seguente tabella:
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)
condividino un prefisso comune della versione API. Il nome e il metodo della risorsa identificano insieme
il servizio API che viene 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. Tra gli esempi di metodi personalizzati nell'API Google Ads ci 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.