本页面假定您熟悉面向资源的设计和资源名称开发者指南,并在这些指南中补充了 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 版本(例如,v0
)共用一个通用的 API 版本前缀。资源名称和方法共同标识了正在调用的 API 服务。
与使用标准 REST 方法(如 list
和 get
)的大多数传统 REST API 相反,Search Ads 360 Reporting API 大量使用自定义方法。Search Ads 360 Reporting API 包含两种自定义方法:search
和 searchStream
。
以下页面将详细介绍 Search Ads 360 Reporting API 的资源名称、服务方法和 JSON 命名惯例,并说明如何结合使用它们来定义 REST 接口端点。