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)

ธุรกรรมที่เริ่มต้นแล้ว

สตริงที่เข้ารหัสฐาน 64

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมการตรวจสอบสิทธิ์