Method: projects.databases.documents.batchWrite

Aplica un lote de operaciones de escritura.

El método document.batchWrite no aplica las operaciones de escritura de forma atómica y puede aplicarlas desordenada. El método no permite más de una operación de escritura por documento. Cada escritura se realiza de manera correcta o falla de forma independiente. Consulta BatchWriteResponse para conocer el estado de éxito de cada escritura.

Si necesitas un conjunto de escrituras aplicado de forma atómica, usa documents.commit en su lugar.

Solicitud HTTP

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

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 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "labels": {
    string: string,
    ...
  }
}
Campos
writes[]

object (Write)

Son las escrituras que se deben aplicar.

El método no aplica escrituras de forma atómica y no garantiza el orden. Cada escritura se realiza de manera correcta o falla de forma independiente. No puedes escribir en el mismo documento más de una vez por solicitud.
labels

map (key: string, value: string)

Etiquetas asociadas con esta escritura por lotes.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Cuerpo de la respuesta

La respuesta de Firestore.BatchWrite.

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

Representación JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "status": [
    {
      object (Status)
    }
  ]
}
Campos
writeResults[]

object (WriteResult)

El resultado de aplicar las escrituras.

Este enésimo resultado de escritura corresponde a la escritura i-ésima de la solicitud.
status[]

object (Status)

El estado de la aplicación de las escrituras.

Este estado de escritura i-ésima es la escritura i-ésima de la solicitud.

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.