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