REST Resource: labels

{
  "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)
  }
}

string

출력 전용입니다. 라벨의 리소스 이름입니다. 요청에 따라 labels/{id} 또는 labels/{id}@{revisionId} 형식으로 표시됩니다. 아래의 id 및 revisionId를 참고하세요.

string

출력 전용입니다. 이 라벨의 전역 고유 식별자입니다. ID는 name 라벨의 일부를 구성하지만 name와 달리 ID는 버전 간에 일관됩니다. 다음 정규식과 일치합니다. ([a-zA-Z0-9])+

string

출력 전용입니다. 라벨의 버전 ID입니다. 버전 ID는 발행된 요청에 따라 name 라벨의 일부일 수 있습니다. 라벨의 버전 속성이 변경될 때마다 새 버전이 생성됩니다. 다음 정규식과 일치합니다. ([a-zA-Z0-9])+

enum (LabelType)

필수 항목입니다. 라벨 유형입니다.

object (UserInfo)

출력 전용입니다. 이 라벨을 만든 사용자입니다.

string (Timestamp format)

출력 전용입니다. 이 라벨이 생성된 시간입니다.

object (UserInfo)

출력 전용입니다. 이 라벨 버전을 만든 사용자입니다.

string (Timestamp format)

출력 전용입니다. 이 라벨 버전이 생성된 시간입니다.

object (UserInfo)

출력 전용입니다. 이 라벨을 게시한 사용자입니다. 라벨이 게시되지 않으면 이 값은 의미가 없습니다.

string (Timestamp format)

출력 전용입니다. 이 라벨이 게시된 시간입니다. 라벨이 게시되지 않으면 이 값은 의미가 없습니다.

object (UserInfo)

출력 전용입니다. 이 라벨을 사용 중지한 사용자입니다. 라벨이 사용 중지되지 않은 경우 이 값은 의미가 없습니다.

string (Timestamp format)

출력 전용입니다. 이 라벨이 사용 중지된 시간입니다. 라벨이 사용 중지되지 않은 경우 이 값은 의미가 없습니다.

string

출력 전용입니다. 이 라벨이 속한 고객입니다. 예: 'customers/123abc789'

object (Properties)

필수 항목입니다. 라벨의 기본 속성입니다.

object (Lifecycle)

출력 전용입니다. 게시, 지원 중단, 초안 변경 여부를 포함한 라벨의 수명 주기 상태입니다.

object (DisplayHints)

출력 전용입니다. 라벨 렌더링을 위한 UI 표시 힌트

object (AppliedCapabilities)

출력 전용입니다. 적용된 메타데이터에서 이 라벨과 관련된 기능입니다.

object (SchemaCapabilities)

출력 전용입니다. 사용자가 이 라벨에 대해 수행할 수 있는 기능입니다.

object (AppliedLabelPolicy)

출력 전용입니다. 이 라벨이 Drive 항목에 적용될 때의 동작입니다.

object (Field)

우선순위 내림차순으로 필드 목록입니다.

string

사용자가 이 라벨과 사용 방법에 관해 자세히 알아볼 수 있도록 사용자에게 표시되는 맞춤 URL입니다.

object (LockStatus)

출력 전용입니다. 이 라벨의 LockStatus입니다.

{
  "person": string
}

string

추가 정보를 얻기 위해 People API와 함께 사용할 수 있는 사용자의 식별자입니다. 예: people/12345678

{
  "title": string,
  "description": string
}

string

필수 항목입니다. 라벨 제목입니다.

string

라벨의 설명입니다.

{
  "state": enum (State),
  "hasUnpublishedChanges": boolean,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}

enum (State)

출력 전용입니다. 이 수명 주기와 연결된 객체의 상태입니다.

boolean

출력 전용입니다. 이 수명 주기와 연결된 객체에 게시되지 않은 변경사항이 있는지 여부입니다.

object (DisabledPolicy)

사용 중지된 라벨, 필드 또는 선택 항목을 표시하는 방법을 제어하는 정책입니다.

