Method: projects.databases.documents.commit

Potwierdza transakcję i opcjonalnie aktualizują dokumenty.

Żądanie HTTP

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:commit

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
database

string

To pole jest wymagane. Nazwa bazy danych. W formacie: projects/{projectId}/databases/{databaseId}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
Pola
writes[]

object (Write)

Zapisy, które mają zostać zastosowane.

Zawsze wykonywany atomowo i w określonej kolejności.

transaction

string (bytes format)

Jeśli jest ustawione, stosuje wszystkie zapisy w tej transakcji i je zatwierdza.

Ciąg zakodowany w formacie base64.

Treść odpowiedzi

Odpowiedź dla: Firestore.Commit.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
Pola
writeResults[]

object (WriteResult)

Wynik zastosowania zapisów.

Ten wynik i-tego zapisu odpowiada i-temu zapisowi w żądaniu.

commitTime

string (Timestamp format)

Czas realizacji zatwierdzenia. Każdy odczyt o wartości readTime lub większej jest gwarantowany, aby zobaczyć efekty zatwierdzenia.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

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).