Search Analytics: query

需要授权

使用您定义的过滤条件和参数查询搜索流量数据。该方法会返回按您定义的行键（维度）分组的零行或多行。您必须将日期范围定义为一天或多天。

如果日期是维度之一，则结果列表中会忽略所有没有数据的日期。如需了解哪些日期有数据，请针对感兴趣的日期范围发出按日期分组且不含过滤条件的查询。

结果按点击次数降序排列。如果两行具有相同的点击次数，则系统会以任意方式对它们进行排序。

如需调用此方法，请参阅 python 示例。

该 API 受 Search Console 内部限制的约束，无法保证返回所有数据行，只能返回主要数据行。

查看可用数据量的限制。

JSON POST 示例： 
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query?key={MY_API_KEY}
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}
立即试用。

请求

HTTP 请求

POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query

参数

参数名称 值 说明
路径参数
siteUrl string Search Console 中定义的资源网址。示例：http://www.example.com/（适用于网址前缀资源）或 sc-domain:example.com（适用于网域资源）

授权

此请求需要获得以下至少一个范围的授权（详细了解身份验证和授权）。

范围
https://www.googleapis.com/auth/webmasters.readonly
https://www.googleapis.com/auth/webmasters

请求正文

在请求正文中，请按以下结构提供数据：

{
  "startDate": string,
  "endDate": string,
  "dimensions": [
    string
  ],
  "type": string,
  "dimensionFilterGroups": [
    {
      "groupType": string,
      "filters": [
        {
          "dimension": string,
          "operator": string,
          "expression": string
        }
      ]
    }
  ],
  "aggregationType": string,
  "rowLimit": integer,
  "startRow": integer
}
属性名称 值 说明 备注
startDate string [必填] 所请求日期范围的开始日期，格式为 YYYY-MM-DD，格式为太平洋时间 (UTC - 7:00/8:00)。不得晚于结束日期。此值包含在范围内。
endDate string [必填] 所请求日期范围的结束日期，采用 YYYY-MM-DD 格式，采用巴西时间 (UTC - 7:00/8:00)。不得早于开始日期。此值包含在范围内。
dimensions[] list [可选] 零个或多个用于对结果进行分组的维度。结果会按您提供这些维度的顺序进行分组。您可以在 dimensionFilterGroups[].filters[].dimension 中使用任何维度名称，以及“日期”。系统会组合分组维度值，为每个结果行创建一个唯一键。如果未指定维度，则所有值都将合并到一行。可以作为分组依据的维度数量没有限制，但是您不能按相同的维度分组两次。示例：[country, device]
searchType string 已废弃，请改用 type
type string [可选] 将结果过滤为以下类型：
  • “discover”：Google 探索结果
  • “googleNews”：来自 news.google.com 以及 Android 和 iOS 版 Google 新闻应用的结果。不包括 Google 搜索的“新闻”标签页中的结果。
  • “news”：来自 Google 搜索“新闻”标签页的搜索结果。
  • “image”：Google 搜索中的“图片”标签页中的搜索结果。
  • “video”：视频搜索结果
  • “web”：[默认] 将结果过滤到 Google 搜索中的“合并”（“全部”）标签页。不包括 Google 探索或 Google 新闻结果。
dimensionFilterGroups[] list [可选] 要应用于维度分组值的一组或多组过滤条件。所有过滤组都必须匹配，系统才会在响应中返回相应行。在单个过滤条件组中，您可以指定是必须满足所有过滤条件，还是至少满足一个过滤条件。
dimensionFilterGroups[].groupType string 此组中的所有过滤器是否都必须返回 true（“与”），还是必须有一个或多个过滤器返回 true（尚不受支持）。

可接受的值：
  • “and”：只有当组中的所有过滤器都返回 true 时，过滤器组才会返回 true。
dimensionFilterGroups[].filters[] list [可选] - 零个或多个过滤条件要针对该行进行测试。每个过滤条件都由维度名称、运算符和值组成。长度上限为 4096 个字符。示例：
country equals FRA
query contains mobile use
device notContains tablet
dimensionFilterGroups[].filters[].dimension string 此过滤条件适用的维度。您可以按此处列出的任何维度进行过滤，即使您并未按该维度进行分组也是如此。

可接受的值包括：
  • “country”：按指定国家/地区进行过滤，国家/地区由 3 个字母的国家/地区代码 (ISO 3166-1 alpha-3) 指定。
  • “device”：根据指定设备类型过滤结果。支持的值：
    • DESKTOP
    • 移动
    • 平板电脑
  • “page”：按指定的 URI 字符串过滤。
  • “query”：按指定的查询字符串过滤。
  • “searchAppearance”：过滤出特定的搜索结果功能。 如需查看可用值的列表，请运行按“searchAppearance”分组的查询。 帮助文档中还提供了值和说明的完整列表。
