Design dell'interfaccia REST

Questa pagina presuppone una conoscenza delle guide per gli sviluppatori relative alla progettazione orientata alle risorse e ai nomi delle risorse e include dettagli specifici sull'implementazione dell'API Search Ads 360 Reporting.

Design orientato alle risorse

In genere, l'API Search Ads 360 Reporting segue un design orientato alle risorse, modellato come raccolte di risorse con indirizzi singoli (i nomi dell'API). Le risorse vengono utilizzate per fare riferimento ai relativi nomi e manipolate utilizzando un piccolo insieme di metodi (noti anche come verbi o operazioni).

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

https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
Prefisso versione API Nome risorsa (relativo) Metodo
https://searchads360.googleapis.com/v0 customers/1234567890 search

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

L'API Search Ads 360 Reporting fa un uso intensivo dei metodi personalizzati, a differenza della maggior parte delle API REST tradizionali che utilizzano metodi REST standard come list e get. L'API Search Ads 360 Reporting include due metodi personalizzati: search e searchStream.

Le pagine seguenti forniscono maggiori dettagli sui nomi delle risorse, sui metodi di servizio e sulle convenzioni di denominazione JSON dell'API Search Ads 360 Reporting per illustrare come vengono utilizzati insieme per definire gli endpoint dell'interfaccia REST.