Method: projects.databases.documents.patch

Actualiza o inserta un documento.

solicitud HTTP

PATCH https://firestore.googleapis.com/v1beta1/{document.name=projects/*/databases/*/documents/*/**}

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
document.name

string

El nombre del recurso del documento, por ejemplo projects/{projectId}/databases/{databaseId}/documents/{document_path} .

Parámetros de consulta

Parámetros
updateMask

object ( DocumentMask )

Los campos a actualizar. Ninguna de las rutas de campo de la máscara puede contener un nombre reservado.

Si el documento existe en el servidor y tiene campos a los que no se hace referencia en la máscara, no se modifican. Los campos a los que se hace referencia en la máscara, pero que no están presentes en el documento de entrada, se eliminan del documento en el servidor.

mask

object ( DocumentMask )

Los campos a devolver. Si no se establece, devuelve todos los campos.

Si el documento tiene un campo que no está presente en esta máscara, ese campo no se devolverá en la respuesta.

currentDocument

object ( Precondition )

Una condición previa opcional en el documento. La solicitud fallará si esto se establece y el documento de destino no lo cumple.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Document .

Cuerpo de respuesta

Si tiene éxito, el cuerpo de la respuesta contiene una instancia de Document .

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