חיפוש תוויות

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

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

שיטות

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

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

כדי להציג תווית יחידה לפי שם המשאב שלה, משתמשים 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');
  }
});