อัปเดตการกำหนดค่าช่อง ปัจจุบันการอัปเดตช่องจะใช้กับการกำหนดค่าดัชนีช่องเดียวเท่านั้น อย่างไรก็ตาม การเรียกใช้ไปยัง 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 |
ต้องระบุ ชื่อช่องของแบบฟอร์ม เส้นทางฟิลด์อาจเป็นชื่อฟิลด์ง่ายๆ เช่น คุณยกเส้นทางช่องได้โดยใช้ ตัวอย่าง: (หมายเหตุ: ความคิดเห็นจะเขียนด้วยไวยากรณ์มาร์กดาวน์ จึงมีเครื่องหมายแบ็กทิกอีกชั้นหนึ่งขึ้นมาแทนโค้ดบล็อก)
|
พารามิเตอร์การค้นหา
พารามิเตอร์ | |
---|---|
updateMask |
มาสก์ที่สัมพันธ์กับฟิลด์ หากระบุไว้ ระบบจะอัปเดตเฉพาะการกำหนดค่าที่ระบุโดย field_mask นี้ในช่อง ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองซึ่งคั่นด้วยคอมมา ตัวอย่าง: |
เนื้อหาของคำขอ
เนื้อความของคำขอมีอินสแตนซ์ของ Field
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์