{
  "hideInSearch": boolean,
  "showInApply": boolean
}

boolean

Drive 항목의 검색 메뉴에서 사용 중지된 이 객체를 숨길지 선택합니다.

• false인 경우 객체는 일반적으로 UI에 사용 중지된 것으로 표시되지만 Drive 항목을 검색할 때 검색 결과에 표시됩니다.
• true인 경우 Drive 항목을 검색할 때 객체가 일반적으로 UI에 숨겨집니다.

boolean

Drive 항목의 적용 메뉴에 이 사용 중지된 객체를 표시할지 여부입니다.

• true인 경우 객체는 일반적으로 UI에 사용 중지된 것으로 표시되며 선택이 불가능합니다.
• false인 경우 객체는 일반적으로 UI에서 숨겨집니다.

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "priority": string
}

boolean

라벨을 UI에 사용 중지로 표시해야 하는지 여부입니다.

boolean

Drive 항목을 검색할 때 검색 메뉴에서 이 라벨을 숨겨야 합니다.

boolean

이 라벨은 Drive 항목에 값을 적용할 때 적용 메뉴에 표시되어야 합니다.

string (int64 format)

목록에 라벨을 표시할 순서입니다.

{
  "canRead": boolean,
  "canApply": boolean,
  "canRemove": boolean
}

boolean

사용자가 이 라벨과 관련된 적용된 메타데이터를 읽을 수 있는지 여부입니다.

boolean

사용자가 이 라벨을 항목에 적용할 수 있는지 여부입니다.

boolean

사용자가 항목에서 이 라벨을 삭제할 수 있는지 여부입니다.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

사용자가 이 라벨을 변경할 수 있는지 여부입니다.

boolean

사용자가 이 라벨을 삭제할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 라벨은 사용 중지되어야 합니다.

boolean

사용자가 이 라벨을 사용 중지할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 이 라벨이 이미 사용 중지된 상태여서는 안 됩니다.

boolean

사용자가 이 라벨을 사용 설정할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 이 라벨을 사용 중지해야 합니다.

{
  "copyMode": enum (CopyMode)
}

enum (CopyMode)

Drive 항목을 복사할 때 적용된 라벨 및 필드 값을 복사하는 방법을 나타냅니다.

{
  "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.
}

string

출력 전용입니다. 라벨 또는 라이브러리 내에서 고유한 필드의 키입니다.

이 값은 자동 생성됩니다. 다음 정규식과 일치합니다. ([a-zA-Z0-9])+

string

출력 전용입니다. 파일에서 이 필드에 정의된 값을 기반으로 파일을 찾기 위해 Drive 검색어를 구성할 때 사용하는 키입니다. 예: '{queryKey} > 2001-01-01').

object (Properties)

필드의 기본 속성입니다.

object (Lifecycle)

출력 전용입니다. 이 필드의 수명 주기입니다.

object (DisplayHints)

출력 전용입니다. 필드 렌더링을 위한 UI 표시 힌트

object (SchemaCapabilities)

출력 전용입니다. 이 필드를 수정할 때 이 사용자가 가질 수 있는 권한입니다.

object (AppliedCapabilities)

출력 전용입니다. 이 필드에서 사용자가 보유한 권한 및 Drive 항목에 라벨이 적용되었을 때의 값입니다.

object (UserInfo)

출력 전용입니다. 이 필드를 만든 사용자입니다.

string (Timestamp format)

출력 전용입니다. 이 필드가 만들어진 시간입니다.

object (UserInfo)

출력 전용입니다. 이 필드를 수정한 사용자입니다.

string (Timestamp format)

출력 전용입니다. 이 필드가 업데이트된 시간입니다.

object (UserInfo)

출력 전용입니다. 이 필드를 게시한 사용자입니다. 필드가 게시되지 않으면 이 값은 의미가 없습니다.

object (UserInfo)

