Method: projects.databases.documents.patch

Aktualizuje lub wstawia dokument.

Żądanie HTTP

PATCH https://firestore.googleapis.com/v1/{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. Żadna ze ścieżek pól w masce nie może zawierać zarezerwowanej nazwy.

Jeśli dokument znajduje się na serwerze, a jego pola nie zawierają odniesień w masce, pozostaną one niezmienione. Pola, do których odwołuje się maska, ale nie ma ich w dokumencie wejściowym, są usuwane z dokumentu na serwerze.
mask

object (DocumentMask)

Pola do zwrócenia. Jeśli zasada nie jest skonfigurowana, zwraca wszystkie pola.

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

object (Precondition)

Opcjonalny warunek wstępny dotyczący dokumentu. Jeśli ta wartość zostanie ustawiona, a dokument docelowy nie spełni tego żądania, żądanie zakończy się niepowodzeniem.

Treść żądania

Treść żądania zawiera instancję Document.

Treść odpowiedzi

Jeśli operacja się uda, treść odpowiedzi będzie zawierała instancję Document.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w artykule o uwierzytelnianiu (w języku angielskim).