Design dell'interfaccia REST

Questa pagina presuppone la conoscenza delle guide per gli sviluppatori relative alla progettazione delle risorse e ai nomi delle risorse e include dettagli specifici sull'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 nomi dell'API). Alle risorse viene fatto riferimento con i relativi nomi e manipolati utilizzando un piccolo insieme di metodi (noti anche come verbi o operazioni).

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

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

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

L'API Google Ads fa un uso intensivo dei metodi personalizzati, al contrario 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 illustrano nel dettaglio i nomi delle risorse, i metodi di servizio e le convenzioni di denominazione JSON dell'API Google Ads per illustrare come vengono utilizzati insieme per definire gli endpoint dell'interfaccia REST.