获取单个文档。
HTTP请求
GET https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*/documents/*/**}
URL 使用gRPC 转码语法。
路径参数
参数 | |
---|---|
name | 必需的。要获取的文档的资源名称。格式为: |
查询参数
参数 | |
---|---|
mask | 要返回的字段。如果未设置,则返回所有字段。 如果文档具有此掩码中不存在的字段,则该字段将不会在响应中返回。 |
联合参数consistency_selector 。此事务的一致性模式。如果不设置,默认为强一致性。 consistency_selector 只能是以下之一: | |
transaction | 在事务中读取文档。 Base64 编码的字符串。 |
readTime | 读取给定时间的文档版本。 这必须是过去一小时内的微秒精度时间戳,或者如果启用了时间点恢复,则还可以是过去 7 天内的整分钟时间戳。 RFC3339 UTC“Zulu”格式的时间戳,具有纳秒分辨率和最多九个小数位。示例: |
请求正文
请求正文必须为空。
响应体
如果成功,响应正文将包含Document
的实例。
授权范围
需要以下 OAuth 范围之一:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
有关详细信息,请参阅身份验证概述。