REST 接口设计

本页假定您熟悉面向资源 的设计资源 名称开发者指南,并 补充了 Google Ads API 的具体实现细节。

面向资源的设计

一般来说,Google Ads API 遵循面向资源的设计,以 可单独寻址的资源(API 中的名词)的集合为模型。 资源通过资源名称被引用,并通过一小 组 方法(也称为 动词操作)进行控制。 这些 资源名称方法 与特定的 API 版本前缀 结合使用,构成了 REST 接口的网址。例如,根据下表,此示例网址可以分解为以下各个组成部分:

https://googleads.googleapis.com/v24/customers/1234567890:mutate
API 版本前缀 资源名称(相对) 方法
https://googleads.googleapis.com/v24 customers/1234567890 mutate

特定 API 版本(例如 v24)的所有 REST 网址都共享一个通用的 API 版本前缀。资源名称和方法共同标识要调用的 API 服务。

Google Ads API 大量使用 自定义方法,而大多数 REST API 使用标准 REST 方法,例如 listget createupdatedelete。Google Ads API 中的自定义方法示例 包括 searchsearchStreammutate

以下页面将详细介绍 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 格式。