라벨 만들기 및 게시하기

이 문서에서는 Google Drive Labels API를 사용하여 라벨을 만들고 게시하는 방법을 설명합니다.

라벨 만들기

라벨을 만들려면 create 메서드를 labels 리소스에서 사용합니다. 라벨에는 선택적으로 하나 이상의 Field 객체가 포함될 수 있습니다.

다음도 지정해야 합니다.

  • LabelType 객체

  • Properties 객체를 통한 라벨 title

  • 사용자의 관리자 인증 정보를 사용하도록 useAdminAccess 쿼리 매개변수가 true로 설정됩니다. 액세스를 허용하기 전에 서버는 사용자에게 필요한 분류 라벨 관리 관리자 권한이 있는지 확인합니다.

다음 코드 샘플은 create 메서드를 사용하여 지정된 제목과 두 개의 Choice 객체가 있는 하나의 SelectionOptions Field가 포함된 표준 관리자 라벨을 만드는 방법을 보여줍니다.

Python

label_body = {
    'labelType': 'ADMIN',
    'properties': {
        'title': 'TITLE'
    },
    'fields': [{
        'properties': {
            'displayName': 'DISPLAY_NAME'
        },
        'selectionOptions': {
            'listOptions': {},
            'choices': [{
                'properties': {
                    'displayName': 'CHOICE_1'
                }
            }, {
                'properties': {
                    'displayName': 'CHOICE_2'
                }
            }]
        }
    }]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

Node.js

var label = {
  'labelType': 'ADMIN',
  'properties': {
    'title': 'TITLE'
  },
  'fields': [{
    'properties': {
      'displayName': 'DISPLAY_NAME'
    },
    'selectionOptions': {
      'listOptions': {},
      'choices': [{
        'properties': {
          'displayName': 'CHOICE_1'
        }
      }, {
        'properties': {
          'displayName': 'CHOICE_2'
        }
      }]
    }
  }]
};

service.labels.create({
  requestBody: label,
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

다음을 바꿉니다.

  • TITLE: 라벨의 제목입니다.
  • DISPLAY_NAME: 필드의 표시 이름입니다.
  • CHOICE_1: SelectionOptions 필드의 첫 번째 선택사항입니다.
  • CHOICE_2: SelectionOptions 필드의 두 번째 선택사항입니다.

라벨은 UNPUBLISHED_DRAFT State에서 생성됩니다. 라벨은 사용자에게 표시되고 파일에서 사용되려면 PUBLISHED여야 합니다. 자세한 내용은 라벨 수명 주기를 참고하세요.

라벨 한도

라벨을 만들고 적용할 때는 다음 한도가 적용됩니다.

  • 표준 라벨: 150개
  • 라벨당 필드: 10개

라벨에서 필드 사용하기

다음 표에는 라벨에 추가할 수 있는 필드 유형, 사용자가 필드와 상호작용하는 방식, 형식 고려사항 및 한도가 설명되어 있습니다.

Field Type 사용자가 할 수 있는 작업 형식 고려사항 및 한도
SelectionOptions 목록에서 하나 이상의 옵션 선택 지원되는 최대 옵션 수는 200개입니다.
파일의 최대 선택 수는 ListOptions에 구성된 대로 10개입니다.
IntegerOptions 숫자 값 입력 정수만 지원됩니다.
DateOptions 캘린더 날짜 선택 (선택사항) DateFormat은 "Long: Month DD, YYYY" 또는 "Short: MM/DD/YY"로 설정할 수 있습니다.
TextOptions 텍스트 상자에 텍스트 입력 지원되는 최대 문자 수는 100자입니다.
UserOptions Google Workspace 연락처에서 하나 이상의 사용자 선택 파일의 최대 사용자 항목 수는 ListOptions에 구성된 대로 10개입니다.

라벨 게시하기

Drive Labels API를 사용하면 초안 라벨이 완료된 후 게시할 수 있습니다. 그러면 라벨이 사용자에게 표시되고 파일에 적용할 수 있습니다.

라벨을 게시하려면 publish 메서드를 labels 리소스에서 사용하고 다음을 지정합니다.

  • 모든 라벨을 나타내는 labels 리소스입니다. 여기에는 리소스 name 및 id가 포함되며, 이는 라벨의 전역적으로 고유한 식별자입니다.

  • 사용자의 관리자 인증 정보를 사용하도록 useAdminAccess 쿼리 매개변수가 true로 설정됩니다. 액세스를 허용하기 전에 서버는 사용자에게 필요한 분류 라벨 관리 관리자 권한이 있는지 확인합니다.

다음 코드 샘플은 라벨의 id를 사용하여 올바른 라벨을 식별하고 게시하는 방법을 보여줍니다.

Python

service.labels().publish(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.publish({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

ID를 게시할 라벨의 ID로 바꿉니다.

라벨이 게시되면 라벨이 PUBLISHED State로 이동하고 라벨의 버전 ID가 증가합니다. 그러면 라벨이 사용자에게 표시되고 파일에 적용할 수 있습니다. 자세한 내용은 라벨 수명 주기를 참고하세요.

라벨 게시 시 제약조건

라벨을 게시할 때는 다음 제약조건에 유의하세요.

  • 게시된 라벨은 원래 초안 상태로 돌아갈 수 없습니다. 자세한 내용은 라벨 수명 주기를 참고하세요.

  • 라벨을 게시하면 새로 게시된 버전이 생성됩니다. 이전의 모든 초안 버전은 삭제됩니다. 이전에 게시된 버전은 유지되지만 필요에 따라 자동 삭제될 수 있습니다.

  • 게시된 후에는 일부 변경사항이 더 이상 허용되지 않습니다. 일반적으로 이는 라벨과 관련된 기존 메타데이터를 무효화하거나 새로운 제한사항을 트리거하는 변경사항이 거부됨을 의미합니다. 예를 들어 라벨이 게시된 후에는 라벨에 대한 다음 변경사항이 허용되지 않습니다.

    • 라벨이 직접 삭제됩니다. (먼저 사용 중지한 후 삭제해야 합니다.)
    • Field.FieldType이 변경됩니다.
    • Field 유효성 검사 옵션 업데이트로 인해 이전에 허용된 항목이 거부됩니다.
    • 최대 항목 수 감소