Method: projects.databases.documents.beginTransaction

एक नया लेन-देन प्रारंभ करता है.

HTTP अनुरोध

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

यूआरएल जीआरपीसी ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।

पथ पैरामीटर

पैरामीटर
database

string

आवश्यक। डेटाबेस का नाम. प्रारूप में: projects/{projectId}/databases/{databaseId}

निकाय से अनुरोध करें

अनुरोध निकाय में निम्नलिखित संरचना वाला डेटा शामिल है:

JSON प्रतिनिधित्व
{
  "options": {
    object (TransactionOptions)
  }
}
खेत
options

object ( TransactionOptions )

लेन-देन के लिए विकल्प. पढ़ने-लिखने के लेनदेन में डिफ़ॉल्ट।

प्रतिक्रिया निकाय

Firestore.BeginTransaction के लिए प्रतिक्रिया।

सफल होने पर, प्रतिक्रिया निकाय में निम्नलिखित संरचना वाला डेटा शामिल होता है:

JSON प्रतिनिधित्व
{
  "transaction": string
}
खेत
transaction

string ( bytes format)

जो लेनदेन प्रारंभ किया गया था.

एक बेस64-एन्कोडेड स्ट्रिंग।

प्राधिकरण के दायरे

निम्नलिखित OAuth स्कोप में से एक की आवश्यकता है:

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

अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।