חיפוש תוויות

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

במסמך הזה מוסבר איך לחפש ולאחזר תוויות באמצעות Drive Labels API.

Methods

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

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

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

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

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

  • ‫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
const name = 'labels/NAME@published';

// Label view controls level of data in response
const 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);
});

מחליפים את NAME בשם התווית.

הצגת רשימה של כל התוויות

כדי לקבל רשימה של תוויות, משתמשים בשיטה list במשאב labels.

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

  • פרמטר השאילתה 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');
  }
});

מחליפים את CUSTOMER בשם הלקוח.