获取单个文档。
HTTP 请求
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
网址采用 gRPC 转码语法。
路径参数
| 参数 | |
|---|---|
name |
必需。要获取的文档的资源名称。格式为： |
查询参数
| 参数 | |
|---|---|
mask |
要返回的字段。如果未设置，则返回所有字段。 如果文档中某个字段不在此掩码中，则不会在响应中返回该字段。 |
联合参数 consistency_selector。此事务的一致性模式。如果未设置，则默认为强一致性。consistency_selector 只能是下列其中一项： |
|
transaction |
在事务中读取文档。 使用 base64 编码的字符串。 |
readTime |
读取指定时间的文档版本。 此时间戳必须是过去一小时内的微秒级精确时间戳；如果启用了时间点恢复，也可以是过去 7 天内的整分钟时间戳。 采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式的时间戳，采用纳秒级精度，最多包含九个小数位。示例： |
请求正文
请求正文必须为空。
响应正文
如果成功，则响应正文包含一个 Document 实例。
授权范围
需要以下 OAuth 范围之一：
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
如需了解详情，请参阅身份验证概览。