REST 介面設計

本頁面假設您熟悉資源導向設計和資源名稱開發人員指南,並提供 Google Ads API 的特定實作細節。

以資源為導向的設計

一般來說,Google Ads API 採用資源導向設計,以可個別定址的資源 (API 的名詞) 集合為模型。資源會以資源名稱參照,並使用一小組方法 (也稱為動詞或作業) 進行操作。這些資源名稱和方法,與特定 API 版本前置字元結合,構成 REST 介面的網址。舉例來說,這個範例網址可以根據下表細分為以下個別元件:

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

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

Google Ads API 大量使用自訂方法,而非大多數 REST API 使用的標準 REST 方法,例如 list、get、create、update 和 delete。Google Ads API 中的自訂方法範例包括 search、searchStream 和 mutate。

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

錯誤管理

如要瞭解如何分析及偵錯發生的錯誤,請參閱「瞭解 API 錯誤」。

導覽文件

如要更輕鬆地自動探索 Google Ads API 中的可用方法,可以使用各版本發布的導覽文件。

請前往 https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION> 取得。舉例來說,這是最新版本 Google Ads API 的導覽文件。

導覽文件包含 Google Ads API 中使用的所有服務、方法、資源和實體相關資訊,類似參考文件,但採用機器可讀的 JSON 格式。