REST 接口设计

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

面向资源的设计

通常,Search Ads 360 Reporting API 采用以资源为导向的设计,建模为 可单独寻址的资源(API 的名词)的集合。 资源通过其资源名称进行引用,并使用小型 一组方法(也称为动词操作)。

这些资源名称方法组合在一起 包含 REST 接口的网址。 例如,以下网址可分为各个部分 (如下表所示):

https://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
API 版本前缀 资源名称(相对名称) 方法
https://searchads360.googleapis.com/v0 customers/1234567890 search

特定 API 版本的所有 REST 网址(例如,v0) 具有一个通用的 API 版本前缀。资源名称和方法结合使用 标识正在调用的 API 服务。

Search Ads 360 Reporting API 大量使用了自定义方法,与大多数 使用标准 REST 方法的传统 REST API,例如 listget。Search Ads 360 Reporting API 包含两个自定义方法:searchsearchStream

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