REST Resource: labels

資源：Label

標籤定義了可套用至雲端硬碟項目的分類，方便您整理及搜尋項目。標籤可以是簡單的字串，也可以包含描述額外中繼資料的欄位，進一步用於整理及搜尋雲端硬碟項目。

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

僅供輸出。這個標籤的全域專屬 ID。ID 是 name 標籤的一部分，但與 name 不同的是，ID 在修訂版本之間保持一致。與規則運算式「([a-zA-Z0-9])+」相符。
revisionId

string

僅供輸出。標籤的修訂版本 ID。視發出的要求而定，修訂版本 ID 可能會是標籤 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)

僅供輸出。將這個標籤套用至雲端硬碟項目時的行為。
fields[]

object (Field)

依優先順序遞減排序的欄位清單。
learnMoreUri

string

向使用者顯示的自訂網址，可讓他們進一步瞭解這個標籤和使用方式。
lockStatus

object (LockStatus)

僅供輸出。這個標籤的 LockStatus。
enabledAppSettings

object (EnabledAppSettings)

(選用步驟) 這個標籤的 EnabledAppSettings。

LabelType

這個標籤的類型。

列舉
LABEL_TYPE_UNSPECIFIED 不明標籤類型。
SHARED 共用標籤可與使用者共用，方便他們套用至雲端硬碟項目。
ADMIN 管理員擁有的標籤。只有管理員可以建立及編輯。支援部分僅限管理員使用的額外功能。
GOOGLE_APP 標籤由 Google 內部應用程式擁有，而非客戶。這些標籤是唯讀標籤。

UserInfo

使用者的相關資訊。

JSON 表示法 
{
  "person": string
}
欄位
person

string

這個使用者的 ID，可與 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)

這項政策可控管如何顯示已停用的標籤、欄位或選項。

州

與這個生命週期相關聯的物件狀態。

列舉
STATE_UNSPECIFIED 狀態不明。
UNPUBLISHED_DRAFT 物件的初始狀態。物件發布後，就無法再回到這個狀態。發布物件後，就無法再進行特定類型的變更。
PUBLISHED 物件已發布。物件可能含有未發布的草稿變更，如 hasUnpublishedChanges 所示。
DISABLED 物件已發布，但隨後遭到停用。物件可能含有未發布的草稿變更，如 hasUnpublishedChanges 所示。
DELETED 物件已刪除。

DisabledPolicy

這項政策會控管在不同情況下，如何處理已停用的標籤、欄位或選項。

JSON 表示法 
{
  "hideInSearch": boolean,
  "showInApply": boolean
}
欄位
showInApply

boolean

是否要在雲端硬碟項目的「套用」選單中顯示這個已停用的物件。

  • 如果 true，物件通常會在 UI 中顯示為已停用，且無法選取。
  • 如果為 false，物件通常會隱藏在 UI 中。

DisplayHints

用於轉譯標籤的 UI 顯示提示。

JSON 表示法 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}
欄位
disabled

boolean

標籤是否應在使用者介面中顯示為已停用。
shownInApply

boolean

將值套用至雲端硬碟項目時，這個標籤應顯示在「套用」選單中。
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

將這個標籤套用至雲端硬碟項目時的行為。

JSON 表示法 
{
  "copyMode": enum (CopyMode)
}
欄位
copyMode

enum (CopyMode)

指出複製雲端硬碟項目時，應如何複製套用的標籤和欄位值。

CopyMode

指出複製雲端硬碟項目時，應如何複製套用的標籤和欄位值。

列舉
COPY_MODE_UNSPECIFIED 未指定複製模式。
DO_NOT_COPY 根據預設，系統不會在複製雲端硬碟項目時，一併複製套用的標籤和欄位值。
ALWAYS_COPY 複製雲端硬碟項目時，系統一律會複製套用的標籤和欄位值。只有管理員可以使用這項模式。
COPY_APPLIABLE 如果複製者可以套用標籤，系統就會複製套用的標籤和欄位值。

欄位

定義具有顯示名稱、資料類型和其他設定選項的欄位。這個欄位定義可對 Google 雲端硬碟項目設定的中繼資料類型。

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

僅供輸出。建構雲端硬碟搜尋查詢時使用的鍵，可根據檔案中為這個欄位定義的值尋找檔案。例如「{queryKey} > 2001-01-01」。
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)

僅供輸出。發布這個欄位的使用者。如果欄位未發布，這個值就沒有意義。
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

本地化日期格式選項。

