Method: projects.databases.documents.beginTransaction

Rozpoczyna nową transakcję.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
database

string

Wymagane. Nazwa bazy danych. W formacie: projects/{projectId}/databases/{databaseId}.

Treść żądania

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

Zapis JSON 
{
  "options": {
    object (TransactionOptions)
  }
}
Pola
options

object (TransactionOptions)

Opcje transakcji. Domyślnie jest to transakcja odczytu-zapisu.

Treść odpowiedzi

Odpowiedź dotycząca: Firestore.BeginTransaction.

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

Zapis JSON 
{
  "transaction": string
}
Pola
transaction

string (bytes format)

Transakcja, która została rozpoczęta.

Ciąg zakodowany w standardzie base64.

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.