REST Resource: labels

משאב: תווית

התווית מגדירה טקסונומיה שאפשר להחיל על פריטים ב-Drive כדי לארגן ולחפש פריטים בין פריטים ב-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

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

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

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

פלט בלבד. סטטוס הנעילה של השדה הזה.
שדה איחוד 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

פלט בלבד. פורמט תאריך של טיפול נמרץ.
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

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

בחירה

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

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

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

מאפיינים

מאפיינים בסיסיים לפי בחירה.

ייצוג 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; אפשר גם לספק אותו באופן טריוויאלי ל-method +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 מייצג צבע שקוף לחלוטין. הפעולה הזו משתמשת בהודעת wrapper במקום בסקלר צף פשוט כדי שאפשר יהיה להבחין בין ערך ברירת מחדל לערך שאינו מוגדר. אם לא מציינים את הפרמטר הזה, האובייקט של הצבע מוצג כצבע אחיד (כאילו צוין ערך אלפא שניתן באופן מפורש לערך 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 על סמך properties.badge_config.color שנבחרו.
darkBadgeColors

object (BadgeColors)

הצבע במצב כהה שבו יש להשתמש בתג. השתנה לצבעי 'חומר' של Google על סמך 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

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