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
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-05 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-05 (שעון UTC)."],[],[],null,["# Method: labels.disable\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nDisable a published label. For more information, see [Disable, enable, and delete a label](https://developers.google.com/workspace/drive/labels/guides/disable-delete-label).\n\nDisabling a label will result in a new disabled published revision based on the current published revision. If there's a draft revision, a new disabled draft revision will be created based on the latest draft revision. Older draft revisions will be deleted.\n\nOnce disabled, a label may be deleted with `labels.delete`.\n\n### HTTP request\n\n`POST https://drivelabels.googleapis.com/v2/{name=labels/*}:disable`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------|\n| `name` | `string` Required. Label resource name. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"updateMask\": string, \"useAdminAccess\": boolean, \"writeControl\": { object (/workspace/drive/labels/reference/rest/v2/WriteControl) }, \"disabledPolicy\": { object (/workspace/drive/labels/reference/rest/v2/labels#DisabledPolicy) }, \"languageCode\": string } ``` |\n\n| Fields ||\n|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` The fields that should be updated. At least one field must be specified. The root `disabledPolicy` is implied and should not be specified. A single `*` can be used as a short-hand for updating every field. |\n| `useAdminAccess` | `boolean` Set to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access. |\n| `writeControl` | `object (`[WriteControl](/workspace/drive/labels/reference/rest/v2/WriteControl)`)` Provides control over how write requests are executed. Defaults to unset, which means the last write wins. |\n| `disabledPolicy` | `object (`[DisabledPolicy](/workspace/drive/labels/reference/rest/v2/labels#DisabledPolicy)`)` Disabled policy to use. |\n| `languageCode` | `string` The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Label](/workspace/drive/labels/reference/rest/v2/labels#Label).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive.labels`\n- `\n https://www.googleapis.com/auth/drive.admin.labels`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
