标准字段

本节介绍了需要类似概念时应使用的一组标准消息字段定义。这将确保相同的概念在不同 API 中具有相同的名称和语义。

名称 类型 说明
name string name 字段应包含相对资源名称
parent string 对于资源定义和 List/Create 请求,parent 字段应包含父级相对资源名称
create_time Timestamp 创建实体的时间戳。
update_time Timestamp 最后更新实体的时间戳。注意:执行 create/patch/delete 操作时会更新 update_time。
delete_time Timestamp 删除实体的时间戳,仅当它支持保留时才适用。
expire_time Timestamp 实体到期时的到期时间戳。
start_time Timestamp 标记某个时间段开始的时间戳。
end_time Timestamp 标记某个时间段或操作结束的时间戳(无论其成功与否)。
read_time Timestamp 应读取(如果在请求中使用)或已读取(如果在响应中使用)特定实体的时间戳。
time_zone string 时区名称。它应该是 IANA TZ 名称,例如“America/Los_Angeles”。如需了解详情,请参阅 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones。
region_code string 位置的 Unicode 国家/地区代码 (CLDR),例如“US”和“419”。如需了解详情,请访问 http://www.unicode.org/reports/tr35/#unicode_region_subtag。
language_code string BCP-47 语言代码,例如“en-US”或“sr-Latn”。如需了解详情,请参阅 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。
mime_type string IANA 发布的 MIME 类型(也称为媒体类型)。如需了解详情,请参阅 https://www.iana.org/assignments/media-types/media-types.xhtml。
display_name string 实体的显示名称。
title string 实体的官方名称,例如公司名称。它应被视为 display_name 的正式版本。
description string 实体的一个或多个文本描述段落。
filter string List 方法的标准过滤器参数。
query string 如果应用于搜索方法(即 :search),则与 filter 相同。
page_token string List 请求中的分页令牌。
page_size int32 List 请求中的分页大小。
total_size int32 列表中与分页无关的项目总数。
next_page_token string List 响应中的下一个分页令牌。它应该用作后续请求的 page_token。空值表示不再有结果。
order_by string 指定 List 请求的结果排序。
request_id string 用于检测重复请求的唯一字符串 ID。
resume_token string 用于恢复流式传输请求的不透明令牌。
labels map<string, string> 表示 Cloud 资源标签。
show_deleted bool 如果资源允许恢复删除行为,相应的 List 方法必须具有 show_deleted 字段,以便客户端可以发现已删除的资源。
update_mask FieldMask 它用于 Update 请求消息,该消息用于对资源执行部分更新。此掩码与资源相关,而不是与请求消息相关。
validate_only bool 如果为 true,则表示仅应验证给定请求,而不执行该请求。

系统参数

除标准字段外,Google API 还支持可以在所有 API 方法中使用的一组共同请求参数,这些参数称为“系统参数”。如需了解详情,请参阅系统参数