Method: projects.databases.documents.beginTransaction

تراکنش جدیدی را شروع می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
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

برای اطلاعات بیشتر، به نمای کلی احراز هویت مراجعه کنید.