效果提示

JSON

以下示例显示的是将 fields 参数与通用（虚构的）“Demo”API 结合使用的情况。

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

https://www.googleapis.com/demo/v1

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

{
  "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?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?fields=kind,items(title,characteristics/length)

部分响应如下所示：

200 OK

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

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

Atom

Google Content API for Shopping 不支持 Atom 数据格式。