라벨 검색

조직에는 여러 라벨이 있을 수 있으며 라벨에는 여러 필드가 있습니다. Google Drive Labels API는 라벨을 읽을 수 있도록 labels 리소스를 제공합니다.

이 문서에서는 Drive Labels API를 사용하여 라벨을 검색하고 가져오는 방법을 설명합니다.

메서드

labels 리소스는 라벨 값을 읽기 위한 다음과 같은 메서드를 제공하며 각 메서드에는 특정 작업이 있습니다.

범위 메서드
리소스 이름별 단일 라벨 labels.get
모든 라벨 labels.list

리소스 이름으로 라벨 가져오기

리소스 이름으로 단일 라벨을 가져오려면 get 리소스에서 labels 메서드를 사용합니다.

라벨 리소스 name은 필수이며 다음과 같이 구성할 수 있습니다.

  • labels/{id} 또는 labels/{id}@latest: 최신 라벨 버전을 가져옵니다.
  • labels/{id}@published: 현재 게시된 라벨 버전을 가져옵니다.
  • labels/{id}@{revisionId}: 지정된 버전 ID에서 라벨을 가져옵니다.

라벨 응답에 적용되는 리소스 뷰를 설정하려면 LabelView 객체를 LABEL_VIEW_FULL로 지정해야 합니다. LABEL_VIEW_FULL은 가능한 모든 필드를 반환합니다.

다음 코드 샘플은 라벨의 name을 사용하여 리소스 이름으로 단일 라벨을 가져오는 방법을 보여줍니다.

Python

# Label name, with or without revision:
#
# Revision specified:
# labels/LABEL_ID@published
# labels/LABEL_ID@latest
# labels/LABEL_ID@1
#
# No revision specified, returns latest revision:
# labels/LABEL_ID
name = 'labels/NAME@published'

# Label view controls level of data in response
view = 'LABEL_VIEW_FULL'

label = service.labels().get(
    name=name,
    view=view
).execute()

Node.js

// Label name, with or without revision:
//
// Revision specified:
// labels/LABEL_ID@published
// labels/LABEL_ID@latest
// labels/LABEL_ID@1
//
// No revision specified, returns latest revision:
// labels/LABEL_ID
const name = 'labels/NAME@published';

// Label view controls level of data in response
const view = 'LABEL_VIEW_FULL';

service.labels.get({
  name: name,
  view: view
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

NAME을 라벨 이름으로 바꿉니다.

모든 라벨 나열

라벨 목록을 가져오려면 list 리소스에서 labels 메서드를 사용합니다.

다음도 지정해야 합니다.

  • 이 목록 요청의 범위를 지정할 customer 쿼리 매개변수 customer가 설정되지 않은 경우 현재 고객 내의 모든 라벨이 반환됩니다.

  • 라벨 응답에 적용되는 리소스 뷰를 설정하려면 LabelView 객체 를 LABEL_VIEW_FULL로 지정해야 합니다. LABEL_VIEW_FULL은 가능한 모든 필드를 반환합니다.

다음 코드 샘플은 customer 쿼리 매개변수를 사용하여 라벨 목록을 가져오는 방법을 보여줍니다.

Python

response = service.labels().list(
    customer='customers/CUSTOMER',
    view='LABEL_VIEW_FULL'
).execute()

Node.js

const params = {
  customer: 'customers/CUSTOMER',
  view: 'LABEL_VIEW_FULL'
};

service.labels.list(params, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  const labels = res.data.labels;
  if (labels) {
    labels.forEach((label) => {
      const name = label.name;
      const title = label.properties.title;
      console.log(`${name}\t${title}`);
    });
  } else {
    console.log('No Labels');
  }
});

CUSTOMER를 고객 이름으로 바꿉니다.