Method: labels.list

Liệt kê nhãn.

Yêu cầu HTTP

GET https://drivelabels.googleapis.com/v2/labels

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
publishedOnly

boolean

Có chỉ đưa các nhãn đã xuất bản vào kết quả hay không.

  • Khi true, chỉ các bản sửa đổi nhãn đã phát hành hiện tại mới được trả về. Bao gồm cả các nhãn bị vô hiệu hoá. Tên tài nguyên nhãn được trả về tham chiếu đến bản sửa đổi đã phát hành (labels/{id}/{revisionId}).
  • Khi false, các bản sửa đổi hiện tại về nhãn sẽ được trả về và các bản sửa đổi này có thể không được phát hành. Tên tài nguyên nhãn được trả về không tham chiếu đến một bản sửa đổi cụ thể (labels/{id}).
customer

string

Khách hàng để phạm vi yêu cầu danh sách này. Ví dụ: "khách hàng/abcd1234". Nếu bạn không đặt chính sách này, hệ thống sẽ trả về tất cả các nhãn trong khách hàng hiện tại.
languageCode

string

Mã ngôn ngữ BCP-47 dùng để đánh giá nhãn trường đã bản địa hoá. Khi không được chỉ định, các giá trị bằng ngôn ngữ mặc định đã định cấu hình sẽ được sử dụng.
pageSize

integer

Số lượng nhãn tối đa có thể trả về trên mỗi trang. Mặc định: 50. Tối đa: 200.
pageToken

string

Mã thông báo của trang cần trả về.
view

enum (LabelView)

Khi được chỉ định, chỉ một số trường nhất định thuộc về khung hiển thị đã chỉ định mới được trả về.

Tham số kết hợp access.

access chỉ có thể là một trong những trạng thái sau:
useAdminAccess

boolean

Đặt thành true để sử dụng thông tin đăng nhập của quản trị viên của người dùng. Thao tác này sẽ trả về tất cả Nhãn trong khách hàng.
minimumRole

enum (LabelRole)

Chỉ định cấp truy cập mà người dùng phải có đối với các Nhãn được trả về. Vai trò tối thiểu mà người dùng phải có trên nhãn. Giá trị mặc định là READER.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Phản hồi cho nhãn liệt kê.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
Trường
labels[]

object (Label)

Nhãn.
nextPageToken

string

Mã thông báo của trang tiếp theo trong phản hồi.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.labels.readonly
  • https://www.googleapis.com/auth/drive.admin.labels
  • https://www.googleapis.com/auth/drive.admin.labels.readonly

Để biết thêm thông tin, hãy xem bài viết Hướng dẫn uỷ quyền.