Method: labels.disable

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

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

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

פרמטרים
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

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