Method: labels.list

列出标签。

HTTP 请求

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

网址采用 gRPC 转码语法。

查询参数

参数
publishedOnly

boolean

是否仅在结果中包含已发布的标签。

  • 如果为 true，则仅返回当前已发布的标签修订版。包括已停用的标签。返回的标签资源名称引用已发布的修订版 (labels/{id}/{revisionId})。
  • 如果为 false，则返回当前的标签修订版本，这些修订版本可能尚未发布。返回的标签资源名称不会引用特定修订版本 (labels/{id})。
customer

string

此列表请求的客户范围。例如：“customers/abcd1234”。如果未设置，则会返回当前客户中的所有标签。
languageCode

string

用于评估本地化字段标签的 BCP-47 语言代码。如果未指定，则使用默认配置语言中的值。
pageSize

integer

每页返回的标签数量上限。默认值：50。上限：200。
pageToken

string

要返回的页面的令牌。
view

enum (LabelView)

指定此参数后，系统仅会返回指明视图的特定字段。

联合参数 access。

access 只能是下列其中一项：
useAdminAccess

boolean

设置为 true 以使用用户的管理员凭据。这将返回客户中的所有标签。
minimumRole

enum (LabelRole)

指定用户对返回的标签必须具有的访问权限级别。用户对标签必须具有的最低角色。默认为 READER。

请求正文

请求正文必须为空。

响应正文

用于列出标签的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "labels": [
    {
      object (Label)
    }
  ],
  "nextPageToken": string
}
字段
labels[]

object (Label)

标签。
nextPageToken

string

响应中下一页的令牌。

授权范围

需要以下 OAuth 范围之一：

  • 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

如需了解详情，请参阅授权指南。