Method: projects.databases.documents.patch

Atualiza ou insere um documento.

Solicitação HTTP

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

A URL usa 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 na máscara pode conter um nome reservado.

Se o documento existir no servidor e possuir campos não referenciados na máscara, eles permanecem inalterados. Os campos referenciados na máscara, mas não presentes no documento de entrada, são excluídos do documento no servidor.

mask

object ( DocumentMask )

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

Caso o documento possua um campo que não esteja presente nesta máscara, esse campo não será retornado na resposta.

currentDocument

object ( Precondition )

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

Solicitar corpo

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

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá uma instância de Document .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .