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

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

יצירת תווית

כדי ליצור תווית, משתמשים ב-method‏ 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' או כ'קצר: MM/DD/YY'.
TextOptions	הזנת טקסט בתיבת טקסט	מספר התווים המקסימלי שנתמך הוא 100
UserOptions	בוחרים משתמש אחד או יותר מאנשי הקשר ב-Google Workspace.	המספר המקסימלי של רשומות משתמשים בקובץ הוא 10, כפי שמוגדר בקובץ ListOptions

פרסום תווית

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

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

• משאב תווית שמייצג כל תווית. הוא מכיל את המשאב 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 משתנה.
  • עדכונים באפשרויות של אימות השדות עשויים לדחות נתונים שאושרו בעבר.
  • צמצום במספר הערכים המקסימלי.