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)

פלט בלבד. רמזים לתצוגה בממשק המשתמש לגבי עיבוד התווית.
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 -> (נמחק)

למצבים 'פורסם' ו'מושבת' יש מאפיינים שונים:

  • ‫Published: אפשר לבצע שינויים מסוימים באובייקט במצב הזה, ובמקרה כזה הערך של hasUnpublishedChanges יהיה true. בנוסף, יש שינויים שאסור לבצע. באופן כללי, כל שינוי שיגרום לביטול של מטא-נתונים קיימים שקשורים לתווית או להגבלות חדשות עליהם יידחה.
  • ‫Disabled: אם משביתים את ההגדרה הזו, ההגדרה 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)

פלט בלבד. ה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

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

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

תאריך

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

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

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

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

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

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

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

object (EnabledApp)

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

EnabledApp

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

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

enum (App)

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

אפליקציה

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

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

Methods

create

 יצירת תווית.

delete

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

delta

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

disable

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

enable

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

get

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

list

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

publish

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

updateLabelCopyMode

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

updateLabelEnabledAppSettings

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

updatePermissions

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