概览

报告 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 日期间,其所有目标平台上的所有商品的总点击次数总计为 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"
      }
    }
]}