Method: projects.databases.documents.commit

ทำธุรกรรม แต่เลือกที่จะอัปเดตเอกสารได้

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
database

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{projectId}/databases/{databaseId}

เนื้อความของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "writes": [
    {
      object (Write)
    }
  ],
  "transaction": string
}
ช่อง
writes[]

object (Write)

การเขียนที่จะใช้

ดำเนินการโดยอัตโนมัติเสมอและเรียงตามลำดับ
transaction

string (bytes format)

หากมีการตั้งค่า จะใช้การเขียนทั้งหมดในธุรกรรมนี้และตกลง

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

เนื้อหาการตอบกลับ

การตอบกลับสำหรับ Firestore.Commit

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "writeResults": [
    {
      object (WriteResult)
    }
  ],
  "commitTime": string
}
ช่อง
writeResults[]

object (WriteResult)

ผลลัพธ์ของการใช้การเขียน

ผลการเขียน i-th นี้สอดคล้องกับการเขียน i-th ในคำขอ
commitTime

string (Timestamp format)

เวลาที่การคอมมิตเกิดขึ้น การอ่านที่มี readTime เท่ากันหรือมากกว่าได้เห็นผลของคอมมิต

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

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

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

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

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