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

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

יצירת תווית

כדי ליצור תווית, משתמשים ב-method create באוסף labels. אם רוצים, אפשר להוסיף תוויות לרכיב Fields אחד או יותר.

בנוסף, צריך לציין את הפרטים הבאים:

• LabelType.

• תווית title באמצעות ה-method property.

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

בדוגמה הזו נוצרת תווית אדמין רגילה עם שם מוגדר, ותווית אחת 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 מאפשר לך לפרסם תווית טיוטה לאחר השלמתה.

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

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

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

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