本页面假定您熟悉面向资源的设计和资源名称开发者指南,并在这些指南的基础上补充了 Google Ads API 的具体实现细节。
面向资源的设计
通常,Google Ads API 遵循以资源为导向的设计,被构建为可单独寻址的“资源”(API 中的“名词”)的“集合”。资源通过其资源名称被引用,并使用一组方法(也称为“动词”或“操作”)进行控制。
这些资源名称和方法与特定的 API 版本前缀组合在一起,构成了 REST 接口的网址。例如,以下网址可以根据下表拆分为以下各个组成部分:
https://googleads.googleapis.com/v18/customers/1234567890:mutate
API 版本前缀 | 资源名称(相对) | 方法 |
---|---|---|
https://googleads.googleapis.com/v18
|
customers/1234567890
|
mutate
|
特定 API 版本的所有 REST 网址(例如v18
)共享一个通用的 API 版本前缀。资源名称和方法共同用于标识要调用的 API 服务。
Google Ads API 大量使用自定义方法,而大多数传统 REST API 使用标准 REST 方法(例如 list
、get
、create
、update
和 delete
)。Google Ads API 中的自定义方法示例包括 search
、searchStream
和 mutate
。
以下页面详细介绍了 Google Ads API 的资源名称、服务方法和 JSON 命名惯例,以说明如何将它们结合使用来定义 REST 接口端点。