לארגון שלכם יכולות להיות כמה תוויות, ולתוויות יכולות להיות כמה שדות.
Labels API מספק את האוסף labels
כדי להפעיל את קריאת התוויות.
בדף זה מוסבר איך לחפש ולאחזר תוויות.
שיטות
באוסף labels
יש את השיטות הבאות לקריאת ערכים של תוויות, כשלכל אחת מהן יש משימה ספציפית:
טווח | קריאה |
---|---|
תווית יחידה לפי שם המשאב | labels.get |
כל התוויות | labels.list |
קבלת תווית לפי שם המשאב
כדי לקבל תווית יחידה לפי שם המשאב שלה, צריך להשתמש ב-method labels.get
.
יש להזין שם למשאב של תווית, והערך יכול להיות מובנה באופן הבא:
labels/{id}
אוlabels/{id}@latest
—מקבל את הגרסה האחרונה של התווית.labels/{id}@published
– קבלת הגרסה הנוכחית של התווית שפורסמה.labels/{id}@{revisionId}
– הפונקציה מקבלת את התווית במזהה הגרסה הקודמת שצוינה.
בנוסף, צריך לציין את הפרטים הבאים:
LabelView
הוא הערך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);
});
הצגת רשימה של כל התוויות
כדי להציג רשימה של תוויות, משתמשים ב-method labels.list
.
בנוסף, צריך לציין את הפרטים הבאים:
customer
להיקף בקשת הרשימה הזו. אם לא מגדירים את השדהcustomer
, כל התוויות של הלקוח הנוכחי יוחזרו.LabelView
הוא הערך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');
}
});