Reporting API
Reporting API 可讓商家透過 Merchant Center 查詢語言,以程式輔助方式與成效資料互動。這項功能與直接在 Merchant Center 中建立自訂報表的功能類似。Reporting API 有以下優點:
- 可讓大型商家將產品資訊的成效資料匯入內部或第三方報表系統。
- 允許管理 Merchant Center 帳戶的使用者、第三方合作夥伴和集結網站存取報表。
API 使用者可以在 Search 呼叫回應中指定想要擷取的效能資料,例如:
- 要傳回的指標 (例如:點擊、曝光)
- 用來區隔資料的維度 (例如:OfferId、Date)
- 必須符合的條件 (例如:點擊次數大於 100)
Reporting API 查詢語言可查詢 Content API for Shopping,以便取得成效指標 (點擊、曝光),且可能按照各種維度 (例如節目和日期等報表的事件屬性,以及品牌、類別等產品屬性) 進行區隔,並在 Reports
服務上使用 Search
方法。
對 Reports
服務的查詢傳回的結果是 ReportRow
執行個體清單,每個 ReportRow
都代表您在查詢中指定的區隔要求指標的值。如果未指定區隔,系統會傳回單一資料列,並顯示跨所有區隔匯總的指標。否則,如果與指標一併要求任何區隔,則回應會顯示每個不重複的區隔元組。您可以在單一查詢中選取多個區隔和多個指標。
查詢指標
您可以查詢要傳回的指標 (點擊、曝光、點閱率等)。您必須在日期範圍新增篩選器,才能查詢報表服務。下方的查詢範例會傳回單一資料列:在指定日期範圍內新增條件內的點擊次數匯總值。
SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';
回應範例
下方 JSON 程式碼回應範例顯示此商家在 2020 年 12 月 1 日至 2020 年 12 月 21 日期間,所有自有目的地中,共獲得 4,440 次點擊。
{"results": [
{
"metrics": {
"clicks": "4,440"
}
}
]}
查詢區隔
除了指標以外,您也可以查詢區隔,這可以是產品的屬性 (offer_id
、brand
、category
等),或報告事件的屬性 (date
、program
)。回報的事件指的是產品的曝光或點擊。
區隔的運作方式與 SQL 中的 GROUP BY
類似。區隔會劃分所選指標,並以 SELECT
子句中的每個區隔分組。下方的查詢範例每天傳回點擊次數,並按照在日期範圍內新增的條件遞減排序。系統只會傳回至少一個要求指標非零的資料列。
SELECT
segments.date,
metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;
回應範例
下方 JSON 程式碼回應範例顯示此商家在 2020 年 12 月 1 日和所有目的地中,於 2020 年 12 月 2 日所有目的地獲得 829 次點擊。由於商家當天未獲得任何點擊,因此 2020 年 12 月 3 日不會傳回任何物件。
{
"results": [
{
"segments": {
"date": {
"year": 2020,
"month": 12,
"day": 1
}
},
"metrics": {
"clicks": "1546"
}
},
{
"segments": {
"date": {
"year": 2020,
"month": 12,
"day": 2
}
},
"metrics": {
"clicks": "829"
}
}
]}