REST 接口设计

本页假定您熟悉面向资源的设计资源名称开发者指南,并补充了这些指南的具体 Search Ads 360 Reporting API 实现细节。

面向资源的设计

通常,Search Ads 360 Reporting API 采用以资源为导向的设计,建模为可单独寻址的资源(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 API 使用 listget 等标准 REST 方法。Search Ads 360 Reporting API 包含两种自定义方法:searchsearchStream

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