Method: projects.databases.documents.batchWrite

ใช้ชุดการดำเนินการเขียน

เมธอด document.batchWrite ไม่ได้นำการดำเนินการเขียนไปใช้อย่างเป็นรูปธรรมและนำไปใช้ได้ไม่ถูกต้อง เมธอดไม่อนุญาตให้มีการเขียนมากกว่า 1 รายการต่อเอกสาร การเขียนแต่ละรายการประสบความสำเร็จหรือล้มเหลวโดยอิสระ ดูสถานะความสําเร็จของการเขียนแต่ละรายการได้ที่BatchWriteResponse

หากต้องการชุดการเขียนที่ใช้แบบอะตอม ให้ใช้ documents.commit แทน

คำขอ HTTP

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

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

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

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

string

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

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

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

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

object (Write)

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

เมธอดไม่ได้ใช้การเขียนแบบอะตอมและไม่รับประกันการเรียงลำดับ การเขียนแต่ละรายการประสบความสำเร็จหรือล้มเหลวโดยอิสระ คุณไม่สามารถเขียนไปยังเอกสารเดียวกันมากกว่า 1 ครั้งต่อคำขอ
labels

map (key: string, value: string)

ป้ายกำกับที่เชื่อมโยงกับการเขียนแบบกลุ่มนี้

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }

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

คำตอบจาก Firestore.BatchWrite

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

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

object (WriteResult)

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

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

object (Status)

สถานะของการใช้การเขียน

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

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

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

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

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