REST 介面設計

本頁內容假定您對資源導向設計資源名稱開發人員指南十分熟悉,且可將其與 Google Ads API 的特定實作詳細資料相輔相成。

資源導向設計

一般來說,Google Ads API 採用資源導向設計,以可個別處理的「資源」 (API 的「名詞」) 集合為模型。系統會以資源名稱參照資源,並使用一組「方法」 (又稱為「動詞」或「作業」) 來操控資源。

這些資源名稱方法加上特定的 API 版本前置字串,構成 REST 介面的網址。舉例來說,下列網址可按照下表細分為這些個別元件:

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

特定 API 版本 (例如v16) 共用通用 API 版本前置字串。資源名稱和方法集合在一起,即可識別呼叫的 API 服務。

Google Ads API 會大量使用自訂方法,與使用標準 REST 方法 (例如 listgetcreateupdatedelete) 的大多數傳統 REST API 不同。Google Ads API 中的自訂方法範例包括 searchsearchStreammutate

以下頁面將進一步說明 Google Ads API 的資源名稱服務方法JSON 命名慣例,以便說明如何同時使用這些方法定義 REST 介面端點。