Obtiene un solo documento.
Solicitud HTTP
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
| Parámetros | |
|---|---|
name |
Obligatorio. El nombre de recurso del documento que se obtendrá. En el formato: |
Parámetros de consulta
| Parámetros | |
|---|---|
mask |
Los campos que se deben mostrar. Si no se configura, muestra todos los campos. Si el documento tiene un campo que no está presente en esta máscara, ese campo no se mostrará en la respuesta. |
Es el parámetro de unión consistency_selector. El modo de coherencia para esta transacción. Si no está configurado, se establece de forma predeterminada para una coherencia sólida. Las direcciones (consistency_selector) solo pueden ser una de las siguientes opciones: |
|
transaction |
Lee el documento en una transacción. String codificada en base64. |
readTime |
Lee la versión del documento en un momento determinado. Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si está habilitada la recuperación de un momento determinado, 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 “Zulú”, 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 la respuesta
Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Document.
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
Para obtener más información, consulta Descripción general de la autenticación.