Method: labels.list

تصنيفات القائمة لمزيد من المعلومات، اطّلِع على البحث عن التصنيفات.

طلب HTTP

GET https://drivelabels.googleapis.com/v2/labels

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

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

المعلمات
publishedOnly

boolean

تحديد ما إذا كان سيتم تضمين التصنيفات المنشورة فقط في النتائج

  • عندما تكون القيمة true، يتم عرض مراجعات التصنيف المنشور الحالي فقط. يتم تضمين التصنيفات التي تم إيقافها. تشير أسماء موارد التصنيفات التي يتم عرضها إلى المراجعة المنشورة (labels/{id}/{revisionId}).
  • عندما تكون القيمة false، يتم عرض النُسخ المعدّلة الحالية من التصنيف، والتي قد لا تكون منشورة. لا تشير أسماء موارد التصنيفات التي يتم عرضها إلى مراجعة معيّنة (labels/{id}).
customer

string

العميل الذي سيتم تحديد نطاق طلب القائمة هذا له. على سبيل المثال: customers/abcd1234. في حال عدم ضبطها، سيتم عرض جميع التصنيفات ضمن العميل الحالي.

languageCode

string

رمز اللغة BCP-47 الذي سيتم استخدامه لتقييم تصنيفات الحقول المترجمة. في حال عدم تحديدها، يتم استخدام القيم باللغة التلقائية التي تم ضبطها.

pageSize

integer

الحدّ الأقصى لعدد التصنيفات التي سيتم عرضها في كل صفحة القيمة التلقائية: 50. الحد الأقصى: 200

pageToken

string

تمثّل هذه السمة الرمز المميز للصفحة المطلوب عرضها.

view

enum (LabelView)

عند تحديدها، يتم عرض حقول معيّنة فقط تنتمي إلى طريقة العرض المحدّدة.

مَعلمة الاتحاد access

يمكن أن تكون access إحدى القيم التالية فقط:

useAdminAccess

boolean

اضبط القيمة على true لاستخدام بيانات اعتماد المشرف الخاصة بالمستخدم. سيؤدي ذلك إلى عرض جميع التصنيفات ضمن العميل.

minimumRole

enum (LabelRole)

تحدّد هذه السمة مستوى الوصول الذي يجب أن يحصل عليه المستخدم إلى التصنيفات التي تم إرجاعها. الحد الأدنى للدور الذي يجب أن يحصل عليه المستخدم في تصنيف القيمة التلقائية هي READER.

نص الطلب

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

نص الاستجابة

ردّ لطلب عرض تصنيفات.

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

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

object (Label)

التصنيفات

nextPageToken

string

الرمز المميّز للصفحة التالية في الردّ.

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

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.