Method: projects.databases.documents.beginTransaction

بدء معاملة جديدة

طلب HTTP

POST https://firestore.googleapis.com/v1beta1/{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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.