选择要返回的字段

调用 ComputeRoutes() 方法时,您必须指定要在响应中返回的字段。您可以通过使用响应字段掩码(通过网址参数 $fieldsfields 提供)或使用 HTTP/gRPC 标头 X-Goog-FieldMask 来实现此目的。如需了解详情,请参阅系统参数

字段掩码

字段掩码值是字段路径的逗号分隔列表。每个字段路径都是表示消息层次结构的以英文句点分隔的字段名称列表。字段名称可以是 JSON 对象键,也可以是 protobuf 字段标记名称。字段路径从顶级响应消息类型开始,后跟一个或多个点(可选),然后是下一级字段名称。一般来说,字段路径的构建方式如下:

topLevelField[.secondLevelField][.thirdLevelField][...]

特殊情况字段掩码是通配符“*”,用于选择所有根级字段。

示例

以下示例演示了如何为 ComputeRoutes() 方法设置字段掩码。

示例 1

所有可用字段的字段掩码(用于手动检查)。

X-Goog-FieldMask: *

示例 2

路线级时长、距离和多段线的字段掩码(生产环境设置示例)。

X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline

我们不建议使用通配符 (*) 响应字段掩码,也不建议在生产中的顶级(路由)指定字段掩码。仅选择所需的字段:

  • 允许我们的服务器节省处理周期,从而以更低的延迟返回结果。

  • 确保稳定的延迟时间性能。我们未来可能会添加更多响应字段,而这些新字段可能需要额外的计算时间。如果您选择所有字段,或选择所有顶级字段,则可能会出现性能下降的情况,因为我们添加的任何新字段都会自动包含在您的响应中。

  • 这会导致响应大小变小,从而提高网络吞吐量。

如需详细了解如何构建字段路径,请参阅 field_mask.proto