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

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

این صفحه نحوه جستجو و بازیابی برچسب ها را شرح می دهد.

روش ها

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

محدوده خواندن
برچسب تک بر اساس نام منبع labels.get
همه برچسب ها labels.list

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

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

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

  • 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()

Node.js 

# 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'

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

لیست همه برچسب ها

برای دریافت لیست برچسب ها از روش labels.list استفاده کنید.

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

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

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

این مثال از CUSTOMER برای بازیابی لیست برچسب استفاده می کند.

پایتون 

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

Node.js 

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');
  }
});