جستجو برای برچسب ها

سازمان شما می‌تواند چندین برچسب داشته باشد، که هر برچسب دارای چندین فیلد است. API برچسب‌های گوگل درایو، منبع labels را برای فعال کردن خواندن برچسب‌ها فراهم می‌کند.

این سند نحوه جستجو و بازیابی برچسب‌ها را با استفاده از Drive Labels API شرح می‌دهد.

روش‌ها

منبع labels روش‌های زیر را برای خواندن مقادیر برچسب ارائه می‌دهد که هر کدام وظیفه خاصی را در نظر دارند:

دریافت برچسب بر اساس نام منبع

برای دریافت یک برچسب واحد بر اساس نام منبع آن، از متد get روی منبع labels استفاده کنید.

name منبع برچسب الزامی است و می‌تواند به صورت زیر ساختاربندی شود:

• labels/{id} یا labels/{id}@latest : آخرین نسخه برچسب را دریافت می‌کند.
• labels/{id}@published : نسخه فعلی برچسب منتشر شده را دریافت می‌کند.
• labels/{id}@{revisionId} : برچسب را در شناسه‌ی ویرایش مشخص‌شده برمی‌گرداند.

برای تنظیم نمای منبع که برای پاسخ‌های برچسب اعمال می‌شود، باید یک شیء LabelView به عنوان LABEL_VIEW_FULL مشخص کنید. LABEL_VIEW_FULL تمام فیلدهای ممکن را برمی‌گرداند.

نمونه کد زیر نحوه استفاده از name برچسب برای دریافت یک برچسب واحد بر اساس نام منبع آن را نشان می‌دهد:

# Label name, with or without revision:
#
# Revision specified:
# labels/LABEL_ID@published
# labels/LABEL_ID@latest
# labels/LABEL_ID@1
#
# No revision specified, returns latest revision:
# labels/LABEL_ID
name = 'labels/NAME@published'

# Label view controls level of data in response
view = 'LABEL_VIEW_FULL'

label = service.labels().get(
    name=name,
    view=view
).execute()

// Label name, with or without revision:
//
// Revision specified:
// labels/LABEL_ID@published
// labels/LABEL_ID@latest
// labels/LABEL_ID@1
//
// No revision specified, returns latest revision:
// labels/LABEL_ID
const name = 'labels/NAME@published';

// Label view controls level of data in response
const view = 'LABEL_VIEW_FULL';

service.labels.get({
  name: name,
  view: view
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

به جای NAME ، نام برچسب مورد نظر را بنویسید.

فهرست کردن تمام برچسب‌ها

برای دریافت لیستی از برچسب‌ها، از متد list روی منبع labels استفاده کنید.

همچنین باید مشخص کنید:

• یک پارامتر پرس‌وجوی customer برای محدوده‌ی این درخواست لیست. اگر customer تنظیم نشده باشد، تمام برچسب‌های درون مشتری فعلی بازگردانده می‌شوند.

• یک شیء LabelView به عنوان LABEL_VIEW_FULL برای تنظیم یک نمای منبع که برای پاسخ‌های برچسب اعمال می‌شود. LABEL_VIEW_FULL تمام فیلدهای ممکن را برمی‌گرداند.

نمونه کد زیر نحوه استفاده از پارامتر پرس و جوی customer برای دریافت لیستی از برچسب‌ها را نشان می‌دهد:

response = service.labels().list(
    customer='customers/CUSTOMER',
    view='LABEL_VIEW_FULL'
).execute()

const params = {
  customer: 'customers/CUSTOMER',
  view: 'LABEL_VIEW_FULL'
};

service.labels.list(params, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  const labels = res.data.labels;
  if (labels) {
    labels.forEach((label) => {
      const name = label.name;
      const title = label.properties.title;
      console.log(`${name}\t${title}`);
    });
  } else {
    console.log('No Labels');
  }
});

به جای CUSTOMER نام مشتری را قرار دهید.