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

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