REST Resource: labels

משאב: תווית

תווית מגדירה טקסונומיה שניתן להחיל על פריטים ב-Drive כדי לארגן פריטים ולחפש בהם. תוויות יכולות להיות מחרוזות פשוטות, או שהן יכולות להכיל שדות שמתארים מטא-נתונים נוספים שבהם אפשר להשתמש כדי לארגן ולחפש פריטים ב-Drive.

ייצוג JSON
{
  "name": string,
  "id": string,
  "revisionId": string,
  "labelType": enum (LabelType),
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "revisionCreator": {
    object (UserInfo)
  },
  "revisionCreateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "customer": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedLabelPolicy": {
    object (AppliedLabelPolicy)
  },
  "fields": [
    {
      object (Field)
    }
  ],
  "learnMoreUri": string,
  "lockStatus": {
    object (LockStatus)
  }
}
שדות
name

string

פלט בלבד. שם המשאב של התווית. תהיה בצורת labels/{id} או labels/{id}@{revisionId}, בהתאם לבקשה. פרטים נוספים זמינים ב-id וב-revisionId בהמשך.

id

string

פלט בלבד. מזהה ייחודי גלובלי של התווית הזו. המזהה הוא חלק מהתווית name, אבל בניגוד ל-name, המזהה עקבי בין גרסאות קודמות. תואם לביטוי הרגולרי: ([a-zA-Z0-9])+

revisionId

string

פלט בלבד. מזהה הגרסה הקודמת של התווית. מזהה הגרסה הקודמת עשוי להיות חלק מהתווית name, בהתאם לבקשה שנשלחה. בכל פעם שמאפיינים של תווית מסוימת שונו, נוצרת גרסה חדשה. תואם לביטוי הרגולרי: ([a-zA-Z0-9])+

labelType

enum (LabelType)

חובה. סוג התווית.

creator

object (UserInfo)

פלט בלבד. המשתמש שיצר את התווית הזו.

createTime

string (Timestamp format)

פלט בלבד. השעה שבה התווית הזו נוצרה.

revisionCreator

object (UserInfo)

פלט בלבד. המשתמש שיצר את הגרסה הזו של התווית.

revisionCreateTime

string (Timestamp format)

פלט בלבד. השעה שבה נוצרה הגרסה הקודמת של התווית.

publisher

object (UserInfo)

פלט בלבד. המשתמש שפרסם את התווית הזו. לערך הזה אין משמעות כשהתווית לא מתפרסמת.

publishTime

string (Timestamp format)

פלט בלבד. השעה שבה התווית הזו פורסמה. לערך הזה אין משמעות כשהתווית לא מתפרסמת.

disabler

object (UserInfo)

פלט בלבד. המשתמש שהשבית את התווית הזו. לערך הזה אין משמעות כשהתווית לא מושבתת.

disableTime

string (Timestamp format)

פלט בלבד. הזמן שבו התווית הזו הושבתה. לערך הזה אין משמעות כשהתווית לא מושבתת.

customer

string

פלט בלבד. הלקוח שאליו שייכת התווית. לדוגמה: "customers/123abc789".

properties

object (Properties)

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

lifecycle

object (Lifecycle)

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

displayHints

object (DisplayHints)

פלט בלבד. ממשק המשתמש שמציג רמזים לעיבוד התווית.

appliedCapabilities

object (AppliedCapabilities)

פלט בלבד. היכולות שקשורות לתווית הזאת במטא-נתונים שהוחלו.

schemaCapabilities

object (SchemaCapabilities)

פלט בלבד. היכולות שיש למשתמש בתווית הזו.

appliedLabelPolicy

object (AppliedLabelPolicy)

פלט בלבד. ההתנהגות של התווית הזו כשהיא מיושמת על פריטים ב-Drive.

fields[]

object (Field)

רשימת שדות בסדר עדיפות יורד.

learnMoreUri

string

כתובת URL מותאמת אישית להצגה למשתמשים כדי שיוכלו לקבל מידע נוסף על התווית הזו ואיך יש להשתמש בה.

lockStatus

object (LockStatus)

פלט בלבד. סטטוס הנעילה של התווית הזו.

LabelType

סוג התווית הזו.

