Reporting API
Reporting API 可讓商家透過 Merchant Center 查詢語言,以程式輔助方式與成效資料互動。這與直接在 Merchant Center 中建立自訂報表的功能類似。Reporting API 的優點如下:
- 可讓大型商家將產品資訊的效能資料匯入內部或第三方報表系統。
- 允許管理 Merchant Center 帳戶的使用者、第三方合作夥伴和集結網站存取報表。
API 使用者可以指定要在 Search 呼叫回應中擷取哪些效能資料,例如:
- 要傳回的指標 (例如:點擊次數、曝光次數)
- 用來區隔資料的維度 (例如:OfferId、Date)
- 必須符合的條件 (例如:點擊次數 > 100)
Reporting API 查詢語言可以透過 Reports
服務的 Search
方法,查詢 Content API for Shopping 的成效指標 (點擊次數、曝光次數),並可能會依各種維度區隔 (記錄的事件屬性 (如計畫和日期),以及品牌、類別等的產品屬性) 的區隔結果。
查詢 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 日當天,在各個目的地的所有產品中獲得 1,546 次點擊,並在 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"
}
}
]}