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. Google Drive Labels API cung cấp tài nguyên labels để cho phép đọc nhãn.

Tài liệu này mô tả cách tìm kiếm và truy xuất nhãn bằng Drive Labels API.

Phương thức

Tài nguyên 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 Phương thức
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 duy nhất theo tên tài nguyên, hãy sử dụng phương thức get trên tài nguyên labels.

Bạn cần có tài nguyên nhãn name và có thể có cấu trúc như sau:

  • labels/{id} hoặc labels/{id}@latest: Lấy bản sửa đổi nhãn mới nhất.
  • labels/{id}@published: Lấy 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ã bản sửa đổi đã chỉ định.

Bạn phải chỉ định một đối tượng LabelView làm LABEL_VIEW_FULL để đặt một khung hiển thị 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ể.

Mã mẫu sau đây cho biết cách sử dụng name của nhãn để lấy một nhãn duy nhất theo tên tài nguyên của nhã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
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);
});

Thay thế NAME bằng tên của nhãn.

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 list trên tài nguyên labels.

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

  • Một tham số truy vấn 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, tất cả nhãn trong khách hàng hiện tại sẽ được trả về.

  • Một đối tượng LabelView dưới dạng LABEL_VIEW_FULL để đặt một khung hiển thị 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ể.

Mã mẫu sau đây cho biết cách sử dụng tham số truy vấn customer để lấy 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');
  }
});

Thay thế CUSTOMER bằng tên của khách hàng.