Esta página se ha traducido con Cloud Translation API.

Method: projects.databases.documents.batchGet

Obtiene múltiples documentos.

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

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros

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

database

string

Requerido. 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 a recuperar. En el formato: `projects/{projectId}/databases/{databaseId}/documents/{document_path}` . La solicitud fallará si alguno de los documentos no es un recurso secundario de la `database` dada. Se eliminarán los nombres duplicados.
`mask`	`object ( DocumentMask )` Los campos a devolver. Si no se establece, devuelve todos los campos. Si un documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta.
`consistency_selector` del campo de unión. 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`	`string ( bytes format)` Lee documentos en una transacción. Una cadena codificada en base64.
`newTransaction`	`object ( TransactionOptions )` Inicia una nueva transacción y lee los documentos. El valor predeterminado es una transacción de solo lectura. El nuevo ID de transacción se devolverá como primera respuesta en la secuencia.
`readTime`	`string ( Timestamp format)` Lee documentos tal como estaban 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: `"2014-10-02T15:01:23Z"` y `"2014-10-02T15:01:23.045123456Z"` .

Cuerpo de respuesta

La respuesta transmitida para Firestore.BatchGetDocuments .

Si tiene éxito, el cuerpo de la respuesta contiene 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)` La transacción que se inició como parte de esta solicitud. Solo se establecerá en la primera respuesta y solo si `BatchGetDocumentsRequest.new_transaction` se configuró en la solicitud. Una cadena codificada en base64.
`readTime`	`string ( Timestamp format)` Hora a la que se leyó el documento. Esto puede estar aumentando monóticamente; en este caso, se garantiza que los documentos anteriores en el flujo de resultados no habrán cambiado entre su tiempo de lectura y este. 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"` .
`result` de campo de la Unión. Un solo resultado. Puede estar vacío si el servidor simplemente devuelve una transacción. `result` puede ser sólo uno de los siguientes:
`found`	`object ( Document )` Un documento que fue solicitado.
`missing`	`string` Un nombre de documento que se solicitó pero no existe. En el formato: `projects/{projectId}/databases/{databaseId}/documents/{document_path}` .

Á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 .