列舉
DATE_FORMAT_UNSPECIFIED 未指定日期格式。
LONG_DATE 包括完整月份名稱。例如：1999 年 1 月 12 日 (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

選項的專屬值。這個 ID 是自動產生，與規則運算式「([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

必要欄位。在 UI 中顯示的文字，用於識別這個欄位。
description

string

這個標籤的說明。
badgeConfig

object (BadgeConfig)

這個選項的徽章設定。設定後，擁有這項選擇的唱片公司就會被視為「徽章唱片公司」。
insertBeforeChoice

string

僅限輸入。將這個選項插入或移至指定選項之前。如果為空白，選項會放在清單結尾。

BadgeConfig

標籤的徽章狀態。

JSON 表示法 
{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}
欄位
color

object (Color)

徽章的顏色。如未指定，則不會轉譯任何徽章。系統會將您在此設定的背景、前景和單獨 (淺色和深色模式) 顏色，變更為雲端硬碟 UI 中最接近的建議支援顏色。
priorityOverride

string (int64 format)

覆寫這個徽章的預設全域優先順序。設為 0 時，系統會使用預設優先順序啟發式演算法。

顏色

代表 RGBA 色域中的顏色。這個表示法旨在簡化各種語言的色彩表示法之間的轉換，而非追求緊湊。舉例來說，這個表示法的欄位可以輕鬆提供給 Java 中的 java.awt.Color 建構函式；也可以輕鬆提供給 iOS 中的 UIColor 的 +colorWithRed:green:blue:alpha 方法；只要稍加處理，就能輕鬆格式化為 JavaScript 中的 CSS rgba() 字串。

這個參考頁面沒有關於絕對色域的資訊，因此無法解讀 RGB 值，例如 sRGB、Adobe RGB、DCI-P3 和 BT.2020。應用程式預設應採用 sRGB 色域。

需要判斷顏色是否相等時，除非另有說明，否則實作會將兩個顏色視為相等，前提是兩者的紅色、綠色、藍色和 Alpha 值各自最多相差 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 時，顏色完全透明。這會使用包裝函式訊息，而非簡單的浮點純量，因此可以區分預設值和未設定的值。如果省略，這個顏色物件會以實心顏色算繪 (如同 Alpha 值已明確設為 1.0)。

DisplayHints

使用者介面顯示選項的算繪提示。

JSON 表示法 
{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}
欄位
disabled

boolean

是否應在 UI 中顯示停用的選項。
shownInApply

boolean

將值套用至雲端硬碟項目時，這個選項應會顯示在「套用」選單中。
badgeColors

object (BadgeColors)

徽章使用的顏色。根據所選 properties.badge_config.color 變更為 Google Material 顏色。
darkBadgeColors

object (BadgeColors)

徽章使用的深色模式顏色。根據所選 properties.badge_config.color 變更為 Google Material 顏色。
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

必要欄位。在 UI 中顯示的文字，用於識別這個欄位。
required

boolean

是否應將欄位標示為必填。
insertBeforeField

string

僅限輸入。將這個欄位插入或移至指定欄位之前。如果為空白，欄位會放在清單結尾。

DisplayHints

用於算繪欄位的使用者介面顯示提示。

JSON 表示法 
{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}
欄位
required

boolean

欄位是否應在 UI 中顯示為必填。
disabled

boolean

欄位是否應在 UI 中顯示為已停用。
shownInApply

boolean

將值套用至 Google 雲端硬碟項目時，這個欄位應顯示在「套用」選單中。

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

使用者是否可以在雲端硬碟項目上設定這個欄位。

EnabledAppSettings

說明可使用標籤的 Google Workspace 應用程式。

JSON 表示法 
{
  "enabledApps": [
    {
      object (EnabledApp)
    }
  ]
}
欄位
enabledApps[]

object (EnabledApp)

(選用步驟) 可使用標籤的應用程式清單。

EnabledApp

可使用標籤的應用程式。

JSON 表示法 
{
  "app": enum (App)
}
欄位
app

enum (App)

(選用步驟) 應用程式名稱。

應用程式

可使用標籤的 Google Workspace 應用程式組合。

列舉
APP_UNSPECIFIED 未指定
DRIVE 雲端硬碟
GMAIL Gmail

方法

create

 建立標籤。

delete

 永久刪除雲端硬碟項目上的標籤和相關中繼資料。

delta

 透過套用一組更新要求來更新單一標籤，產生新的草稿修訂版本。

disable

 停用已發布的標籤。

enable

 啟用已停用的標籤，並將其還原為發布狀態。

get

 依資源名稱取得標籤。

list

 列出標籤。

publish

 發布標籤的所有草稿變更。

updateLabelCopyMode

 更新標籤的 CopyMode。

updateLabelEnabledAppSettings

 更新標籤的 EnabledAppSettings。

updatePermissions

 更新標籤的權限。