Method: projects.databases.documents.patch

Actualiza o inserta un documento.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

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 que se actualizarán. 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 borran del documento en el servidor.
mask

object (DocumentMask)

Los campos que se deben mostrar. Si no se configura, muestra todos los campos.

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

object (Precondition)

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

Cuerpo de la solicitud

El cuerpo de la solicitud incluye una instancia de Document.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Document.

Permisos de autorización

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