Method: projects.databases.documents.commit

ทำธุรกรรม ขณะเดียวกันก็เลือกที่จะอัปเดตเอกสารได้

คำขอ HTTP

POST https://firestore.googleapis.com/v1beta1/{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 นี้สอดคล้องกับการเขียน 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

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