Tìm nhãn

Tổ chức của bạn có thể có nhiều nhãn, các nhãn có nhiều trường. API Nhãn cung cấp Bộ sưu tập labels để bật đọc nhãn.

Trang này mô tả cách tìm kiếm và truy xuất nhãn.

Phương thức

Tập hợp labels cung cấp các phương pháp sau để đọc giá trị nhãn, mỗi giá trị có một tác vụ cụ thể:

Phạm vi Đọc sách
Một nhãn theo tên tài nguyên labels.get
Tất cả nhãn labels.list

Lấy nhãn theo tên tài nguyên

Để nhận một nhãn theo tên tài nguyên, hãy sử dụng phương thức Phương thức labels.get.

Tên tài nguyên nhãn là bắt buộc và có thể có cấu trúc như sau:

  • labels/{id} hoặc labels/{id}@latest – Tải bản sửa đổi nhãn mới nhất.
  • labels/{id}@published – Tải bản sửa đổi nhãn hiện đã phát hành.
  • labels/{id}@{revisionId} – Lấy nhãn tại mã nhận dạng bản sửa đổi đã chỉ định.

Bạn cũng phải chỉ định:

  • LabelViewLABEL_VIEW_FULL để đặt khung hiển thị Resource (Tài nguyên) áp dụng cho phản hồi của nhãn. LABEL_VIEW_FULL trả về mọi trường có thể.

Ví dụ này sử dụng Name để lấy một nhãn duy nhất theo tên tài nguyên.

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);
});

Liệt kê tất cả nhãn

Để xem danh sách nhãn, hãy sử dụng Phương thức labels.list.

Bạn cũng phải chỉ định:

  • customer để xác định phạm vi của chỉ số này liệt kê yêu cầu. Nếu bạn không đặt customer, tất cả nhãn trong phạm vi hiện tại trả lại khách hàng.

  • LabelViewLABEL_VIEW_FULL để đặt khung hiển thị Resource (Tài nguyên) áp dụng cho phản hồi của nhãn. LABEL_VIEW_FULL trả về mọi trường có thể.

Ví dụ này sử dụng CUSTOMER để truy xuất danh sách nhãn.

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');
  }
});