REST Resource: labels

資源：Label

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

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 -> (已刪除)

已發布和已停用的狀態有以下幾項不同之處：

  • 已發布：在這個狀態下，物件可能會進行某些變更，在這種情況下，hasUnpublishedChanges 會設為 true。此外，我們不允許進行某些類型的變更。一般來說，如果變更會導致與標籤相關的現有中繼資料失效，或造成新的限制，系統會拒絕這類變更。
  • 停用：停用後，系統會套用已設定的 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 為 true 時，物件通常會在 UI 中顯示為已停用，且無法選取。
  • 如果為 false，物件通常會在 UI 中隱藏。

DisplayHints

顯示標籤的 UI 提示。

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

boolean

標籤是否應在 UI 中顯示為已停用。
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 根據預設，當套用的 Google 雲端硬碟項目複製時，系統不會複製套用的標籤和欄位值。
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 材質顏色。
darkBadgeColors

object (BadgeColors)

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

必要欄位。在 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

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

EnabledAppSettings

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

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

object (EnabledApp)

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

EnabledApp

可使用標籤的應用程式。

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

enum (App)

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

應用程式

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

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

方法

create

 建立新標籤。

delete

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

delta

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

disable

 停用已發布的標籤。

enable

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

get

 根據資源名稱取得標籤。

list

 列出標籤。

publish

 將所有草稿變更內容發布至標籤。

updateLabelCopyMode

 更新標籤的 CopyMode。

updateLabelEnabledAppSettings

 更新標籤的 EabledAppSettings。

updatePermissions

 更新標籤的權限。