טיפוסים בני מנייה (enums)
LABEL_TYPE_UNSPECIFIED סוג תווית לא ידוע.
SHARED אפשר לשתף תוויות משותפות עם משתמשים כדי להחיל אותן על פריטים ב-Drive.
ADMIN תווית בבעלות האדמין. רק אדמינים יכולים ליצור ולערוך את הנתונים. יש תמיכה בכמה תכונות נוספות שזמינות לאדמין בלבד.

UserInfo

מידע על משתמש.

ייצוג JSON
{
  "person": string
}
שדות
person

string

המזהה של המשתמש הזה שניתן להשתמש בו עם ה-People API כדי לקבל מידע נוסף. לדוגמה, people/12345678.

תכונות

מאפיינים בסיסיים של התווית.

ייצוג JSON
{
  "title": string,
  "description": string
}
שדות
title

string

חובה. שם התווית.

description

string

תיאור התווית.

מחזור חיים

מצב מחזור החיים של אובייקט, כמו תווית, שדה או בחירה. מחזור החיים אוכף את המעברים הבאים:

  • UNPUBLISHED_DRAFT (מצב התחלה)
  • UNPUBLISHED_DRAFT -> PUBLISHED
  • UNPUBLISHED_DRAFT -> (נמחקה)
  • PUBLISHED -> DISABLED
  • DISABLED -> PUBLISHED
  • DISABLED -> (נמחקה)

למצבים שפורסמו והושבתו יש כמה מאפיינים ייחודיים:

  • פורסם – יש כמה סוגים של שינויים באובייקט שנמצא במצב הזה, ובמקרה כזה hasUnpublishedChanges יהיה True. כמו כן, סוגים מסוימים של שינויים אסורים. באופן כללי, כל שינוי שיבטל את התוקף או יגרום להגבלות חדשות על מטא-נתונים קיימים שקשורים לתווית נדחה.
  • מושבתת – כשהמדיניות מושבתת, DisabledPolicy שהוגדר ייכנס לתוקף.
