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

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

יצירת תווית

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

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

• LabelType.

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

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

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

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()

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

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

פרסום תווית

ה-API של התוויות מאפשר לכם לפרסם טיוטה של תוויות אחרי שהיא מוכנה.

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

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

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

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

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

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