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

מידע נוסף זמין בסקירה הכללית על אימות.