Method: projects.databases.documents.beginTransaction

नया लेन-देन शुरू करता है.

एचटीटीपी अनुरोध

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

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
database

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{projectId}/databases/{databaseId}.

अनुरोध का मुख्य भाग

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

जेएसओएन के काेड में दिखाना 
{
  "options": {
    object (TransactionOptions)
  }
}
फ़ील्ड
options

object (TransactionOptions)

लेन-देन के विकल्प. डिफ़ॉल्ट तौर पर, रीड-राइट ट्रांज़ैक्शन होता है.

जवाब का मुख्य भाग

Firestore.BeginTransaction के लिए रिस्पॉन्स.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "transaction": string
}
फ़ील्ड
transaction

string (bytes format)

शुरू किया गया लेन-देन.

base64 कोड में बदली गई स्ट्रिंग.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.