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 方法 (例如 listget) 的傳統 REST API。Search Ads 360 Reporting API 提供兩種自訂方法:searchsearchStream

以下頁面將進一步說明 Search Ads 360 Reporting API 的資源名稱服務方法JSON 命名慣例,並說明我們將如何透過這些名稱定義 REST 介面端點。