Method: labels.disable

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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