יצירה ופרסום של תווית

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

יצירת תווית

כדי ליצור תווית, משתמשים ב-method ‏create במשאב labels. תוויות יכולות להכיל אובייקט אחד או יותר של Field.

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

• אובייקט LabelType.

• תווית title דרך אובייקט Properties

• פרמטר השאילתה useAdminAccess מוגדר לערך true כדי להשתמש בהרשאות האדמין של המשתמש. לפני אישור הגישה, השרת מאמת שלמשתמש יש הרשאות אדמין נדרשות לניהול תוויות סיווג.

בדוגמת הקוד הבאה אפשר לראות איך משתמשים בשיטה create כדי ליצור תווית אדמין רגילה עם שם שצוין ועם SelectionOptions אחד של Field עם שני אובייקטים של Choice.

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

service.labels.create({
  requestBody: label,
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

מחליפים את מה שכתוב בשדות הבאים:

• TITLE: שם התווית.
• ‫DISPLAY_NAME: השם המוצג של השדה.
• ‫CHOICE_1: הבחירה הראשונה בשדה SelectionOptions.
• ‫CHOICE_2: האפשרות השנייה בשדה SelectionOptions.

התווית נוצרת בUNPUBLISHED_DRAFT State. התווית צריכה להיות PUBLISHED כדי שהמשתמשים יוכלו לראות אותה ולהשתמש בה בקבצים. למידע נוסף, ראו מחזור החיים של התווית.

מגבלות על תוויות

המגבלות הבאות חלות כשיוצרים תוויות ומחילים אותן:

• תוויות רגילות: 150
• שדות לכל תווית: 10

עבודה עם שדות בתוויות

בטבלה הבאה מתוארים סוגי השדות שאפשר להוסיף לתווית, אופן האינטראקציה של המשתמשים עם השדות, והשיקולים והמגבלות לגבי הפורמט שלהם:

Field Type	מה המשתמשים יכולים לעשות	שיקולים ומגבלות לגבי פורמטים
SelectionOptions	לבחור אפשרות אחת או יותר מתוך רשימה	מספר האפשרויות המקסימלי שנתמך הוא 200 מספר הבחירות המקסימלי לקובץ הוא 10, כפי שהוגדר ב-ListOptions
IntegerOptions	מזינים ערך מספרי	המערכת תומכת רק במספרים שלמים
DateOptions	בחירת תאריך ביומן	(אופציונלי) אפשר להגדיר את DateFormat לפורמט 'ארוך: DD, חודש, YYYY' או 'קצר: DD/MM/YYYY'
TextOptions	למלא טקסט בתיבת טקסט	מספר התווים המקסימלי הנתמך הוא 100
UserOptions	בוחרים משתמש אחד או יותר מאנשי הקשר ב-Google Workspace.	המספר המקסימלי של רשומות משתמשים בקובץ הוא 10, כפי שמוגדר ב-ListOptions

פרסום תווית

‫Drive Labels API מאפשר לכם לפרסם תווית טיוטה אחרי שהיא מוכנה. התווית גלויה למשתמשים ואפשר להחיל אותה על קבצים.

כדי לפרסם תווית, משתמשים ב-method ‏publish במשאב labels ומציינים:

• משאב labels שמייצג כל תווית. הוא מכיל name, שהוא מזהה משאב, וid, שהוא מזהה ייחודי גלובלי של התווית.

• פרמטר השאילתה useAdminAccess מוגדר לערך true כדי להשתמש בהרשאות האדמין של המשתמש. לפני אישור הגישה, השרת מאמת שלמשתמש יש הרשאות אדמין נדרשות לניהול תוויות סיווג.

בדוגמת הקוד הבאה מוצג אופן השימוש ב-id של התווית כדי לזהות ולפרסם את התווית הנכונה.

Python

service.labels().publish(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.publish({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

מחליפים את ID במזהה של התווית שרוצים לפרסם.

אחרי פרסום התווית, היא עוברת אל PUBLISHED State ומזהה הגרסה של התווית גדל. התווית גלויה למשתמשים ואפשר להחיל אותה על קבצים. מידע נוסף זמין במאמר בנושא מחזור החיים של התווית.

מגבלות כשמפרסמים תוויות

כשמתכוננים לפרסם תוויות, חשוב לשים לב למגבלות הבאות:

• אחרי שמפרסמים תווית, אי אפשר להחזיר אותה למצב הטיוטה המקורי. למידע נוסף, ראו מחזור החיים של התווית.

• כשמפרסמים תווית, נוצרת גרסה חדשה שפורסמה. כל הטיוטות הקודמות של הגרסה נמחקות. גרסאות קודמות שפורסמו נשמרות, אבל הן כפופות למחיקה אוטומטית לפי הצורך.

• אחרי הפרסום, אי אפשר לבצע שינויים מסוימים. בדרך כלל, המשמעות היא שכל שינוי שמבטל או מפעיל הגבלות חדשות על מטא-נתונים קיימים שקשורים לתווית נדחה. לדוגמה, אסור לבצע את השינויים הבאים בתווית אחרי שהיא פורסמה:

  • התווית נמחקת ישירות. (קודם צריך להשבית אותו ואז למחוק אותו).
  • ה-Field.FieldType השתנה.
  • עדכונים באפשרויות האימות Field דוחים משהו שהתקבל קודם.
  • הפחתה במספר המקסימלי של הערכים.