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)
  }
}
欄位
name

string

僅供輸出。標籤的資源名稱。視要求而定,有以下格式:labels/{id}labels/{id}@{revisionId}。請參閱下方的idrevisionId

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。

LabelType

這個標籤的類型。

列舉
LABEL_TYPE_UNSPECIFIED 不明的標籤類型。
SHARED 使用者可以共用共用標籤,以便套用至雲端硬碟項目。
ADMIN 管理員擁有的標籤。只有管理員可成立和編輯。支援部分其他管理員專用功能。

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,物件通常會在 UI 中顯示為停用狀態,且無法選取。
  • 如果為 false,使用者介面通常會隱藏物件。

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 根據預設,套用套用標籤和欄位的雲端硬碟項目時,系統不會複製套用的標籤和欄位值。
ALWAYS_COPY 套用標籤的雲端硬碟項目複製時,系統一律會複製套用的標籤和欄位值。只有管理員才能使用這個模式。
COPY_APPLIABLE 如果建立的使用者需要套用標籤,系統就會複製已套用的標籤和欄位值。

欄位

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

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)

僅供輸出。用於轉譯欄位的 UI 顯示提示。

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 (年/月)

日期

代表完整或部分的日曆日期,例如生日。您可以指明時段和時區,或者在其他地方指定時間或時區。日期以公曆為基準。可能代表下列其中一項:

  • 完整日期,具有非零的年、月和日值。
  • 日期為 0 的月份和日期,例如週年紀念日。
  • 有 1 年,第 0 個月卻為 0 天。
  • 年和月,但數字為零 (例如信用卡到期日)。

相關類型:

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)

僅供輸出。用於轉譯選項的 UI 顯示提示。

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

用於轉譯選項的 UI 顯示提示。

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

boolean

是否應在使用者介面中顯示選項為停用狀態。

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

僅供輸出。指出此標籤元件是否為 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

用於轉譯欄位的 UI 顯示提示。

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

boolean

是否應在 UI 中按必要顯示欄位。

disabled

boolean

這個欄位是否應在使用者介面中顯示為停用狀態。

shownInApply

boolean

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

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

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

方法

create

建立新標籤。

delete

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

delta

套用一組更新要求來產生新的草稿修訂版本,藉此更新單一標籤。

disable

停用已發布的標籤。

enable

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

get

按照資源名稱取得標籤。

list

列出標籤。

publish

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

updateLabelCopyMode

更新標籤的 CopyMode

updatePermissions

更新標籤權限。