בדף הזה נסביר איך לבצע את המשימות הבאות שקשורות לתוויות:
- השבתת תווית
- הפעלת תווית
- מחיקת תווית
השבתת תווית
השבתת תווית יוצרת גרסה חדשה שפרסמה ומושבתת על סמך הגרסה הקיימת שפורסמה. אם יש גרסה של טיוטה, נוצרת גרסה חדשה של טיוטה מושבתת על סמך הגרסה האחרונה של טיוטה. גרסאות קודמות של טיוטות נמחקות. מידע נוסף זמין במאמר מחזור החיים של תוויות.
גם אחרי השבתה, המשתמשים עדיין יכולים להחיל את התווית הזו דרך ה-API. התווית עדיין מופיעה במקומות שבהם כבר החילו אותה וגם בתוצאות החיפוש. אפשר למחוק תווית מושבתת.
כדי להשבית תווית שפורסמה, משתמשים ב-method disable
באוסף labels
.
בנוסף, צריך לציין את הפרטים הבאים:
משאב תווית שמייצג כל תווית. הוא מכיל את המשאב
Name
ואתID
, שהוא מזהה ייחודי גלובלי של התווית.useAdminAccess
הואtrue
כדי להשתמש בפרטי הכניסה של האדמין של המשתמש. לפני שהשרת מאפשר גישה, הוא מוודא שהמשתמש הוא אדמין של התווית.
בדוגמה הזו נעשה שימוש ב-ID
כדי להשבית את התווית הנכונה.
Python
service.labels().disable(
name='labels/ID',
body={
'use_admin_access': True
}).execute()
Node.js
service.labels.disable({
'resource': {
'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
התווית כוללת את State
של DISABLED
ומזהה הגרסה הקודמת של התווית עולה. המשתמשים יכולים להחיל את התווית דרך ה-API. עם זאת, תווית מושבתת לא מוצגת בממשק משתמש אלא אם הנכס showInApply
של השיטה disabledPolicy
מוגדר.
הפעלת תווית
הפעלה של תווית מושבתת מחזירה אותה למצב הפרסום שלה. התוצאה היא גרסה חדשה שפורסמה על סמך הגרסה הפורסמת המושבתת הנוכחית. אם יש גרסה קיימת של טיוטה מושבתת, נוצרת גרסה חדשה על סמך הטיוטה הזו והיא מופעלת. מידע נוסף זמין במאמר מחזור החיים של תוויות.
כדי להפעיל תווית מושבתת, משתמשים ב-method enable
.
בנוסף, צריך לציין את הפרטים הבאים:
משאב תווית שמייצג כל תווית. הוא מכיל את המשאב
Name
ואתID
, שהוא מזהה ייחודי גלובלי של התווית.useAdminAccess
הואtrue
כדי להשתמש בפרטי הכניסה של האדמין של המשתמש. לפני שהשרת מאפשר גישה, הוא מוודא שהמשתמש הוא אדמין של התווית.
בדוגמה הזו נעשה שימוש ב-ID
כדי להפעיל את התווית הנכונה.
Python
service.labels().enable(
name='labels/ID',
body={
'use_admin_access': True
}).execute()
Node.js
service.labels.enable({
'resource': {
'use_admin_access': true
},
'name': 'labels/ID'
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
התווית כוללת את State
של PUBLISHED
ומזהה הגרסה הקודמת של התווית עולה. המשתמשים יכולים להציג את התווית ולהחיל אותה על קבצים דרך ה-API.
מחיקת תווית
אפשר למחוק רק תוויות בטיוטה ותוויות מושבתות. כשמוחקים תווית, כל המופעים שבהם היא הוחלתה בעבר, כולל ערכים תואמים של שדות שהמשתמשים הזינו, נמחקים לצמיתות ומוסרים מהקבצים האלה ב-Drive.
כדי למחוק תווית, צריך קודם להשבית אותה ואז להשתמש ב-method delete
.
בנוסף, צריך לציין את הפרטים הבאים:
משאב תווית שמייצג כל תווית. הוא מכיל את המשאב
Name
ואתID
, שהוא מזהה ייחודי גלובלי של התווית.useAdminAccess
הואtrue
כדי להשתמש בפרטי הכניסה של האדמין של המשתמש. לפני שהשרת מאפשר גישה, הוא מוודא שהמשתמש הוא אדמין של התווית.
בדוגמה הזו נעשה שימוש בדגל ID
כדי למחוק את התווית הנכונה.
Python
response = service.labels().delete(
name='labels/ID',
useAdminAccess=True).execute()
Node.js
service.labels.delete({
'name': 'labels/ID',
'use_admin_access': true
}, (err, res) => {
if (err) return console.error('The API returned an error: ' + err);
console.log(res);
});
התווית כוללת את State
של DELETED
ומזהה הגרסה הקודמת של התווית עולה. לא ניתן יהיה להחיל את התווית, ובסופו של דבר תוויות שנמחקו יימחקו לתמיד. למידע נוסף, תוכלו לקרוא את הקטע מחזור החיים של תוויות.