本頁面假設您已熟悉資源導向設計和資源名稱開發人員指南,並補充說明 Google Ads API 的具體實作細節。
資源導向設計
一般來說,Google Ads API 採用資源導向設計,以可個別呼叫的「資源」 (API 的「名詞」)「集合」做為模型。不同的資源有各自的參照名稱,並且是透過一套「方法」 (又稱為「動詞」或「作業」) 來操控。
這些資源名稱和方法會與特定 API 版本前置字串合併,組成 REST 介面的網址。舉例來說,根據下表,以下網址可細分為這些個別元件:
https://googleads.googleapis.com/v21/customers/1234567890:mutate
API 版本前置字元 | 資源名稱 (相對) | 方法 |
---|---|---|
https://googleads.googleapis.com/v21
|
customers/1234567890
|
mutate
|
特定 API 版本的所有 REST 網址 (例如 v21
)
共用常見的 API 版本前置字串。資源名稱和方法會一併識別呼叫的 API 服務。
Google Ads API 大量使用自訂方法,而非大多數傳統 REST API 所用的標準 REST 方法,例如 list
、get
、create
、update
和 delete
。Google Ads API 中的自訂方法範例包括 search
、searchStream
和 mutate
。
以下頁面將詳細說明 Google Ads API 的資源名稱、服務方法和 JSON 命名慣例,並說明如何一併使用這些項目來定義 REST 介面端點。
探索文件
如要簡化及自動化 Google Ads API 中可用方法的探索作業,可以使用為每個版本發布的探索文件。
如要瞭解詳情,請參閱https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>
。
舉例來說,這個是最新版 Google Ads API 的探索文件。
探索文件包含 Google Ads API 中使用的所有服務、方法、資源和實體相關資訊,例如參考說明文件,但採用機器可讀取的 JSON 格式。