Gets a single document.
HTTP request
GET https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*/documents/*/**}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
Required. The resource name of the Document to get. In the format: |
Query parameters
Parameters | |
---|---|
mask |
The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. |
Union parameter consistency_selector . The consistency mode for this transaction. If not set, defaults to strong consistency. consistency_selector can be only one of the following: |
|
transaction |
Reads the document in a transaction. A base64-encoded string. |
readTime |
Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Document
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.