概览

报告 API

利用 Reporting API，商家可以通过 Merchant Center 查询语言，以编程方式与效果数据进行互动。这与直接在 Merchant Center 中创建自定义报告的功能类似。Reporting API 具有以下优势：

  • 让大型商家可以将商品详情的效果数据导入到其内部或第三方报告系统中。
  • 允许管理 Merchant Center 账号的用户、第三方合作伙伴和集合商家访问报告。

API 用户可以指定要在搜索调用响应中检索的性能数据，例如：

  • 要返回的指标（例如：点击次数、展示次数）
  • 数据细分维度（例如：OfferId、Date）
  • 需要满足的条件（例如：点击次数 > 100）

Reporting API 查询语言可以在 Reports 服务上使用 Search 方法查询 Content API for Shopping 的效果指标（点击次数、展示次数），这些指标可能按各种维度（节目和日期等报告的事件属性，以及品牌、类别等商品属性等）进行细分。

对 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_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 日不会返回任何对象，因为商家在 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"
      }
    }
]}