Method: projects.databases.documents.beginTransaction

Начинает новую транзакцию.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
database

string

Необходимый. Имя базы данных. В формате: projects/{projectId}/databases/{databaseId} .

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "options": {
    object (TransactionOptions)
  }
}
Поля
options

object ( TransactionOptions )

Варианты сделки. По умолчанию используется транзакция чтения-записи.

Тело ответа

Ответ на Firestore.BeginTransaction .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "transaction": string
}
Поля
transaction

string ( bytes format)

Транзакция, которая была начата.

Строка в кодировке Base64.

Области авторизации

Требуется одна из следующих областей OAuth:

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

Для получения дополнительной информации см. Обзор аутентификации .