يتم تعديل إعدادات الحقل. في الوقت الحالي، لا تنطبق تعديلات الحقول إلا على إعدادات فهرس الحقل الواحد. ومع ذلك، يجب أن توفر المكالمات الواردة إلى FirestoreAdmin.UpdateField
قناع حقل لتجنُّب تغيير أي إعدادات لا يعرف المتصل بها. يجب تحديد قناع الحقل على النحو التالي: { paths: "indexConfig" }
.
تعرض هذه المكالمة رمز google.longrunning.Operation
الذي يمكن استخدامه لتتبُّع حالة تعديل الحقل. ستكون البيانات الوصفية للعملية من النوع FieldOperationMetadata
.
لضبط إعدادات الحقل التلقائية لقاعدة البيانات، استخدِم السمة Field
الخاصة مع اسم المورد: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
.
طلب HTTP
PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
field.name |
اسم حقل للنموذج قد يكون مسار الحقل اسم حقل بسيطًا، على سبيل المثال يمكن اقتباس مسارات الحقول باستخدام أمثلة: (ملاحظة: تتم كتابة التعليقات هنا في بنية markdown، لذا توجد طبقة إضافية من الفواصل العليا المائلة لتمثيل مجموعة رموز) تتضمّن قيمة |
معامِلات طلب البحث
المَعلمات | |
---|---|
updateMask |
قناع، نسبةً إلى الحقل. في حال تحديد هذا الخيار، سيتم تعديل الإعدادات المحدّدة من خلال هذا الحقل (قناع الحقل) فقط في الحقل. هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: |
نص الطلب
يحتوي نص الطلب على مثيل Field
.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Operation
.
نطاقات الأذونات
يتطلب هذا الإعداد أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة حول المصادقة.