Tìm nhãn

Tổ chức của bạn có thể có nhiều nhãn, trong đó mỗi nhãn có một số trường. Labels API cung cấp tập hợp labels để cho phép đọ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 thức sau để đọc giá trị nhãn, mỗi phương thức có một nhiệm 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

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

Bạn phải cung cấp tên tài nguyên nhãn và tên này có thể có cấu trúc như sau:

  • labels/{id} hoặc labels/{id}@latest – Nhận phiên bản nhãn mới nhất.
  • labels/{id}@published – Nhận bản sửa đổi nhãn đã xuất bản hiện tại.
  • labels/{id}@{revisionId} – Lấy nhãn tại mã nhận dạng bản sửa đổi được chỉ định.

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

  • LabelView là LABEL_VIEW_FULL để đặt Chế độ xem tài nguyên được áp dụng cho các phản hồi nhãn. LABEL_VIEW_FULL trả về tất cả các trường có thể có.

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ả các nhãn

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

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

  • Một customer để giới hạn phạm vi yêu cầu danh sách này. Nếu bạn không đặt customer, thì tất cả nhãn trong khách hàng hiện tại sẽ được trả về.

  • LabelView là LABEL_VIEW_FULL để đặt Chế độ xem tài nguyên được áp dụng cho các phản hồi nhãn. LABEL_VIEW_FULL trả về tất cả các trường có thể có.

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