ייצוג JSON
{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
שדות
state

enum (State)

פלט בלבד. מצב העצם המשויך למחזור החיים הזה.

hasUnpublishedChanges

boolean

פלט בלבד. אם באובייקט המשויך למחזור החיים הזה יש שינויים שלא פורסמו.

disabledPolicy

object (DisabledPolicy)

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

ארץ

מצב העצם המשויך למחזור החיים הזה.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED מצב לא ידוע.
UNPUBLISHED_DRAFT המצב הראשוני של אובייקט. לאחר הפרסום, האובייקט לא יכול לחזור למצב הזה אף פעם. לאחר פרסום אובייקט, סוגי שינויים מסוימים אינם מותרים יותר.
PUBLISHED האובייקט פורסם. ייתכן שבאובייקט יש שינויי טיוטה שלא פורסמו, כפי שצוין על ידי hasUnpublishedChanges.
DISABLED האובייקט פורסם והושבת מאז. ייתכן שבאובייקט יש שינויי טיוטה שלא פורסמו, כפי שצוין על ידי hasUnpublishedChanges.
DELETED האובייקט נמחק.

DisabledPolicy

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

ייצוג JSON
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
שדות
showInApply

boolean

האם להציג את האובייקט המושבת בתפריט היישום של פריטים ב-Drive.

  • כשהערך הוא true, האובייקט מוצג בדרך כלל בממשק המשתמש כמושבת ולא ניתן לבחור אותו.
  • כשהערך הוא false, האובייקט מוסתר בדרך כלל בממשק המשתמש.

DisplayHints

ממשק המשתמש שמציג רמזים לעיבוד התווית.

ייצוג JSON
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
שדות
disabled

boolean

האם יש להציג את התווית בממשק המשתמש כמושבתת.

shownInApply

boolean

התווית אמורה להופיע בתפריט ההחלה כשמחילים ערכים על פריט ב-Drive.

priority

string (int64 format)

הזמנה להצגת תווית ברשימה.

AppliedCapabilities

היכולות שיש למשתמש במטא-נתונים שהוחלו על התווית.

ייצוג JSON
{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}
שדות
canRead

boolean

אם המשתמש יכול לקרוא מטא-נתונים שהוחלו שקשורים לתווית הזו.

canApply

boolean

האם המשתמש יכול להחיל את התווית הזו על פריטים.

canRemove

boolean

אם המשתמש יכול להסיר את התווית הזו מפריטים.

SchemaCapabilities

היכולות שקשורות לתווית בזמן עריכת התווית.

ייצוג JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
שדות
canUpdate

boolean

האם המשתמש יכול לשנות את התווית הזו.

canDelete

boolean

האם המשתמש יכול למחוק את התווית הזו. למשתמש צריכה להיות הרשאה והתווית חייבת להיות מושבתת.

canDisable

boolean

האם המשתמש יכול להשבית את התווית הזו. למשתמש צריכה להיות הרשאה, ואין להשבית את התווית הזו לפני כן.

canEnable

boolean

האם המשתמש יכול להפעיל את התווית הזו. למשתמש צריכה להיות הרשאה ויש להשבית את התווית הזו.

AppliedLabelPolicy

ההתנהגות של התווית הזו כשהיא מיושמת על פריטים ב-Drive.

ייצוג JSON
{
  "copyMode": enum (CopyMode)
}
שדות
copyMode

enum (CopyMode)

מציין איך צריך להעתיק את ערכי התווית והשדות שהוחלו כשמעתיקים פריט ב-Drive.

CopyMode

מציין איך צריך להעתיק את ערכי התווית והשדות שהוחלו כשמעתיקים פריט ב-Drive.

טיפוסים בני מנייה (enums)
COPY_MODE_UNSPECIFIED מצב ההעתקה לא צוין.
DO_NOT_COPY כברירת מחדל, הערכים של התווית והשדות שהוחלו לא מועתקים כשהפריט ב-Drive שעליו הם מיושמים מועתק.
ALWAYS_COPY הערכים של התווית והשדות שהוחלו תמיד מועתקים כשהפריט ב-Drive שעליו הם מיושמים מועתק. רק אדמינים יכולים להשתמש במצב הזה.
COPY_APPLIABLE הערכים של התווית והשדות שהוחלו מועתקים אם התווית חלה על המשתמש שיוצר את העותק.

שדה

מגדיר שדה עם שם מוצג, סוג נתונים ואפשרויות הגדרה נוספות. השדה הזה מגדיר את סוג המטא-נתונים שניתן להגדיר לפריט ב-Drive.

ייצוג JSON
{
  "id": string,
  "queryKey": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  },

  // Union field type can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type.
}
שדות
id

string

פלט בלבד. מפתח של שדה, ייחודי בתווית או בספרייה.

הערך הזה נוצר באופן אוטומטי. תואם לביטוי הרגולרי: ([a-zA-Z0-9])+

queryKey

string

פלט בלבד. המפתח שמשתמשים בו כשיוצרים שאילתות חיפוש ב-Drive כדי למצוא קבצים על סמך ערכים שהוגדרו לשדה הזה בקבצים. לדוגמה, "{queryKey} > 2001-01-01".

properties

object (Properties)

המאפיינים הבסיסיים של השדה.

lifecycle

object (Lifecycle)

פלט בלבד. מחזור החיים של השדה הזה.

displayHints

object (DisplayHints)

פלט בלבד. ממשק המשתמש שמציג רמזים לעיבוד שדה.

schemaCapabilities

object (SchemaCapabilities)

פלט בלבד. היכולות שיש למשתמש בזמן עריכת השדה הזה.

appliedCapabilities

object (AppliedCapabilities)

פלט בלבד. היכולות של המשתמש בשדה הזה והערך שלו כשהתווית חלה על פריטים ב-Drive.

creator

object (UserInfo)

פלט בלבד. המשתמש שיצר את השדה הזה.

createTime

string (Timestamp format)

פלט בלבד. השעה שבה השדה הזה נוצר.

updater

object (UserInfo)

פלט בלבד. המשתמש שביצע שינויים בשדה הזה.

updateTime

string (Timestamp format)

פלט בלבד. השעה שבה השדה הזה עודכן.

publisher

object (UserInfo)

פלט בלבד. המשתמש שפרסם את השדה הזה. לערך הזה אין משמעות כשהשדה לא מתפרסם.

