라벨 검색

조직은 라벨을 여러 개 가질 수 있고, 라벨에 여러 입력란이 있을 수 있습니다. Labels API는 라벨 읽기를 사용 설정하는 labels 컬렉션을 제공합니다.

이 페이지에서는 라벨을 검색하고 가져오는 방법을 설명합니다.

방법

labels 컬렉션은 라벨 값을 읽는 다음과 같은 메서드를 제공하며 각 메서드는 특정 작업을 염두에 둡니다.

범위 읽기 자료
리소스 이름별 단일 라벨 labels.get
모든 라벨 labels.list

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

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

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

  • 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

name = "labels/NAME@published"

# Label view controls level of data in response
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);
});

모든 라벨 나열

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

다음 항목도 지정해야 합니다.

  • 이 목록 요청의 범위를 지정할 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');
  }
});