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

Method: projects.databases.documents.batchGet

Obtiene varios documentos.

No se garantiza que los documentos devueltos por este método se devuelvan en el mismo orden en que se solicitaron.

Solicitud HTTP

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet

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

Parámetros de ruta de acceso

Parámetros

Parámetros
`database`	`string` Obligatorio. Es el nombre de la base de datos. En el formato: `projects/{projectId}/databases/{databaseId}`.

database

string

Obligatorio. Es el nombre de la base de datos. En el formato: projects/{projectId}/databases/{databaseId}.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON

Representación JSON
{ "documents": [ string ], "mask": { object (`DocumentMask`) }, // Union field `consistency_selector` can be only one of the following: "transaction": string, "newTransaction": { object (`TransactionOptions`) }, "readTime": string // End of list of possible types for union field `consistency_selector`. }

{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}

Campos
`documents[]`	`string` Los nombres de los documentos que se recuperarán. En el formato: `projects/{projectId}/databases/{databaseId}/documents/{document_path}`. La solicitud fallará si alguno de los documentos no es un recurso secundario del `database` especificado. Se quitarán los nombres duplicados.
`mask`	`object (DocumentMask)` Los campos que se deben mostrar. Si no se configura, muestra todos los campos. Si un documento tiene un campo que no está presente en esta máscara, ese campo no se mostrará en la respuesta.
Campo 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`	`string (bytes format)` Lee documentos de una transacción. String codificada en base64.
`newTransaction`	`object (TransactionOptions)` Inicia una nueva transacción y lee los documentos. La configuración predeterminada es una transacción de solo lectura. El nuevo ID de transacción se mostrará como la primera respuesta en la transmisión.
`readTime`	`string (Timestamp format)` Lee los documentos tal como estaban en el momento indicado. 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: `"2014-10-02T15:01:23Z"` y `"2014-10-02T15:01:23.045123456Z"`.

Cuerpo de la respuesta

La respuesta transmitida para Firestore.BatchGetDocuments.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON

Representación JSON
{ "transaction": string, "readTime": string, // Union field `result` can be only one of the following: "found": { object (`Document`) }, "missing": string // End of list of possible types for union field `result`. }

{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}

Campos
`transaction`	`string (bytes format)` Indica la transacción que se inició como parte de esta solicitud. Solo se establecerá en la primera respuesta y solo si se configuró `BatchGetDocumentsRequest.new_transaction` en la solicitud. String codificada en base64.
`readTime`	`string (Timestamp format)` Es la hora a la que se leyó el documento. Esto puede aumentar monótonamente. En este caso, se garantiza que los documentos anteriores del flujo de resultados no han cambiado entre su readTime y este. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: `"2014-10-02T15:01:23Z"` y `"2014-10-02T15:01:23.045123456Z"`.
Campo de unión `result`. Un solo resultado. Puede estar vacío si el servidor solo muestra una transacción. Las direcciones (`result`) solo pueden ser una de las siguientes opciones:
`found`	`object (Document)` Un documento que se solicitó.
`missing`	`string` Un nombre de documento que se solicitó, pero que no existe. En el formato: `projects/{projectId}/databases/{databaseId}/documents/{document_path}`.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.