Method: labels.disable

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

לאחר ההשבתה, אפשר למחוק את התווית עם labels.delete.

בקשת HTTP

POST https://drivelabels.googleapis.com/v2/{name=labels/*}:disable

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב של התווית.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "updateMask": string,
  "useAdminAccess": boolean,
  "writeControl": {
    object (WriteControl)
  },
  "disabledPolicy": {
    object (DisabledPolicy)
  },
  "languageCode": string
}
שדות
updateMask

string (FieldMask format)

השדות שצריך לעדכן. יש לציין לפחות שדה אחד. השורש disabledPolicy הוא משתמע ואין לציין אותו. אפשר להשתמש ב-* כקיצור דרך לעדכון כל שדה.
useAdminAccess

boolean

כדי להשתמש בפרטי הכניסה של האדמין של המשתמש צריך להגדיר את הערך true. השרת יאמת שהמשתמש הוא מנהל המערכת של התווית לפני שיתיר גישה.
writeControl

object (WriteControl)

שליטה על האופן שבו בקשות כתיבה מבוצעות. ברירת המחדל היא לא מוגדרת, והמשמעות היא שהכתיבה האחרונה מנצחת.
disabledPolicy

object (DisabledPolicy)

המדיניות מושבתת לשימוש.
languageCode

string

קוד השפה BCP-47 שבו צריך להשתמש כדי להעריך תוויות של שדות שהותאמו לשוק המקומי. אם לא בחרת לעשות זאת, ייעשה שימוש בערכים בשפה שהוגדרה כברירת המחדל.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של Label.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

למידע נוסף, עיינו במדריך ההרשאות.