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}。詳情請參閱下方的《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。

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,物件通常會在 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 根據預設,複製已套用的雲端硬碟項目時,系統不會複製已套用的標籤和欄位值。
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 (M/d/yy)

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)

徽章的顏色。如果未指定,則不會顯示徽章。此處設定的背景、前景和單人 (淺色和深色模式) 顏色會在雲端硬碟使用者介面中,變更為最接近的建議顏色。

priorityOverride

string (int64 format)

覆寫這個徽章的預設全球優先順序。如果設為 0,系統會使用預設的優先順序經驗法則。

DisplayHints

算繪選項的 UI 顯示提示。

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

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

指定是否要在 UI 中顯示為停用的欄位。

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

更新標籤的權限。