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)
  },
  "enabledAppSettings": {
    object (EnabledAppSettings)
  }
}
שדות
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)

פלט בלבד. ב-UI מוצגות רמזים לרינדור התווית.
appliedCapabilities

object (AppliedCapabilities)

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

object (SchemaCapabilities)

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

object (AppliedLabelPolicy)

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

object (Field)

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

string

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

object (LockStatus)

פלט בלבד. הערך של LockStatus בתווית הזו.
enabledAppSettings

object (EnabledAppSettings)

אופציונלי. ההגדרות של EnabledAppSettings עבור התווית הזו.

LabelType

סוג התווית.

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

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)

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

מדינה

המצב של האובייקט שמשויך למחזור החיים הזה.

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

DisabledPolicy

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

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

boolean

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

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

DisplayHints

ב-UI מוצגות רמזים לרינדור התווית.

ייצוג ב-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.

טיפוסים בני מנייה (enum)
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

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

ייצוג ב-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

פלט בלבד. פורמט התאריך בטיפול נמרץ.
minValue

object (Date)

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

object (Date)

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

DateFormat

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

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

תאריך

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

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

סוגים קשורים:

ייצוג ב-JSON 
{
  "year": integer,
  "month": integer,
  "day": integer
}
שדות
year

integer

השנה של התאריך. חייב להיות בין 1 ל-9999, או 0 כדי לציין תאריך ללא שנה.
month

integer

החודש בשנה. הערך צריך להיות בין 1 ל-12, או 0 כדי לציין שנה ללא חודש ויום.
day

integer

היום בחודש. הערך חייב להיות בין 1 ל-31 ותקף לשנה ולחודש, או 0 כדי לציין שנה בלבד או שנה וחודש שבהם היום לא רלוונטי.

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, המערכת משתמשת בהויריסטיקה של ברירת המחדל לעדיפות.

צבע

מייצג צבע במרחב הצבעים RGBA. הייצוג הזה נועד לפשט את ההמרה אליו וממנו של ייצוגי צבעים בשפות שונות, על חשבון הקומפקטיות. לדוגמה, אפשר לספק בקלות את השדות של הייצוג הזה למבנה ה-constructor של java.awt.Color ב-Java, ואפשר גם לספק אותו בקלות לשיטה +colorWithRed:green:blue:alpha של UIColor ב-iOS. בנוסף, אפשר לעצב אותו בקלות כמחרוזת rgba() של CSS ב-JavaScript, בלי הרבה עבודה.

בדף העזרה הזה אין מידע על מרחב הצבעים המוחלט שבו צריך להשתמש כדי לפרש את ערך ה-RGB – לדוגמה, sRGB,‏ Adobe RGB,‏ DCI-P3 ו-BT.2020. כברירת מחדל, אפליקציות צריכות להניח שמרחב הצבעים הוא sRGB.

כשצריך להחליט אם שני צבעים זהים, בהטמעות, אלא אם צוין אחרת, שני צבעים נחשבים זהים אם כל הערכים שלהם באדום, ירוק, כחול ואלפא שונים זה מזה ב-1e-5 לכל היותר.

דוגמה (Java):

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

דוגמה (iOS / Obj-C):

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

דוגמה (JavaScript):

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...
ייצוג ב-JSON 
{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}
שדות
red

number

מידת האדום בצבע כערך בטווח [0, 1].
green

number

מידת הגוון הירוק בצבע כערך בטווח [0, 1].
blue

number

כמות הכחול בצבע כערך בטווח [0, 1].
alpha

number

החלק של הצבע הזה שצריך להחיל על הפיקסל. כלומר, צבע הפיקסל הסופי מוגדר לפי המשוואה:

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

כלומר, ערך של 1.0 מתאים לצבע מוצק, ואילו ערך של 0.0 מתאים לצבע שקוף לחלוטין. המערכת משתמשת בהודעת עטיפה במקום במשתנה סקלרי פשוט של צורה רגולרית, כדי שאפשר יהיה להבדיל בין ערך ברירת מחדל לבין הערך שלא הוגדר. אם משמיטים את הערך, אובייקט הצבע הזה יומר כצבע אחיד (כאילו ערך האלפא הוגדר במפורש כ-1.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 או כ-heuristic של ברירת המחדל, שמעדיף את תאריך היצירה של התווית ואת העדיפות של השדה והאפשרות.

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.

EnabledAppSettings

תיאור האפליקציות ב-Workspace שבהן אפשר להשתמש בתווית.

ייצוג ב-JSON 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
שדות
enabledApps[]

object (EnabledApp)

אופציונלי. רשימת האפליקציות שבהן אפשר להשתמש בתווית.

EnabledApp

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

ייצוג ב-JSON 
{
  "app": enum (App)
}
שדות
app

enum (App)

אופציונלי. שם האפליקציה.

אפליקציה

קבוצת האפליקציות האפשריות של Workspace שבהן אפשר להשתמש בתוויות.

טיפוסים בני מנייה (enum)
APP_UNSPECIFIED לא צוין
DRIVE Drive.
GMAIL Gmail

Methods

create

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

delete

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

delta

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

disable

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

enable

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

get

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

list

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

publish

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

updateLabelCopyMode

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

updateLabelEnabledAppSettings

 עדכון של EabledAppSettings של תווית.

updatePermissions

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