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

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

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

روش‌ها

مجموعه labels متدهای زیر را برای خواندن مقادیر label ارائه می‌دهد که هر کدام وظیفه خاصی را در نظر دارند:

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

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

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

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

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

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

  • LabelView LABEL_VIEW_FULL است تا نمای Resource اعمال شده روی پاسخ‌های برچسب را تنظیم کند. 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

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 است تا نمای Resource اعمال شده روی پاسخ‌های برچسب را تنظیم کند. 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');
  }
});