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

詳情請參閱授權指南。