disabler

object (UserInfo)

פלט בלבד. המשתמש שהשבית את השדה הזה. לערך הזה אין משמעות כשהשדה לא מושבת.

disableTime

string (Timestamp format)

פלט בלבד. השעה שבה השדה הזה הושבת. לערך הזה אין משמעות כשהשדה לא מושבת.

lockStatus

object (LockStatus)

פלט בלבד. מצב LockStatus של השדה הזה.

שדה איחוד type. סוג הנתונים והאפשרויות בשדה הזה. לאחר הפרסום, לא ניתן לשנות את סוג הנתונים. הערך של type יכול להיות רק אחת מהאפשרויות הבאות:
textOptions

object (TextOptions)

אפשרויות של שדה טקסט.

integerOptions

object (IntegerOptions)

אפשרויות לשדה מסוג מספר שלם.

dateOptions

object (DateOptions)

אפשרויות לשדה התאריך.

selectionOptions

object (SelectionOptions)

אפשרויות של שדה בחירה.

userOptions

object (UserOptions)

אפשרויות לשדה המשתמש.

TextOptions

אפשרויות עבור סוג השדה 'טקסט'.

ייצוג JSON
{
  "minLength": integer,
  "maxLength": integer
}
שדות
minLength

integer

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

maxLength

integer

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

IntegerOptions

אפשרויות לסוג השדה 'מספר שלם'.

ייצוג JSON
{
  "minValue": string,
  "maxValue": string
}
שדות
minValue

string (int64 format)

פלט בלבד. הערך המינימלי החוקי בשדה 'מספר שלם'.

maxValue

string (int64 format)

פלט בלבד. הערך החוקי המקסימלי בשדה המספר השלם.

DateOptions

אפשרויות לסוג שדה התאריך.

ייצוג JSON
{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}
שדות
dateFormatType

enum (DateFormat)

אפשרות של עיצוב תאריך מקומי. העיבוד של ערכי השדות מתבצע בפורמט הזה בהתאם ללוקאל שלהם.

dateFormat

string

פלט בלבד. פורמט התאריך של ה-ICU.

minValue

object (Date)

פלט בלבד. ערך חוקי מינימלי (שנה, חודש, יום).

maxValue

object (Date)

פלט בלבד. ערך חוקי מקסימלי (שנה, חודש, יום).

DateFormat

אפשרויות של פורמט תאריך מקומי.

טיפוסים בני מנייה (enums)
DATE_FORMAT_UNSPECIFIED לא צוין פורמט תאריך.
LONG_DATE כולל שם חודש מלא. לדוגמה, 12 בינואר 1999 (MMMM d, y)
SHORT_DATE קצר, מספרי, ייצוגי. לדוגמה, 12/13/99 (M/d/yy)

SelectionOptions

אפשרויות לסוג של שדה הבחירה.

ייצוג JSON
{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}
שדות
listOptions

object (ListOptions)

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

choices[]

object (Choice)

האפשרויות הזמינות לשדה הבחירה הזה. סדר הרשימות עקבי והשתנה באמצעות insertBeforeChoice.

ListOptions

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

ייצוג JSON
{
  "maxEntries": integer
}
שדות
maxEntries

integer

מספר הערכים המרבי המותר.

Choice

בחירת שדה בחירה.

ייצוג JSON
{
  "id": string,
  "properties": {
    object (Properties)
  },
  "lifecycle": {
    object (Lifecycle)
  },
  "displayHints": {
    object (DisplayHints)
  },
  "schemaCapabilities": {
    object (SchemaCapabilities)
  },
  "appliedCapabilities": {
    object (AppliedCapabilities)
  },
  "creator": {
    object (UserInfo)
  },
  "createTime": string,
  "updater": {
    object (UserInfo)
  },
  "updateTime": string,
  "publisher": {
    object (UserInfo)
  },
  "publishTime": string,
  "disabler": {
    object (UserInfo)
  },
  "disableTime": string,
  "lockStatus": {
    object (LockStatus)
  }
}
שדות
id

string

הערך הייחודי של הבחירה. המזהה הזה נוצר באופן אוטומטי. תואם לביטוי הרגולרי: ([a-zA-Z0-9_])+.

