REST 介面設計

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

資源導向設計

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

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

https://googleads.googleapis.com/v18/customers/1234567890:mutate
API 版本前置字串 資源名稱 (相對) 方法
https://googleads.googleapis.com/v18 customers/1234567890 mutate

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

Google Ads API 大量使用自訂方法,而非大多數傳統 REST API 所使用的標準 REST 方法,例如 listgetcreateupdatedelete。Google Ads API 中的自訂方法範例包括 searchsearchStreammutate

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