חיפוש תוויות

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

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

Methods

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

טווח קריאה
תווית אחת לפי שם המשאב labels.get
כל התוויות labels.list

קבלת תווית לפי שם משאב

כדי לקבל תווית אחת לפי שם המשאב שלה, משתמשים בשיטה labels.get.

חובה לציין שם משאב של תווית, והוא יכול להיות בנוי כך:

  • ‫labels/{id} או labels/{id}@latest – מקבלים את הגרסה האחרונה של התווית.
  • ‫labels/{id}@published—מקבל את הגרסה הנוכחית של התווית שפורסמה.
  • ‫labels/{id}@{revisionId}—אחזור התווית לפי מזהה הגרסה שצוין.

צריך לציין גם:

  • ‫LabelView is LABEL_VIEW_FULL כדי להגדיר את תצוגת המשאבים שמוחלת על תשובות לתוויות. ‫LABEL_VIEW_FULL מחזירה את כל השדות האפשריים.

בדוגמה הזו נשתמש ב-Name כדי לקבל תווית אחת לפי שם המשאב שלה.

Python

# 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 is LABEL_VIEW_FULL כדי להגדיר את תצוגת המשאבים שמוחלת על תשובות לתוויות. ‫LABEL_VIEW_FULL מחזירה את כל השדות האפשריים.

בדוגמה הזו נשתמש ב-CUSTOMER כדי לאחזר את רשימת התוויות.

Python

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