properties

object (Properties)

מאפיינים בסיסיים שבחרתם.

lifecycle

object (Lifecycle)

פלט בלבד. מחזור חיים לפי בחירה.

displayHints

object (DisplayHints)

פלט בלבד. רמזים להצגת אפשרויות בממשק המשתמש.

schemaCapabilities

object (SchemaCapabilities)

פלט בלבד. היכולות שקשורות לאפשרות הזו כשעורכים את האפשרות.

appliedCapabilities

object (AppliedCapabilities)

פלט בלבד. היכולות שקשורות לבחירה הזו לגבי מטא-נתונים שהוחלו.

creator

object (UserInfo)

פלט בלבד. המשתמש שיצר את הבחירה.

createTime

string (Timestamp format)

פלט בלבד. השעה שבה הבחירה הזו נוצרה.

updater

object (UserInfo)

פלט בלבד. המשתמש שעדכן את הבחירה הזו לאחרונה.

updateTime

string (Timestamp format)

פלט בלבד. הפעם האחרונה שבה הבחירה הזו עודכנה.

publisher

object (UserInfo)

פלט בלבד. המשתמש שפרסם את הבחירה הזו. לערך הזה אין משמעות כשהבחירה לא מתפרסמת.

publishTime

string (Timestamp format)

פלט בלבד. התאריך שבו הבחירה הזו פורסמה. לערך הזה אין משמעות כשהבחירה לא מתפרסמת.

disabler

object (UserInfo)

פלט בלבד. המשתמש שהשבית את הבחירה. לערך הזה אין משמעות כשהאפשרות לא מושבתת.

disableTime

string (Timestamp format)

פלט בלבד. הזמן שבו הבחירה הזו הושבתה. לערך הזה אין משמעות כשהבחירה לא מושבתת.

lockStatus

object (LockStatus)

פלט בלבד. מצב LockStatus באפשרות הזו.

תכונות

מאפיינים בסיסיים שבחרתם.

ייצוג JSON
{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}
שדות
displayName

string

חובה. הטקסט לתצוגה שיש להציג בממשק המשתמש שמזהה את השדה הזה.

description

string

התיאור של התווית הזו.

badgeConfig

object (BadgeConfig)

תצורת התג של אפשרות זו. אחרי שמגדירים את האפשרות, התווית שהיא הבעלים של הבחירה הזו נחשבת ל "תווית עם תג".

insertBeforeChoice

string

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

BadgeConfig

סטטוס התג של התווית.

ייצוג JSON
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
שדות
color

object (Color)

צבע התג. אם לא מציינים שום תג, לא מוצג תג. צבעי הרקע, החזית והסולו (במצב בהיר או כהה) שהוגדרו כאן משתנים בממשק המשתמש של Drive, לצבע הנתמך הקרוב ביותר.

priorityOverride

string (int64 format)

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

DisplayHints

ממשק המשתמש שמציג רמזים לעיבוד אפשרות.

ייצוג JSON
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
שדות
disabled

boolean

האם יש להציג את האפשרות כמושבתת בממשק המשתמש.

shownInApply

boolean

האפשרות הזו צריכה להופיע בתפריט 'החלה' כשמחילים ערכים על פריט ב-Drive.

badgeColors

object (BadgeColors)

הצבעים לשימוש בתג. השתנה לצבעים של Google Material על סמך properties.badge_config.color שנבחרו.

darkBadgeColors

object (BadgeColors)

צבע המצב הכהה לשימוש בתג. השתנה לצבעים של Google Material על סמך properties.badge_config.color שנבחרו.

badgePriority

string (int64 format)

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

BadgeColors

הצבע שנגזר מ-BadgeConfig והשתנה לצבע הנתמך הקרוב ביותר.

ייצוג JSON
{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}
שדות
backgroundColor

object (Color)

פלט בלבד. רקע של תג שמתאים לחזית.

foregroundColor

object (Color)

פלט בלבד. תג קדמי שמתאים לרקע.

soloColor

object (Color)

פלט בלבד. צבע שאפשר להשתמש בו לטקסט בלי רקע.

SchemaCapabilities

