تمت ترجمة هذه الصفحة بواسطة 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. أمثلة: (ملاحظة: تتم كتابة التعليقات هنا في بنية markdown، لذا توجد طبقة إضافية من الفواصل العليا المائلة لتمثيل مجموعة رموز) `\`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.

أمثلة: (ملاحظة: تتم كتابة التعليقات هنا في بنية markdown، لذا توجد طبقة إضافية من الفواصل العليا المائلة لتمثيل مجموعة رموز) \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)` قناع، نسبةً إلى الحقل. في حال تحديد هذا الخيار، سيتم تعديل الإعدادات المحدّدة من خلال هذا الحقل (قناع الحقل) فقط في الحقل. هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: `"user.displayName,photo"`.

updateMask

string (FieldMask format)

قناع، نسبةً إلى الحقل. في حال تحديد هذا الخيار، سيتم تعديل الإعدادات المحدّدة من خلال هذا الحقل (قناع الحقل) فقط في الحقل.

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "user.displayName,photo".

نص الطلب

يحتوي نص الطلب على مثيل Field.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Operation.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة حول المصادقة.