출력 전용입니다. 이 필드를 사용 중지한 사용자입니다. 필드가 사용 중지되지 않은 경우 이 값은 의미가 없습니다.

string (Timestamp format)

출력 전용입니다. 이 필드가 사용 중지된 시간입니다. 필드가 사용 중지되지 않은 경우 이 값은 의미가 없습니다.

object (LockStatus)

출력 전용입니다. 이 필드의 LockStatus입니다.

object (TextOptions)

텍스트 필드 옵션입니다.

object (IntegerOptions)

정수 필드 옵션입니다.

object (DateOptions)

날짜 필드 옵션입니다.

object (SelectionOptions)

선택 필드 옵션입니다.

object (UserOptions)

사용자 필드 옵션입니다.

{
  "minLength": integer,
  "maxLength": integer
}

integer

출력 전용입니다. 텍스트 필드 값의 최소 유효 길이입니다.

integer

출력 전용입니다. 텍스트 필드 값의 최대 유효 길이입니다.

{
  "minValue": string,
  "maxValue": string
}

string (int64 format)

출력 전용입니다. 정수 필드의 최소 유효값입니다.

string (int64 format)

출력 전용입니다. 정수 필드의 최대 유효 값입니다.

{
  "dateFormatType": enum (DateFormat),
  "dateFormat": string,
  "minValue": {
    object (Date)
  },
  "maxValue": {
    object (Date)
  }
}

enum (DateFormat)

현지화된 날짜 형식 옵션 필드 값은 언어에 따라 이 형식으로 렌더링됩니다.

string

출력 전용입니다. ICU 날짜 형식입니다.

object (Date)

출력 전용입니다. 최소 유효 값 (연, 월, 일)

object (Date)

출력 전용입니다. 최대 유효 값 (연, 월, 일)

{
  "year": integer,
  "month": integer,
  "day": integer
}

integer

날짜의 연도입니다. 1~9999 사이여야 하며, 연도 없이 날짜를 지정하려면 0이어야 합니다.

integer

연도의 월입니다. 1~12 사이여야 하며, 월과 일 없이 연도를 지정하려면 0이어야 합니다.

integer

월의 일입니다. 1~31 사이여야 하고 해당 연도 및 월에 유효해야 합니다. 또는 연도만 지정하거나 일이 중요하지 않아 연도와 월을 지정하려면 0이어야 합니다.

{
  "listOptions": {
    object (ListOptions)
  },
  "choices": [
    {
      object (Choice)
    }
  ]
}

object (ListOptions)

지정된 경우 이 필드가 값 목록을 지원함을 나타냅니다. 필드가 게시된 후에는 변경할 수 없습니다.

object (Choice)

이 선택 필드에 사용할 수 있는 옵션입니다. 목록 순서는 일관되며 insertBeforeChoice로 수정됩니다.

{
  "maxEntries": integer
}

integer

허용되는 최대 항목 수입니다.

{
  "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)
  }
}

string

선택의 고유한 값입니다. 자동 생성된 ID입니다. 다음 정규식과 일치합니다(([a-zA-Z0-9_])+).

object (Properties)

선택의 기본 속성입니다.

object (Lifecycle)

출력 전용입니다. 서비스 선택의 수명 주기입니다.

object (DisplayHints)

출력 전용입니다. 선택 렌더링을 위한 UI 표시 힌트

object (SchemaCapabilities)

출력 전용입니다. 옵션을 수정할 때 이 옵션과 관련된 기능입니다.

object (AppliedCapabilities)

출력 전용입니다. 적용된 메타데이터에서 이 선택사항과 관련된 기능입니다.

object (UserInfo)

출력 전용입니다. 이 옵션을 만든 사용자입니다.

string (Timestamp format)

출력 전용입니다. 이 선택사항이 생성된 시간입니다.

object (UserInfo)

출력 전용입니다. 이 옵션을 마지막으로 업데이트한 사용자입니다.

string (Timestamp format)

출력 전용입니다. 이 선택사항이 마지막으로 업데이트된 시간입니다.

