Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Método: projects.databases.documents.get

Obtiene un solo documento.

Solicitud HTTP

GET https://firestore.googleapis.com/v1beta1/{name=projects/*/databases/*/documents/*/**}

La URL utiliza la sintaxis de transcodificación de gRPC .

Parámetros de ruta

Parámetros
name

string

Necesario. El nombre del recurso del documento para obtener. En el formato: projects/{project_id}/databases/{database_id}/documents/{document_path} .

Parámetros de consulta

Parámetros
mask

object ( DocumentMask )

Los campos para volver. 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 consistencia fuerte. consistency_selector puede ser solo uno de los siguientes:
transaction

string ( bytes format)

Lee el documento en una transacción.

Una cadena codificada en base64.

readTime

string ( Timestamp format)

Lee la versión del documento en el momento dado. Esto no puede ser anterior a 270 segundos.

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

Cuerpo de solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de respuesta

Si tiene éxito, el cuerpo de 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 la Descripción general de la autenticación .