Method: labels.list

列出標籤。

HTTP 要求

GET https://drivelabels.googleapis.com/v2/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

詳情請參閱授權指南。