object (UserInfo)

출력 전용입니다. 이 옵션을 게시한 사용자입니다. 선택 사항이 게시되지 않으면 이 값은 의미가 없습니다.

string (Timestamp format)

출력 전용입니다. 이 선택사항이 게시된 시간입니다. 선택 사항이 게시되지 않으면 이 값은 의미가 없습니다.

object (UserInfo)

출력 전용입니다. 이 선택을 사용 중지한 사용자입니다. 옵션이 사용 중지되어 있지 않으면 이 값은 의미가 없습니다.

string (Timestamp format)

출력 전용입니다. 이 선택이 사용 중지된 시간입니다. 선택이 비활성화되어 있지 않으면 이 값은 의미가 없습니다.

object (LockStatus)

출력 전용입니다. 이 선택의 LockStatus입니다.

{
  "displayName": string,
  "description": string,
  "badgeConfig": {
    object (BadgeConfig)
  },
  "insertBeforeChoice": string
}

string

필수 항목입니다. 이 필드를 식별하는 UI에 표시할 표시 텍스트입니다.

string

이 라벨의 설명입니다.

object (BadgeConfig)

이 선택의 배지 구성입니다. 설정되면 이 선택사항을 소유하는 라벨은 '배지가 있는 라벨'로 간주됩니다.

string

입력 전용입니다. 표시된 선택 항목 앞에 이 선택 항목을 삽입하거나 이동합니다. 비어 있으면 선택사항이 목록의 끝에 배치됩니다.

{
  "color": {
    object (Color)
  },
  "priorityOverride": string
}

object (Color)

배지의 색상입니다. 지정하지 않으면 배지가 렌더링되지 않습니다. 여기에 설정된 배경, 전경, 단독 (밝은 모드, 어두운 모드) 색상은 Drive UI에서 지원되는 가장 가까운 색상으로 변경됩니다.

string (int64 format)

이 배지의 기본 전체 우선순위를 재정의합니다. 0으로 설정하면 기본 우선순위 휴리스틱이 사용됩니다.

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

[0, 1] 간격의 값으로 표시되는 색상의 빨간색 양입니다.

number

[0, 1] 간격의 값으로 표시되는 색상의 녹색 양입니다.

number

[0, 1] 간격의 값으로 표시되는 색상의 파란색 양입니다.

number

픽셀에 적용해야 하는 이 색상의 비율입니다. 즉, 최종 픽셀 색상은 등식으로 정의됩니다.

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

즉, 1.0 값은 단색에 해당하는 반면 0.0 값은 완전히 투명한 색상에 해당합니다. 이 옵션은 단순한 부동 소수점 스칼라 대신 래퍼 메시지를 사용하므로 기본값과 설정되지 않은 값을 구분할 수 있습니다. 생략하면 이 색상 객체가 단색으로 렌더링됩니다 (알파 값에 1.0 값이 명시적으로 지정된 것처럼).

{
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean,
  "badgeColors": {
    object (BadgeColors)
  },
  "darkBadgeColors": {
    object (BadgeColors)
  },
  "badgePriority": string
}

boolean

옵션을 UI에 사용 중지로 표시할지 여부입니다.

boolean

Drive 항목을 검색할 때 이 옵션은 검색 메뉴에서 숨겨져 있어야 합니다.

boolean

Drive 항목에 값을 적용할 때 적용 메뉴에 이 옵션이 표시되어야 합니다.

object (BadgeColors)

배지에 사용할 색상입니다. 선택한 properties.badge_config.color에 따라 Google Material 색상으로 변경되었습니다.

object (BadgeColors)

배지에 사용할 어두운 모드 색상입니다. 선택한 properties.badge_config.color에 따라 Google Material 색상으로 변경되었습니다.

string (int64 format)

