Method: projects.databases.documents.commit

Confirma una transacción y, de forma opcional, actualiza documentos.

Solicitud HTTP

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

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)
    }
  ],
  "transaction": string
}
Campos
writes[]

object (Write)

Son las escrituras que se deben aplicar.

Siempre se ejecuta de forma atómica y en orden.
transaction

string (bytes format)

Si se configura, aplica todas las operaciones de escritura en esta transacción y la confirma.

String codificada en base64.

Cuerpo de la respuesta

La respuesta para Firestore.Commit.

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

Representación JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
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.
commitTime

string (Timestamp format)

La hora a la que se produjo la confirmación. Se garantiza que cualquier lectura con un readTime igual o mayor verá los efectos de la confirmación.

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

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.