Obtiene un solo documento.
solicitud HTTP
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
La URL utiliza la sintaxis de transcodificación gRPC .
Parámetros de ruta
| Parámetros | |
|---|---|
name | Requerido. El nombre del recurso del documento que se va a obtener. En el formato: |
Parámetros de consulta
| Parámetros | |
|---|---|
mask | Los campos a devolver. Si no se establece, devuelve todos los campos. Si el documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta. |
Parámetro de unión consistency_selector . El modo de coherencia para esta transacción. Si no se establece, el valor predeterminado es una coherencia fuerte. consistency_selector puede ser sólo uno de los siguientes: | |
transaction | Lee el documento en una transacción. Una cadena codificada en base64. |
readTime | Lee la versión del documento en el momento dado. Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si la recuperación de un punto en el tiempo está habilitada, también puede ser una marca de tiempo de un minuto completo dentro de los últimos 7 días. Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de respuesta
Si tiene éxito, el cuerpo de la respuesta contiene una instancia de Document .
Ámbitos de autorización
Requiere uno de los siguientes ámbitos de OAuth:
-
https://www.googleapis.com/auth/datastore -
https://www.googleapis.com/auth/cloud-platform
Para obtener más información, consulte Descripción general de la autenticación .