Method: projects.databases.documents.patch

อัปเดตหรือแทรกเอกสาร

คำขอ HTTP

PATCH https://firestore.googleapis.com/v1/{document.name=projects/*/databases/*/documents/*/**}

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

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

พารามิเตอร์
document.name

string

ชื่อทรัพยากรของเอกสาร เช่น projects/{projectId}/databases/{databaseId}/documents/{document_path}

พารามิเตอร์การค้นหา

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

object (DocumentMask)

ช่องที่จะอัปเดต เส้นทางช่องในมาสก์ต้องไม่มีชื่อที่สงวนไว้

หากเอกสารอยู่บนเซิร์ฟเวอร์และมีฟิลด์ที่ไม่ได้อ้างอิงในมาสก์ จะไม่มีการเปลี่ยนแปลง ฟิลด์ที่อ้างอิงในมาสก์ แต่ไม่ปรากฏในเอกสารอินพุต จะถูกลบออกจากเอกสารบนเซิร์ฟเวอร์
mask

object (DocumentMask)

ช่องที่จะแสดง หากไม่ได้ตั้งค่า ระบบจะแสดงช่องทั้งหมด

หากเอกสารมีช่องที่ไม่อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในการตอบกลับ
currentDocument

object (Precondition)

เงื่อนไขที่ต้องดำเนินการก่อนในเอกสาร (ไม่บังคับ) คำขอจะล้มเหลวหากตั้งค่าไว้แต่ไม่บรรลุผลโดยเอกสารเป้าหมาย

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

เนื้อหาของคำขอมีอินสแตนซ์ Document

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document

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

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

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

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