Reporting API

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

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

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

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

报告 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 日没有获得任何点击，因此不会返回任何对象。

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}
下一页
查询语法