Method: projects.databases.collectionGroups.fields.patch

อัปเดตการกำหนดค่าช่อง ปัจจุบันการอัปเดตช่องจะใช้กับการกำหนดค่าดัชนีช่องเดียวเท่านั้น อย่างไรก็ตาม การเรียกใช้ไปยัง FirestoreAdmin.UpdateField ควรมีการมาสก์เพื่อหลีกเลี่ยงไม่ให้มีการเปลี่ยนแปลงการกําหนดค่าที่ผู้โทรไม่ทราบ ฟิลด์มาสก์ควรระบุเป็น: { paths: "indexConfig" }

การเรียกนี้จะแสดง google.longrunning.Operation ซึ่งอาจใช้เพื่อติดตามสถานะของการอัปเดตในฟิลด์นี้ ข้อมูลเมตาสำหรับการดำเนินการจะเป็นประเภท FieldOperationMetadata

ในการกำหนดการตั้งค่าฟิลด์เริ่มต้นสำหรับฐานข้อมูล ให้ใช้ Field พิเศษพร้อมด้วยชื่อทรัพยากร: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*

คำขอ HTTP

PATCH https://firestore.googleapis.com/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

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

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

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

string

ต้องระบุ ชื่อช่องของแบบฟอร์ม projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

เส้นทางฟิลด์อาจเป็นชื่อฟิลด์ง่ายๆ เช่น address หรือเส้นทางไปยังฟิลด์ภายในmapValue เช่น address.city หรือเส้นทางฟิลด์พิเศษ ช่องพิเศษที่ใช้ได้ช่องเดียวคือ * ซึ่งแสดงถึงช่องใดก็ได้

คุณยกเส้นทางช่องได้โดยใช้ (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` รวมถึงอักขระสัญลักษณ์ ASCII

ตัวอย่าง: (หมายเหตุ: ความคิดเห็นจะเขียนด้วยไวยากรณ์มาร์กดาวน์ จึงมีเครื่องหมายแบ็กทิกอีกชั้นหนึ่งขึ้นมาแทนโค้ดบล็อก) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*` ไม่ใช่ช่องใดๆ

Field พิเศษมีการตั้งค่าการจัดทำดัชนีเริ่มต้นสำหรับทุกช่อง ชื่อทรัพยากรของช่องนี้คือ projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* ดัชนีที่กำหนดไว้ใน Field นี้จะใช้กับทุกช่องที่ไม่มีการกำหนดค่าดัชนี Field เป็นของตัวเอง

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

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

string (FieldMask format)

มาสก์ที่สัมพันธ์กับฟิลด์ หากระบุไว้ ระบบจะอัปเดตเฉพาะการกำหนดค่าที่ระบุโดย field_mask นี้ในช่อง

ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองซึ่งคั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

เนื้อหาของคำขอ

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

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

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

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

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

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

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