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 namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`، وليس أي حقل.

يحتوي حقل Field الخاص على إعدادات الفهرسة التلقائية لجميع الحقول. اسم مورد هذا الحقل هو: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* سيتم تطبيق الفهارس المحدّدة في Field على جميع الحقول التي لا تحتوي على إعدادات فهرس Field الخاصة بها.

معلمات طلب البحث

المَعلمات
updateMask

string (FieldMask format)

قناع، مرتبط بالحقل. في حال تحديد هذه السمة، سيتم تعديل الإعدادات التي حدّدها هذا الحقل_mask فقط في الحقل.

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

نص الطلب

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

نص الاستجابة

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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