Method: projects.databases.documents.patch

Aktualisiert oder fügt ein Dokument ein.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
document.name

string

Der Ressourcenname des Dokuments, z. B. projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Abfrageparameter

Parameter
updateMask

object (DocumentMask)

Die zu aktualisierenden Felder. Keiner der Feldpfade in der Maske darf einen reservierten Namen enthalten.

Wenn das Dokument auf dem Server vorhanden ist und Felder enthält, auf die in der Maske nicht verwiesen wird, bleiben diese unverändert. Felder, auf die in der Maske verwiesen wird, die im Eingabedokument aber nicht vorhanden sind, werden auf dem Server aus dem Dokument gelöscht.
mask

object (DocumentMask)

Die zurückzugebenden Felder. Wenn nicht festgelegt, werden alle Felder zurückgegeben.

Wenn das Dokument ein Feld enthält, das in dieser Maske nicht vorhanden ist, wird dieses Feld nicht in der Antwort zurückgegeben.
currentDocument

object (Precondition)

Eine optionale Vorbedingung für das Dokument. Die Anfrage schlägt fehl, wenn dies festgelegt und vom Zieldokument nicht erfüllt wird.

Anfragetext

Der Anfragetext enthält eine Instanz von Document.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Document.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.