性能提示

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

本文介绍了一些您可以用来提高应用性能的技术。在某些情况下,我们会使用其他 API 或通用 API 中的示例来解释所给出的观点。不过,其中的概念对于 Google Analytics(分析)API 也同样适用。

使用 gzip

要降低单个请求的带宽需求,您可以选择启用 gzip 压缩,这是一种既方便又简单的方法。虽然这种方法需要一些额外的 CPU 时间对结果进行解压缩,但考虑到它对节约网络费用的贡献,通常还是值得一用的。

要接收 gzip 编码的响应,您必须执行以下两项操作:设置 Accept-Encoding 标头,并且修改您的用户代理以包含字符串 gzip。下面提供了一个用于启用 gzip 压缩的格式正确的 HTTP 标头示例:

Accept-Encoding: gzip
User-Agent: my program (gzip)

处理部分资源

提高 API 调用性能的另一个方法是只请求您感兴趣的那部分数据。这样可使您的应用避免传输、解析和存储不需要的字段,以便其可以更有效地使用包括网络、CPU 和内存在内的资源。

部分响应

默认情况下,服务器在处理请求之后会发回资源的完整表述。为实现最佳性能,您可以要求服务器仅发送您真正需要的字段,并且接收部分响应。

要请求部分响应,请使用 fields 请求参数来指定您希望返回的字段。您可以在任何会返回响应数据的请求中使用此参数。

示例

以下示例显示的是 fields 参数与常规(虚构)“Demo”API 配合使用的情况。

简单请求:下面的HTTP GET请求省略了fields参数,因而会返回完整资源。

https://www.googleapis.com/demo/v1?key=YOUR-API-KEY

完整资源响应:完整资源数据包括以下字段以及其他许多字段(为简便起见,此处省略了那些字段)。

{
  "kind": "demo",
  ...
  "items": [
  {
    "title": "First title",
    "comment": "First comment.",
    "characteristics": {
      "length": "short",
      "accuracy": "high",
      "followers": ["Jo", "Will"],
    },
    "status": "active",
    ...
  },
  {
    "title": "Second title",
    "comment": "Second comment.",
    "characteristics": {
      "length": "long",
      "accuracy": "medium"
      "followers": [ ],
    },
    "status": "pending",
    ...
  },
  ...
  ]
}

部分响应请求:同样针对这项资源的以下请求使用了fields参数,大大减少了所返回的数据量。

https://www.googleapis.com/demo/v1?key=YOUR-API-KEY&fields=kind,items(title,characteristics/length)

部分响应:服务器为响应上述请求而发回的响应只包含类型信息和一个简化的 items 数组,该数组中的每个项目只包含 HTML 标题和长度特征信息。

200 OK

{
  "kind": "demo",
  "items": [
  {
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  },
  {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]

请注意,该响应是一个只包括所选字段及其所属父对象的 JSON 对象。

下面将首先讲述有关 fields 参数格式的详情,然后会详细介绍响应中所返回的确切对象。

Fields 参数语法概述

fields 请求参数值的格式大致上基于 XPath 语法。支持的语法总结如下,另外下一节还将提供更多示例。

  • 使用以逗号分隔的列表来选择多个字段。
  • 使用 a/b 选择嵌套在字段 a 内的字段 b;使用 a/b/c 选择嵌套在 b 内的字段 c

    例外情况:在使用“data”封装容器的 API 响应中(响应嵌套在 data 对象内,例如 data: { ... }),不要在 fields 规范内包含“data”。在 fields 规范中加入类似 data/a/b 的 data 对象会引发错误。所以,应该使用 a/b 形式的 fields 规范。

  • 通过将表达式放在圆括号“( )”内,使用子选择器请求数组或对象的一组特定子字段。

    例如:fields=items(id,author/email) 只会返回 items 数组中每个元素的项目 ID 和作者的电子邮件。您也可以指定单个子字段,这种情况下 fields=items(id) 等同于 fields=items/id

  • 如果需要,可在选择字段时使用通配符。

    例如:使用 fields=items/pagemap/* 可选择 pagemap 中的所有对象。

有关使用 fields 参数的更多示例

以下示例包含关于 fields 参数值如何影响响应的说明。

注意:与所有查询参数值一样,fields 参数值也必须经过网址编码。为了便于阅读,本文中的示例省略了编码。

指定您想返回的字段,或者进行字段选择
fields 请求参数值是以逗号分隔的字段列表,并且每个字段是根据响应的根指定的。因此,如果您执行的是 list 操作,则响应是一个集合,并且通常包含一组资源。如果您执行的是返回单一资源的操作,则字段是根据该资源来指定。如果您选择的字段是(或属于)一个数组,则服务器会返回数组中所有元素的选定部分。

以下是一些集合级别的示例:
示例 结果
items 返回 items 数组中的所有元素,包括每个元素中的所有字段,但不包括其他字段。
etag,items 同时返回 etag 字段和 items 数组中的所有元素。
items/title 仅返回 items 数组中所有元素的 title 字段。

每当返回嵌套字段时,响应中均包括该字段的父对象。父级字段不会包括其他任何子字段(除非已明确选择)。
context/facets/label 仅返回 facets 数组中所有元素的 label 字段,而该数组本身嵌套在 context 对象之下。
items/pagemap/*/title 对于 items 数组中的每个元素,仅返回 pagemap 的所有子对象的 title 字段(如果存在)。

以下是一些资源级别的示例:
示例 结果
title 返回所请求资源的 title 字段。
author/uri 返回所请求资源中 author 对象的 uri 子字段。
links/*/href
返回 links 的所有子对象的 href 字段。
使用“子选择”仅请求特定字段的相关部分
默认情况下,如果您的请求指定具体字段,则服务器会返回全部对象或数组元素。您可以指定一个仅包含某些子字段的响应。如下所示,您可以使用“( )”子选择语法实现此目标。
示例 结果
items(title,author/uri) 仅返回 items 数组中每个元素的 title 和作者 uri 的值。

处理部分响应

服务器处理完包含 fields 查询参数的有效请求之后,会发回 HTTP 200 OK 状态代码以及所请求的数据。如果 fields 查询参数出现错误或因其他原因而无效,服务器将返回 HTTP 400 Bad Request 状态代码以及一条错误消息,告知用户他们的字段选择出现了什么错误(例如 "Invalid field selection a/b")。

以下是上文简介部分所提到的部分响应的示例。该请求使用 fields 参数来指定要返回的字段。

https://www.googleapis.com/demo/v1?key=YOUR-API-KEY&fields=kind,items(title,characteristics/length)

部分响应如下所示:

200 OK

{
  "kind": "demo",
  "items": [
  {
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  },
  {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]

注意:对于支持数据分页查询参数(例如 maxResultsnextPageToken)的 API,请使用这些参数将每个查询的结果减少到便于管理的数量。否则,可能无法实现本应通过部分响应获得的性能提升。