REST 接口设计

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

面向资源的设计

总体而言,Google Ads 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 服务。

Google Ads API 大量使用自定义方法,与大多数 使用标准 REST 方法的传统 REST API,例如 listgetcreateupdatedelete。Google Ads API 中的自定义方法示例 包括 searchsearchStreammutate

以下网页详细介绍了 Google Ads API 的资源 名称服务方法以及 JSON 命名惯例,说明其使用方法 定义 REST 接口端点。