חיפוש תוויות

לארגון יכולות להיות כמה תוויות, עם כמה שדות בכל תווית. ה-Labels API מספק את האוסף labels כדי לאפשר קריאה של תוויות.

בדף הזה מוסבר איך לחפש תוויות ואיך לאחזר אותן.

Methods

הקולקציה labels מספקת את השיטות הבאות לקריאת ערכי תוויות, כל אחת עם מטרה ספציפית:

אחזור תווית לפי שם המשאב

כדי לקבל תווית אחת לפי שם המשאב שלה, משתמשים ב-method‏ 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()

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

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