היכולות שקשורות לבחירה הזו בזמן עריכת הבחירה.

ייצוג JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
שדות
canUpdate

boolean

האם המשתמש יכול לעדכן את הבחירה הזו.

canDelete

boolean

אם המשתמש יכול למחוק את האפשרות הזו.

canDisable

boolean

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

canEnable

boolean

האם המשתמש יכול להפעיל את הבחירה הזו.

AppliedCapabilities

היכולות שקשורות לבחירה הזו לגבי מטא-נתונים שהוחלו.

ייצוג JSON
{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}
שדות
canRead

boolean

האם המשתמש יכול לקרוא מטא-נתונים קשורים שהוחלו על פריטים.

canSelect

boolean

האם המשתמש יכול לבחור את האפשרות הזו בפריט.

LockStatus

מכיל מידע שלפיו יש להחשיב רכיב תווית נעול.

ייצוג JSON
{
  "locked": boolean
}
שדות
locked

boolean

פלט בלבד. מציין אם רכיב תווית זה הוא היעד (ישיר) של LabelLock. רכיב תווית יכול להינעל באופן מפורש גם אם הוא לא היעד הישיר של LabelLock, ובמקרה כזה השדה הזה מוגדר כ-False.

UserOptions

אפשרויות עבור סוג השדה של המשתמש.

ייצוג JSON
{
  "listOptions": {
    object (ListOptions)
  }
}
שדות
listOptions

object (ListOptions)

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

תכונות

המאפיינים הבסיסיים של השדה.

ייצוג JSON
{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}
שדות
displayName

string

חובה. הטקסט לתצוגה שיש להציג בממשק המשתמש שמזהה את השדה הזה.

required

boolean

האם יש לסמן את השדה כחובה.

insertBeforeField

string

קלט בלבד. מוסיפים או מעבירים את השדה הזה לפני השדה שצוין. אם השדה הזה ריק, השדה יופיע בסוף הרשימה.

DisplayHints

ממשק המשתמש שמציג רמזים לעיבוד שדה.

ייצוג JSON
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
שדות
required

boolean

האם יש להציג את השדה כפי שנדרש בממשק המשתמש.

disabled

boolean

האם יש להציג את השדה בממשק המשתמש כמושבת.

shownInApply

boolean

השדה הזה צריך להופיע בתפריט ההחלה כשמחילים ערכים על פריט ב-Drive.

SchemaCapabilities

היכולות שקשורות לשדה הזה בזמן עריכת השדה.

ייצוג JSON
{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}
שדות
canUpdate

boolean

האם המשתמש יכול לשנות את השדה הזה.

canDelete

boolean

האם המשתמש יכול למחוק את השדה הזה. למשתמש צריכה להיות הרשאה, ויש להוציא את השדה משימוש.

canDisable

boolean

האם המשתמש יכול להשבית את השדה הזה. למשתמש צריכה להיות הרשאה, ואי אפשר להשבית את השדה הזה.

canEnable

boolean

האם המשתמש יכול להפעיל את השדה הזה. למשתמש צריכה להיות הרשאה ויש להשבית את השדה הזה.

AppliedCapabilities

היכולות שקשורות לשדה הזה לגבי מטא-נתונים שהוחלו.

ייצוג JSON
{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}
שדות
canRead

boolean

האם המשתמש יכול לקרוא מטא-נתונים קשורים שהוחלו על פריטים.

canWrite

boolean

האם המשתמש יכול להגדיר את השדה הזה בפריטים ב-Drive.

שיטות

create

יצירת תווית חדשה.

delete

מוחקת לצמיתות תווית ומטא-נתונים קשורים בפריטים ב-Drive.

delta

מעדכן תווית בודדת על ידי החלת קבוצה של בקשות עדכון שמובילה לגרסה חדשה של טיוטה.

disable

השבתת תווית שפורסמה.

enable

הפעל תווית מושבתת ושחזר אותה למצבה שפורסם.

get

קבלת תווית לפי שם המשאב שלה.

list

הצגת רשימה של תוויות.

publish

מפרסמים את כל שינויי הטיוטה בתווית.

updateLabelCopyMode

מעדכן CopyMode של תווית.

updatePermissions

עדכון הרשאות של תווית.