dimensionFilterGroups[].filters[].operator string [可选] 指定的值必须与行中的维度值如何匹配（或不匹配）。

可接受的值：
  • “contains”：行值必须包含或等于您的表达式（不区分大小写）。
  • “equals”：[默认] 您的表达式必须与行值完全相同（网页和查询维度区分大小写）。
  • “notContains”：行值不得包含您的表达式，无论是作为子字符串还是完全匹配（不区分大小写）。
  • “notEquals”：您的表达式不得与行值完全相同（网页和查询维度区分大小写）。
  • “includingRegex”：必须匹配的 RE2 语法正则表达式。
  • “excludingRegex”：一个 RE2 语法正则表达式，不得匹配。
dimensionFilterGroups[].filters[].expression string 过滤条件要匹配或排除的值（具体取决于运算符）。
aggregationType string

[可选] 数据的汇总方式。如果按资源汇总，系统会汇总同一资源的所有数据；如果按网页汇总，系统会按规范 URI 汇总所有数据。如果您按网页进行过滤或分组，请选择“自动”；否则，您可以按资源或按网页进行汇总，具体取决于您希望如何计算数据；请参阅帮助文档，了解按网站和按网页计算数据的不同之处。

注意：如果您按网页进行分组或过滤，则无法按资源进行汇总。

如果您指定 auto 以外的任何值，则结果中的汇总类型将与请求的类型匹配；如果您请求的类型无效，则会收到错误。如果请求的类型无效，API 绝不会更改您的汇总类型。

可接受的值包括：
  • “auto”：[默认] 让服务决定适当的汇总类型。
  • “byNewsShowcasePanel”：按 Google 新闻编辑精选面板对值进行汇总。 此过滤条件必须与 NEWS_SHOWCASE searchAppearance 过滤条件以及 type=discover 或 type=googleNews 结合使用。如果您按网页分组、按网页过滤或过滤到其他 searchAppearance，则无法按 byNewsShowcasePanel 汇总。
  • “byPage”：按 URI 汇总值。
  • “byProperty”：按属性汇总值。不支持 type=discover 或 type=googleNews
rowLimit integer [可选；有效范围为 1-25,000；默认值为 1,000] 要返回的行数上限。如需对结果进行分页，请使用 startRow 偏移量。
startRow integer [可选；默认值为 0] 响应中第一行的索引（从零开始）。必须为非负数。如果 startRow 超过查询的结果数，则响应将是成功响应，且行数为零。
dataState string [可选] 如果为“all”（不区分大小写），则数据将包含新鲜数据。 如果为“final”（不区分大小写）或省略此参数，返回的数据将只包含最终数据。

响应

系统会根据请求中指定的维度对结果进行分组。包含同一组维度值的所有值都会归为一行。例如，如果您按国家/地区维度进行分组，则“usa”的所有结果将归为一组，“mdv”的所有结果也将归为一组，以此类推。如果您按国家/地区和设备进行分组，则“美国、平板电脑”下的所有结果将被分组，“美国、移动设备”下的所有结果也将被分组，以此类推。请参阅“搜索分析”报告文档，详细了解点击次数、展示次数等指标的计算方式及其含义。

除非您按日期对结果进行分组，否则系统会按日期升序（由旧到新，由新到旧）对结果进行排序。如果两行相等，则排序顺序为任意顺序。

如需了解可以返回的值的数量上限，请参阅请求中的 rowLimit 属性。

{
  "rows": [
    {
      "keys": [
        string
      ],
      "clicks": double,
      "impressions": double,
      "ctr": double,
      "position": double
    }
  ],
  "responseAggregationType": string
}
属性名称 值 说明 备注
rows[] list 按查询中指定的顺序按键值分组的行列表。
rows[].keys[] list 相应行的维度值列表，根据请求中的维度分组，按照请求中指定的顺序。
rows[].clicks double 点击相应行的计数。
rows[].impressions double 相应行的展示次数。
rows[].ctr double 相应行的点击率 (CTR)。值的范围为 0 到 1.0（包括这两个数值）。
rows[].position double 搜索结果中的平均排名。
responseAggregationType string 结果的汇总方式。请参阅帮助文档，了解按网站与按网页计算数据的不同之处。

可接受的值：
  • “auto”
  • “byPage”：结果按网页汇总。
  • “byProperty”：结果按媒体资源汇总。

试试看！

使用下面的 API Explorer 对实际数据调用此方法，然后查看响应。