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

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