REST 介面設計

本頁面假設您熟悉「資源導向設計」和「資源名稱」開發人員指南,並補充 Search Ads 360 Reporting API 的具體實作詳細資料。

資源導向設計

一般來說,Search Ads 360 報表 API 會採用資源導向設計,以可個別呼叫的「資源」 (API 的「名詞」) 做為模型的「集合」。不同的資源有各自的參照名稱,也就是所謂的「資源名稱」,並且是透過一套「方法」 (又稱為「動詞」或「作業」) 來操控。

這些資源名稱方法,搭配特定的 API 版本前置字串,組成了 REST 介面的網址。舉例來說,下列網址可根據下表分解為以下個別元件:

https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
API 版本前置字串 資源名稱 (相對) 方法
https://searchads360.googleapis.com/v0 customers/1234567890 search

特定 API 版本的所有 REST 網址 (例如v0) 共用相同的 API 版本前置字串。資源名稱和方法會一同識別要呼叫的 API 服務。

Search Ads 360 Reporting API 大量使用自訂方法,而非大多數傳統 REST API 所使用的標準 REST 方法,例如 listget。Search Ads 360 Reporting API 包含兩種自訂方法:searchsearchStream

下列頁面將進一步說明 Search Ads 360 Reporting API 的資源名稱服務方法JSON 命名慣例,並說明如何搭配使用這些項目來定義 REST 介面端點。