יצירת & פרסום תווית

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

יצירת תווית

כדי ליצור תווית, משתמשים בשיטה create באוסף labels. תוויות יכולות להכיל Fields אחת או יותר (אופציונלי).

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

• LabelType.

• תווית title באמצעות השיטה property.

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

בדוגמה הזו נוצרת תווית אדמין רגילה עם שם שצוין ועם SelectionOptions אחד (Field) עם 2 Choices.

Python

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

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

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

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

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

• תוויות רגילות – 150
• שדות לכל תווית – 10
• תוויות שהמשתמשים החילו על כל קובץ – 5

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

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

פרסום תווית

בעזרת Labels API אפשר לפרסם תווית טיוטה אחרי שהיא מוכנה.

כדי לפרסם תווית, משתמשים בשיטה publish ומציינים:

• משאב Label שמייצג כל תווית. הוא מכיל משאב Name ו-ID, שהוא מזהה ייחודי גלובלי של הלייבל.

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

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

Python

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

Node.js

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

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

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

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

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

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

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