이 배지의 우선순위입니다. 여러 배지를 비교하고 정렬하는 데 사용됩니다. 숫자가 낮을수록 배지가 먼저 표시되어야 합니다. 배지 구성이 없으면 0이 됩니다. 그렇지 않으면 라벨 생성 날짜와 필드 및 옵션 우선순위를 선호하는 BadgeConfig.priority_override 또는 기본 휴리스틱으로 설정됩니다.

{
  "backgroundColor": {
    object (Color)
  },
  "foregroundColor": {
    object (Color)
  },
  "soloColor": {
    object (Color)
  }
}

object (Color)

출력 전용입니다. 전경과 쌍을 이루는 배지 배경

object (Color)

출력 전용입니다. 배경과 쌍을 이루는 배지 전경

object (Color)

출력 전용입니다. 배경이 없는 텍스트에 사용할 수 있는 색상입니다.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

사용자가 이 선택사항을 업데이트할 수 있는지 여부입니다.

boolean

사용자가 이 선택사항을 삭제할 수 있는지 여부입니다.

boolean

사용자가 이 선택을 사용 중지할 수 있는지 여부입니다.

boolean

사용자가 이 옵션을 사용 설정할 수 있는지 여부입니다.

{
  "canRead": boolean,
  "canSearch": boolean,
  "canSelect": boolean
}

boolean

사용자가 항목에 적용된 관련 메타데이터를 읽을 수 있는지 여부입니다.

boolean

사용자가 검색어에 이 옵션을 사용할 수 있는지 여부입니다.

boolean

사용자가 항목에서 이 옵션을 선택할 수 있는지 여부입니다.

{
  "locked": boolean
}

boolean

출력 전용입니다. 이 라벨 구성요소가 LabelLock의 (직접) 대상인지를 나타냅니다. 라벨 구성요소는 LabelLock의 직접 대상이 아니더라도 암시적으로 잠길 수 있으며, 이 경우 이 필드는 false로 설정됩니다.

{
  "listOptions": {
    object (ListOptions)
  }
}

object (ListOptions)

지정된 경우 이 필드가 값 목록을 지원함을 나타냅니다. 필드가 게시된 후에는 변경할 수 없습니다.

{
  "displayName": string,
  "required": boolean,
  "insertBeforeField": string
}

string

필수 항목입니다. 이 필드를 식별하는 UI에 표시할 표시 텍스트입니다.

boolean

필드가 필수로 표시되어야 하는지 여부입니다.

string

입력 전용입니다. 표시된 필드 앞에 이 필드를 삽입하거나 이동합니다. 비어 있으면 필드가 목록의 끝에 배치됩니다.

{
  "required": boolean,
  "disabled": boolean,
  "hiddenInSearch": boolean,
  "shownInApply": boolean
}

boolean

필드가 UI에 필요에 따라 표시되어야 하는지 여부입니다.

boolean

필드가 사용 중지로 UI에 표시되어야 하는지 여부입니다.

boolean

Drive 항목을 검색할 때 검색 메뉴에서 이 입력란을 숨겨야 합니다.

boolean

이 필드는 Drive 항목에 값을 적용할 때 적용 메뉴에 표시되어야 합니다.

{
  "canUpdate": boolean,
  "canDelete": boolean,
  "canDisable": boolean,
  "canEnable": boolean
}

boolean

사용자가 이 필드를 변경할 수 있는지 여부입니다.

boolean

사용자가 이 필드를 삭제할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 필드는 지원 중단되어야 합니다.

boolean

사용자가 이 필드를 사용 중지할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 이 필드가 이미 사용 중지되어 있으면 안 됩니다.

boolean

사용자가 이 필드를 사용 설정할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 이 필드는 사용 중지해야 합니다.

{
  "canRead": boolean,
  "canSearch": boolean,
  "canWrite": boolean
}

boolean

사용자가 항목에 적용된 관련 메타데이터를 읽을 수 있는지 여부입니다.

boolean

사용자가 이 필드를 참조하는 Drive 항목을 검색할 수 있는지 여부입니다.

boolean

사용자가 Drive 항목에서 이 필드를 설정할 수 있는지 여부입니다.