本页假定您熟悉面向资源的 API 设计和资源名称开发者指南,并以 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 版本(例如 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 格式。