Reporting API

商家可透過 Reporting API,使用 Merchant Center 查詢語言以程式輔助方式存取成效資料。這與直接在 Merchant Center 中建立自訂報表的功能類似。Reporting API 的優點如下:

  • 大型商家可將產品資訊的成效資料匯入內部或第三方報表系統。
  • 允許管理 Merchant Center 帳戶的使用者、第三方合作夥伴和匯總工具存取報表。

API 使用者可以在 Search 呼叫回應中指定要擷取的成效資料,例如:

  • 要傳回的指標 (例如:點擊次數、曝光次數)
  • 用來區隔資料的維度 (例如:OfferId、Date)
  • 需要符合的條件 (例如:點擊次數 > 100)

報表 API 查詢語言可查詢 Content API for Shopping 的成效指標 (點擊次數、曝光次數),並可能使用各種維度 (例如計畫和日期等回報的事件屬性,以及品牌和類別等產品屬性) 進行區隔,方法是在 Reports 服務上使用 Search 方法。

Reports 服務進行查詢後,會傳回 ReportRow 執行個體清單,每個 ReportRow 代表您在查詢中指定的區隔所對應的要求指標值。如未指定任何區隔,系統會傳回單一資料列,其中包含所有區隔的匯總指標。否則,如果要求任何區隔和指標,回應會針對每個不重複的區隔元組顯示一列。您可以在單一查詢中選取多個區隔和多個指標。

查詢指標

您可以查詢要傳回的指標 (點擊次數、曝光次數、點閱率等)。您必須新增日期範圍的篩選器,才能查詢 Reports 服務。下列查詢範例會傳回單一資料列:日期範圍內點擊次數的總和。

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_idbrandcategory 等),或是已回報事件的屬性 (dateprogram)。已回報事件是指產品的曝光或點擊。

區隔的運作方式與 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"
      }
    }
]}