Method: projects.databases.collectionGroups.fields.list

يسرد إعدادات الحقل والبيانات الوصفية لقاعدة البيانات هذه.

في الوقت الحالي، لا يتوافق FirestoreAdmin.ListFields إلا مع حقول البيانات التي تم إلغاؤها بشكل صريح. لإصدار هذا الطلب، عليك طلب "FirestoreAdmin.ListFields" مع ضبط الفلتر على indexConfig.usesAncestorConfig:false orttlConfig:*`.

طلب HTTP

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/collectionGroups/*}/fields

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
parent

string

يجب ملء الحقل. اسم أحد الوالدين للنموذج projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

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

المَعلمات
filter

string

الفلتر المطلوب تطبيقه على قائمة نتائج البحث. في الوقت الحالي، لا يتوافق FirestoreAdmin.ListFields إلا مع حقول البيانات التي تم إلغاؤها بشكل صريح. لإصدار طلب البحث هذا، يمكنك طلب FirestoreAdmin.ListFields باستخدام فلتر يتضمّن indexConfig.usesAncestorConfig:false .
pageSize

integer

عدد النتائج المطلوب عرضها.
pageToken

string

رمز مميّز للصفحة، يتم عرضه من استدعاء سابق إلى FirestoreAdmin.ListFields، ويمكن استخدامه للحصول على الصفحة التالية من النتائج.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

تمثّل هذه السمة الردّ على FirestoreAdmin.ListFields.

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
الحقول
fields[]

object (Field)

الحقول المطلوبة.
nextPageToken

string

هو رمز مميّز للصفحة يمكن استخدامه لطلب صفحة أخرى من النتائج. إذا كان هذا الحقل فارغًا، تكون هذه هي الصفحة الأخيرة.

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

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

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

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