Method: projects.databases.documents.batchGet

Obtiene varios documentos.

No se garantiza que los documentos que muestra 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
database

string

Obligatorio. 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 
{
  "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 determinado. Se omitirán los nombres duplicados.
mask

object (DocumentMask)

Los campos que se mostrarán. Si no está configurado, 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 de esta transacción. Si no está configurado, se establece de forma predeterminada en la coherencia sólida. consistency_selector puede ser solo uno de los siguientes:
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 un momento determinado.

Debe ser una marca de tiempo con precisión de microsegundos dentro de la última hora o, si se habilitó 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 una 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 contiene datos con la siguiente estructura:

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.
}
Campos
transaction

string (bytes format)

Es la transacción que se inició como parte de esta solicitud. Solo se configurará en la primera respuesta y solo si se configuró BatchGetDocumentsRequest.new_transaction en la solicitud.

String codificada en base64.
readTime

string (Timestamp format)

Indica la hora a la que se leyó el documento. Esto puede aumentar de forma monótona; en este caso, se garantiza que los documentos anteriores en la transmisión de resultados no hayan cambiado entre su readTime y este.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una 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. result puede ser solo uno de los siguientes:
found

object (Document)

Un documento que se solicitó.
missing

string

Un nombre de documento que se solicitó, pero no existe. En el formato projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.