Method: labels.list

لیست برچسب ها برای اطلاعات بیشتر، به جستجوی برچسب ها مراجعه کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.