概览

报告 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 表示您在查询中指定的细分所请求的指标的值。如果未指定细分，则返回单个行，其中包含所有细分的指标。否则，如果随指标一起请求任何细分，则响应会为每个唯一细分元组显示一行。您可以在单个查询中选择多个细分和多个指标。

查询指标

您可以查询要返回的指标（点击次数、展示次数、点击率等）。您必须添加日期范围过滤器，才能查询报告服务。下面的示例查询会返回一行数据：一个日期范围内已添加条件的点击总数。

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

响应示例

以下 JSON 代码响应示例显示了，在 2020 年 12 月 1 日至 2020 年 12 月 21 日期间，此商家如何在其所有平台上将 4440 次点击加在一起。

{"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"
      }
    }
]}