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