لتعديل إعدادات حقل في الوقت الحالي، لا تنطبق تعديلات الحقول إلا على إعدادات فهرس حقل واحد. ومع ذلك، يجب أن توفّر المكالمات إلى 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 |
قناع، مرتبط بالحقل. في حال تحديد هذه السمة، سيتم تعديل الإعدادات التي حدّدها هذا الحقل_mask فقط في الحقل. هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: |
نص الطلب
يحتوي نص الطلب على مثال Field
.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Operation
.
نطاقات التفويض
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.