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 格式。