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

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