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

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