REST 介面設計

本頁內容假設您熟悉資源導向設計資源名稱開發人員指南,並補充了 Google Ads API 的具體導入詳情。

資源導向設計

一般來說,Google Ads API 會採用資源導向的設計,並以可個別呼叫的資源 (API 的名詞)「集合」來模擬。資源會被參照資源名稱,並且使用少數一組「方法」 (也稱為「動詞」或「作業」) 來操控。

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

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

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

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

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