Method: projects.databases.documents.patch

Atualiza ou insere um documento.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
document.name

string

O nome do recurso do documento, por exemplo, projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Parâmetros de consulta

Parâmetros
updateMask

object (DocumentMask)

Os campos a serem atualizados. Nenhum dos caminhos de campo da máscara pode conter um nome reservado.

Se o documento existir no servidor e tiver campos não referenciados na máscara, eles não serão alterados. Os campos referenciados na máscara, mas ausentes no documento de entrada, são excluídos do documento no servidor.
mask

object (DocumentMask)

Os campos a serem retornados. Se não definido, retorna todos os campos.

Se o documento tiver um campo ausente nessa máscara, esse campo não será retornado na resposta.
currentDocument

object (Precondition)

Uma condição prévia opcional no documento. A solicitação falhará se isso for definido e não for atendido pelo documento de destino.

Corpo da solicitação

O corpo da solicitação contém uma instância de Document.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Document.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para saber mais, consulte a Visão geral da autenticação.