- 리소스: 라벨
- 라벨 유형
- 사용자 정보
- 속성
- 수명 주기
- 상태
- DisabledPolicy
- 디스플레이 힌트
- AppliedCapabilities
- 스키마 기능
- AppliedLabelPolicy
- 복사 모드
- 필드
- TextOptions
- IntegerOptions
- 날짜 옵션
- 날짜 형식
- SelectionOptions
- ListOptions
- 선택
- 속성
- BadgeConfig
- 디스플레이 힌트
- 배지 색상
- 스키마 기능
- AppliedCapabilities
- LockStatus
- UserOptions
- 속성
- 디스플레이 힌트
- 스키마 기능
- AppliedCapabilities
- 메서드
리소스: 라벨
라벨은 항목을 정리하고 정리하기 위해 Drive 항목에 적용할 수 있는 분류 체계를 정의합니다. 라벨은 간단한 문자열일 수도 있고, Drive 항목을 정리하고 검색하는 데 사용될 수 있는 추가 메타데이터를 설명하는 필드를 포함할 수도 있습니다.
JSON 표현 |
---|
{ "name": string, "id": string, "revisionId": string, "labelType": enum ( |
필드 | |
---|---|
name |
출력 전용. 라벨의 리소스 이름입니다. 요청에 따라 |
id |
출력 전용. 이 라벨의 전역 고유 식별자입니다. ID는 |
revisionId |
출력 전용. 라벨의 버전 ID입니다. 발행된 요청에 따라 버전 ID가 |
labelType |
필수 항목입니다. 라벨 유형입니다. |
creator |
출력 전용. 이 라벨을 만든 사용자입니다. |
createTime |
출력 전용. 이 라벨이 생성된 시간입니다. |
revisionCreator |
출력 전용. 이 라벨 버전을 만든 사용자입니다. |
revisionCreateTime |
출력 전용. 라벨 버전이 생성된 시간입니다. |
publisher |
출력 전용. 이 라벨을 게시한 사용자입니다. 이 값은 라벨이 게시되지 않은 경우 의미가 없습니다. |
publishTime |
출력 전용. 라벨이 게시된 시간입니다. 이 값은 라벨이 게시되지 않은 경우 의미가 없습니다. |
disabler |
출력 전용. 이 라벨을 사용 중지한 사용자입니다. 이 값은 라벨이 사용 중지되지 않은 경우 의미가 없습니다. |
disableTime |
출력 전용. 이 라벨이 사용 중지된 시간입니다. 이 값은 라벨이 사용 중지되지 않은 경우 의미가 없습니다. |
customer |
출력 전용. 이 라벨이 속한 고객입니다. 예: '고객/123abc789' |
properties |
필수 항목입니다. 라벨의 기본 속성입니다. |
lifecycle |
출력 전용. 라벨의 게시 주기, 지원 중단 여부, 초안 변경사항 여부를 포함한 수명 주기 상태입니다. |
displayHints |
출력 전용. 라벨 렌더링을 위한 UI 표시 힌트 |
appliedCapabilities |
출력 전용. 적용된 메타데이터에서 이 라벨과 관련된 기능입니다. |
schemaCapabilities |
출력 전용. 이 라벨에 대한 사용자의 권한 |
appliedLabelPolicy |
출력 전용. Drive 항목에 적용될 때의 라벨 동작입니다. |
fields[] |
우선순위 기준 내림차순으로 나열된 필드 목록 |
learnMoreUri |
사용자에게 표시할 라벨 및 사용 방법을 자세히 알려주는 맞춤 URL입니다. |
lockStatus |
출력 전용. 이 라벨의 LockStatus |
라벨 유형
라벨의 유형입니다.
열거형 | |
---|---|
LABEL_TYPE_UNSPECIFIED |
알 수 없는 라벨 유형입니다. |
SHARED |
Drive 항목에 적용할 수 있도록 공유 라벨이 사용자와 공유될 수 있습니다. |
ADMIN |
관리자 소유 라벨 관리자만 만들고 수정할 수 있습니다. 관리자 전용 기능을 추가로 지원합니다. |
사용자 정보
사용자에 대한 정보입니다.
JSON 표현 |
---|
{ "person": string } |
필드 | |
---|---|
person |
People API와 함께 사용하여 추가 정보를 가져올 수 있는 사용자의 식별자입니다. 예: 사용자/12345678 |
속성
라벨의 기본 속성입니다.
JSON 표현 |
---|
{ "title": string, "description": string } |
필드 | |
---|---|
title |
필수 항목입니다. 라벨의 제목입니다. |
description |
라벨에 대한 설명입니다. |
수명 주기
객체의 수명 주기 상태(예: 라벨, 필드, 선택) 수명 주기에서 적용하는 전환은 다음과 같습니다.
UNPUBLISHED_DRAFT
(시작 상태)UNPUBLISHED_DRAFT
->PUBLISHED
UNPUBLISHED_DRAFT
~> (삭제됨)PUBLISHED
->DISABLED
DISABLED
->PUBLISHED
DISABLED
~> (삭제됨)
게시 상태와 중지 상태에는 몇 가지 고유한 특징이 있습니다.
- 게시됨: 이 상태의 객체에 몇 가지 유형의 변경이 있을 수 있으며, 이 경우
hasUnpublishedChanges
이 true입니다. 또한 일부 변경은 허용되지 않습니다. 일반적으로 라벨과 관련된 기존 메타데이터에 무효화되거나 새로운 제한사항을 유발하는 변경사항은 거부됩니다. - 사용 중지됨: 사용 중지하면 구성된
DisabledPolicy
가 적용됩니다.
JSON 표현 |
---|
{ "state": enum ( |
필드 | |
---|---|
state |
출력 전용. 이 수명 주기와 연결된 객체의 상태입니다. |
hasUnpublishedChanges |
출력 전용. 이 수명 주기와 연결된 객체에 게시되지 않은 변경사항이 있는지 여부입니다. |
disabledPolicy |
사용 중지된 라벨, 필드 또는 선택 옵션을 표시하는 방법에 적용되는 정책입니다. |
상태
이 수명 주기와 연결된 객체의 상태입니다.
열거형 | |
---|---|
STATE_UNSPECIFIED |
알 수 없는 상태입니다. |
UNPUBLISHED_DRAFT |
객체의 초기 상태입니다. 일단 게시된 객체는 다시 이 상태로 돌아올 수 없습니다. 객체가 게시되면 더 이상 특정 유형의 변경이 허용되지 않습니다. |
PUBLISHED |
객체가 게시되었습니다. 객체에는 hasUnpublishedChanges 에 표시된 대로 게시되지 않은 초안 변경사항이 있을 수 있습니다. |
DISABLED |
객체가 게시되었으며 이후 사용 중지되었습니다. 객체에는 hasUnpublishedChanges 에 표시된 대로 게시되지 않은 초안 변경사항이 있을 수 있습니다. |
DELETED |
객체가 삭제되었습니다. |
사용 중지된 정책
사용 중지된 라벨, 필드 또는 선택 항목을 다른 컨텍스트에서 처리하는 방법에 적용되는 정책입니다.
JSON 표현 |
---|
{ "hideInSearch": boolean, "showInApply": boolean } |
필드 | |
---|---|
hideInSearch |
Drive 항목의 검색 메뉴에서 사용 중지된 이 객체를 숨길지 결정합니다.
|
showInApply |
Drive 항목의 적용 메뉴에서 사용 중지된 이 객체를 표시할지 여부입니다.
|
디스플레이 힌트
라벨 렌더링을 위한 UI 표시 힌트
JSON 표현 |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "priority": string } |
필드 | |
---|---|
disabled |
UI에 라벨이 사용 중지로 표시되어야 하는지 여부입니다. |
shownInApply |
이 라벨은 Drive 항목에 값을 적용할 때 적용 메뉴에 표시되어야 합니다. |
priority |
목록에 라벨을 표시하려면 순서를 지정하세요. |
적용된 기능
이 라벨이 적용된 메타데이터에 대해 사용자가 가진 기능입니다.
JSON 표현 |
---|
{ "canRead": boolean, "canApply": boolean, "canRemove": boolean } |
필드 | |
---|---|
canRead |
사용자가 이 라벨과 관련하여 적용된 메타데이터를 읽을 수 있는지를 나타냅니다. |
canApply |
사용자가 항목에 이 라벨을 적용할 수 있는지를 나타냅니다. |
canRemove |
사용자가 항목에서 이 라벨을 삭제할 수 있는지 여부입니다. |
스키마 기능
라벨을 수정할 때 이 라벨과 관련된 기능입니다.
JSON 표현 |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
필드 | |
---|---|
canUpdate |
사용자가 이 라벨을 변경할 수 있는지 여부입니다. |
canDelete |
사용자가 이 라벨을 삭제할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 라벨은 사용 중지해야 합니다. |
canDisable |
사용자가 이 라벨을 사용 중지할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 이 라벨은 아직 사용 중지되어 있지 않아야 합니다. |
canEnable |
사용자가 이 라벨을 사용 설정할 수 있는지 여부 사용자에게 권한이 있어야 하며 이 라벨은 사용 중지해야 합니다. |
적용된 라벨 정책
Drive 항목에 적용될 때의 라벨 동작입니다.
JSON 표현 |
---|
{
"copyMode": enum ( |
필드 | |
---|---|
copyMode |
Drive 항목을 복사할 때 적용된 라벨 및 필드 값을 복사하는 방법을 나타냅니다. |
복사 모드
Drive 항목을 복사할 때 적용된 라벨 및 필드 값을 복사하는 방법을 나타냅니다.
열거형 | |
---|---|
COPY_MODE_UNSPECIFIED |
복사 모드가 지정되지 않았습니다. |
DO_NOT_COPY |
적용된 라벨 및 필드 값은 적용된 Drive 항목을 복사할 때 기본적으로 복사되지 않습니다. |
ALWAYS_COPY |
적용된 라벨 및 필드 값은 적용된 Drive 항목이 복사될 때 항상 복사됩니다. 관리자만 이 모드를 사용할 수 있습니다. |
COPY_APPLIABLE |
복사 중인 사용자가 라벨을 적용할 수 있는 경우 적용된 라벨 및 필드 값이 복사됩니다. |
필드
표시 이름, 데이터 유형 및 기타 구성 옵션이 있는 필드를 정의합니다. 이 필드는 Drive 항목에 설정할 수 있는 메타데이터의 종류를 정의합니다.
JSON 표현 |
---|
{ "id": string, "queryKey": string, "properties": { object ( |
필드 | |
---|---|
id |
출력 전용. 라벨 또는 라이브러리 내에서 고유한 필드의 키입니다. 이 값은 자동으로 생성됩니다. 정규식과 일치함: |
queryKey |
출력 전용. 파일에서 이 입력란에 정의된 값을 기준으로 파일을 찾기 위해 Drive 검색어를 구성할 때 사용하는 키입니다. 예: ' |
properties |
필드의 기본 속성입니다. |
lifecycle |
출력 전용. 이 필드의 수명 주기입니다. |
displayHints |
출력 전용. 필드 렌더링을 위한 UI 표시 힌트 |
schemaCapabilities |
출력 전용. 사용자가 이 필드를 수정할 때 사용하는 기능입니다. |
appliedCapabilities |
출력 전용. 사용자가 이 입력란에 부여한 기능과 Drive 항목에 라벨이 적용되었을 때의 값 |
creator |
출력 전용. 이 필드를 만든 사용자입니다. |
createTime |
출력 전용. 이 필드가 생성된 시간입니다. |
updater |
출력 전용. 이 필드를 수정한 사용자입니다. |
updateTime |
출력 전용. 이 필드가 업데이트된 시간입니다. |
publisher |
출력 전용. 이 필드를 게시한 사용자입니다. 필드가 게시되지 않은 경우 이 값은 의미가 없습니다. |
disabler |
출력 전용. 이 필드를 사용 중지한 사용자입니다. 필드가 사용 중지되지 않은 경우 이 값은 의미가 없습니다. |
disableTime |
출력 전용. 이 필드가 사용 중지된 시간입니다. 필드가 사용 중지되지 않은 경우 이 값은 의미가 없습니다. |
lockStatus |
출력 전용. 이 필드의 LockStatus |
통합 필드 type 는 이 필드의 데이터 유형 및 옵션입니다. 게시된 데이터 유형은 변경할 수 없습니다. type 은 다음 중 하나여야 합니다. |
|
textOptions |
텍스트 필드 옵션 |
integerOptions |
정수 필드 옵션입니다. |
dateOptions |
날짜 필드 옵션 |
selectionOptions |
선택 필드 옵션 |
userOptions |
사용자 필드 옵션 |
텍스트 옵션
텍스트 필드 유형에 대한 옵션입니다.
JSON 표현 |
---|
{ "minLength": integer, "maxLength": integer } |
필드 | |
---|---|
minLength |
출력 전용. 텍스트 필드의 유효한 최소 길이입니다. |
maxLength |
출력 전용. 텍스트 필드의 유효한 최대 길이입니다. |
정수 옵션
정수 필드 유형에 대한 옵션입니다.
JSON 표현 |
---|
{ "minValue": string, "maxValue": string } |
필드 | |
---|---|
minValue |
출력 전용. 정수 필드의 유효한 최솟값입니다. |
maxValue |
출력 전용. 정수 필드의 최대 유효 값입니다. |
날짜 옵션
날짜 필드 유형에 대한 옵션입니다.
JSON 표현 |
---|
{ "dateFormatType": enum ( |
필드 | |
---|---|
dateFormatType |
현지화된 날짜 형식 옵션 필드 값은 언어에 따라 이 형식으로 렌더링됩니다. |
dateFormat |
출력 전용. ICU 날짜 형식입니다. |
minValue |
출력 전용. 유효한 최솟값 (연도, 월, 일) |
maxValue |
출력 전용. 유효한 최대 값 (년, 월, 일)입니다. |
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[] |
이 선택 필드에 사용할 수 있는 옵션입니다. 목록 순서는 일관되며 |
ListOptions
연결된 필드 유형의 다중 값 변형에 관한 옵션입니다.
JSON 표현 |
---|
{ "maxEntries": integer } |
필드 | |
---|---|
maxEntries |
허용되는 최대 항목 수에 해당합니다. |
원하는 대로 선택
선택 필드 선택
JSON 표현 |
---|
{ "id": string, "properties": { object ( |
필드 | |
---|---|
id |
선택 항목의 고유한 값입니다. 이 ID는 자동 생성됩니다. 정규식 |
properties |
선택한 기본 속성 |
lifecycle |
출력 전용. 원하는 수명 주기입니다. |
displayHints |
출력 전용. 선택 항목을 렌더링하기 위한 UI 디스플레이 힌트 |
schemaCapabilities |
출력 전용. 옵션을 수정할 때 이 옵션과 관련된 기능입니다. |
appliedCapabilities |
출력 전용. 적용된 메타데이터에 대한 이 선택과 관련된 기능입니다. |
creator |
출력 전용. 이 선택사항을 만든 사용자입니다. |
createTime |
출력 전용. 선택사항이 생성된 시간입니다. |
updater |
출력 전용. 이 선택사항을 마지막으로 업데이트한 사용자입니다. |
updateTime |
출력 전용. 이 선택사항이 마지막으로 업데이트된 시간입니다. |
publisher |
출력 전용. 이 선택사항을 게시한 사용자입니다. 선택사항이 게시되지 않은 경우 이 값은 의미가 없습니다. |
publishTime |
출력 전용. 이 선택사항이 게시된 시간입니다. 선택사항이 게시되지 않은 경우 이 값은 의미가 없습니다. |
disabler |
출력 전용. 이 선택지를 사용 중지한 사용자입니다. 옵션이 사용 중지되지 않은 경우 이 값은 의미가 없습니다. |
disableTime |
출력 전용. 이 옵션이 사용 중지된 시간입니다. 선택사항이 사용 중지되지 않은 경우 이 값은 의미가 없습니다. |
lockStatus |
출력 전용. 선택 항목의 LockStatus |
속성
선택한 기본 속성
JSON 표현 |
---|
{
"displayName": string,
"description": string,
"badgeConfig": {
object ( |
필드 | |
---|---|
displayName |
필수 항목입니다. 이 필드를 식별하는 UI에 표시할 표시 텍스트입니다. |
description |
라벨의 설명입니다. |
badgeConfig |
이 선택사항의 배지 구성입니다. 설정된 경우 이 선택을 소유한 라벨은 '배지가 있는 라벨'로 간주됩니다. |
insertBeforeChoice |
입력 전용. 표시된 선택사항 앞에 이 선택사항을 삽입하거나 이동하세요. 비어 있으면 선택 항목이 목록 끝에 배치됩니다. |
배지 구성
라벨의 배지 상태입니다.
JSON 표현 |
---|
{
"color": {
object ( |
필드 | |
---|---|
color |
배지의 색상입니다. 지정하지 않으면 렌더링되지 않는 배지가 있습니다. 여기에서 설정된 배경, 전경, 솔로 (밝은 모드와 어두운 모드) 색상은 Drive UI에서 지원되는 가장 가까운 색상으로 변경됩니다. |
priorityOverride |
이 배지의 기본 전역 우선순위를 재정의합니다. 0으로 설정하면 기본 우선순위 휴리스틱이 사용됩니다. |
디스플레이 힌트
옵션 렌더링을 위한 UI 표시 힌트
JSON 표현 |
---|
{ "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean, "badgeColors": { object ( |
필드 | |
---|---|
disabled |
옵션을 UI에 사용 안함으로 표시할지 여부입니다. |
shownInApply |
Drive 항목에 값을 적용할 때 적용 메뉴에 이 옵션이 표시되어야 합니다. |
badgeColors |
배지에 사용할 색상입니다. 선택한 |
darkBadgeColors |
배지에 사용할 어두운 모드 색상입니다. 선택한 |
badgePriority |
이 배지의 우선순위입니다. 여러 배지를 비교하고 정렬하는 데 사용됩니다. 숫자가 낮을수록 먼저 배지가 표시되어야 합니다. 배지 설정이 없으면 0이 됩니다. 그렇지 않으면 |
배지 색상
BadgeConfig에서 파생된 색상을 지원되는 가장 가까운 권장 색상으로 변경했습니다.
JSON 표현 |
---|
{ "backgroundColor": { object ( |
필드 | |
---|---|
backgroundColor |
출력 전용. 전경과 페어링된 배지 배경 |
foregroundColor |
출력 전용. 전경과 배지의 전경 배지 |
soloColor |
출력 전용. 배경이 없는 텍스트에 사용할 수 있는 색상입니다. |
스키마 기능
선택 항목을 수정할 때 이 선택과 관련된 기능입니다.
JSON 표현 |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
필드 | |
---|---|
canUpdate |
사용자가 이 선택사항을 업데이트할 수 있는지 여부입니다. |
canDelete |
사용자가 이 선택 항목을 삭제할 수 있는지 여부입니다. |
canDisable |
사용자가 이 선택 항목을 사용 중지할 수 있는지 여부입니다. |
canEnable |
사용자가 이 선택을 사용 설정할 수 있는지 여부입니다. |
적용된 기능
적용된 메타데이터에 대한 이 선택과 관련된 기능입니다.
JSON 표현 |
---|
{ "canRead": boolean, "canSearch": boolean, "canSelect": boolean } |
필드 | |
---|---|
canRead |
사용자가 항목에 적용된 관련 메타데이터를 읽을 수 있는지 여부입니다. |
canSearch |
사용자가 검색어에 이 옵션을 사용할지 여부입니다. |
canSelect |
사용자가 항목에서 이 선택 항목을 선택할 수 있는지를 나타냅니다. |
잠금 상태
라벨 구성요소가 잠긴 것으로 간주되어야 하는지를 나타내는 정보를 포함합니다.
JSON 표현 |
---|
{ "locked": boolean } |
필드 | |
---|---|
locked |
출력 전용. 이 라벨 구성요소가 LabelLock의 (직접) 타겟인지 여부를 나타냅니다. 라벨 구성요소는 LabelLock의 직접 타겟이 아닌 경우에도 암시적으로 잠길 수 있으며, 이 경우에는 false로 설정됩니다. |
사용자 옵션
사용자 필드 유형에 대한 옵션입니다.
JSON 표현 |
---|
{
"listOptions": {
object ( |
필드 | |
---|---|
listOptions |
이 플래그를 지정하면 이 필드가 값 목록을 지원함을 나타냅니다. 필드가 게시된 후에는 변경할 수 없습니다. |
속성
필드의 기본 속성입니다.
JSON 표현 |
---|
{ "displayName": string, "required": boolean, "insertBeforeField": string } |
필드 | |
---|---|
displayName |
필수 항목입니다. 이 필드를 식별하는 UI에 표시할 표시 텍스트입니다. |
required |
필드를 필수로 표시해야 하는지 여부입니다. |
insertBeforeField |
입력 전용. 표시된 필드 앞에 이 필드를 삽입하거나 이동합니다. 비어 있으면 필드가 목록 끝에 배치됩니다. |
디스플레이 힌트
필드 렌더링을 위한 UI 표시 힌트
JSON 표현 |
---|
{ "required": boolean, "disabled": boolean, "hiddenInSearch": boolean, "shownInApply": boolean } |
필드 | |
---|---|
required |
UI에 필요한 필드 표시 여부입니다. |
disabled |
필드를 UI에 사용 중지로 표시해야 하는지 여부입니다. |
shownInApply |
이 입력란은 Drive 항목에 값을 적용할 때 적용 메뉴에 표시되어야 합니다. |
스키마 기능
필드를 수정할 때 이 필드와 관련된 기능입니다.
JSON 표현 |
---|
{ "canUpdate": boolean, "canDelete": boolean, "canDisable": boolean, "canEnable": boolean } |
필드 | |
---|---|
canUpdate |
사용자가 이 필드를 변경할 수 있는지 여부입니다. |
canDelete |
사용자가 이 필드를 삭제할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 필드는 지원 중단되어야 합니다. |
canDisable |
사용자가 이 필드를 사용 중지할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 이 필드는 이미 사용 중지된 상태여서는 안 됩니다. |
canEnable |
사용자가 이 필드를 사용 설정할 수 있는지 여부입니다. 사용자에게 권한이 있어야 하며 이 필드는 사용 중지해야 합니다. |
적용된 기능
적용된 메타데이터에서 이 필드와 관련된 기능입니다.
JSON 표현 |
---|
{ "canRead": boolean, "canSearch": boolean, "canWrite": boolean } |
필드 | |
---|---|
canRead |
사용자가 항목에 적용된 관련 메타데이터를 읽을 수 있는지 여부입니다. |
canSearch |
사용자가 이 필드를 참조하는 Drive 항목을 검색할 수 있는지 여부입니다. |
canWrite |
사용자가 Drive 항목에서 이 필드를 설정할 수 있는지 여부입니다. |
방법 |
|
---|---|
|
새 라벨을 만듭니다. |
|
Drive 항목의 라벨 및 관련 메타데이터를 완전히 삭제합니다. |
|
일련의 업데이트 요청을 적용하여 새 초안 버전을 생성하여 단일 라벨을 업데이트합니다. |
|
게시된 라벨을 사용 중지합니다. |
|
사용 중지된 라벨을 사용 설정하고 게시된 상태로 복원합니다. |
|
리소스 이름으로 라벨을 가져옵니다. |
|
목록 라벨 |
|
모든 초안 변경사항을 라벨에 게시합니다. |
|
라벨의 CopyMode 를 업데이트합니다. |
|
라벨의 권한을 업데이트합니다. |