Method: projects.databases.documents.patch

Aktualizuje lub wstawia dokument.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
document.name

string

Nazwa zasobu dokumentu, na przykład projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Parametry zapytania

Parametry
updateMask

object (DocumentMask)

Pola do zaktualizowania. Żadne ścieżki pól w masce nie mogą zawierać zarezerwowanej nazwy.

Jeśli dokument istnieje na serwerze, a pola, do których nie odwołano się w masce, pozostają niezmienione. Pola, do których odwołuje się maska, ale nie występują w dokumencie wejściowym, są usuwane z dokumentu na serwerze.
mask

object (DocumentMask)

Pola do zwrócenia. Jeśli wartość nie jest ustawiona, zwraca wszystkie pola.

Jeśli dokument zawiera pole, którego nie ma w masce, nie zostanie ono zwrócone w odpowiedzi.
currentDocument

object (Precondition)

Opcjonalny warunek wstępny w dokumencie. Żądanie nie powiedzie się, jeśli ten parametr jest ustawiony, a dokument docelowy nie spełnia tego warunku.

Treść żądania

Treść żądania zawiera wystąpienie elementu Document.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Document.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie uwierzytelniania.