หน้านี้ได้รับการแปลโดย Cloud Translation API

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 named`address.city`, not the map key`city`in the field`address`.````represents a field named`` ไม่ใช่ช่องใดๆ `Field` พิเศษมีการตั้งค่าการจัดทำดัชนีเริ่มต้นสำหรับทุกช่อง ชื่อทรัพยากรของช่องนี้คือ: ดัชนี `projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*` รายการที่กำหนดไว้ใน `Field` นี้จะมีผลกับทุกฟิลด์ที่ไม่มีการกำหนดค่าดัชนี `Field` ของตัวเอง

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 keycityin 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"`

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

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