Method: files.modifyLabels

修改套用至檔案的標籤組合。傳回已新增或修改的標籤清單。

HTTP 要求

POST https://www.googleapis.com/drive/v2/files/{fileId}/modifyLabels

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
fileId

string

標籤所屬檔案的 ID。

要求主體

要求主體包含 ModifyLabelsRequest 的例項。

回應主體

回應 files.modifyLabels 要求。這只包含要求新增或更新的標籤。

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "modifiedLabels": [
    {
      object (Label)
    }
  ],
  "kind": string
}
欄位
modifiedLabels[]

object (Label)

該要求新增或更新的標籤清單。

kind

string

一律為 drive#modifyLabelsResponse

授權範圍

需要下列其中一種 OAuth 範圍:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata

部分範圍受到限制,應用程式必須進行安全性評估,才能使用這些範圍。詳情請參閱授權指南

ModifyLabelsRequest

修改檔案標籤組合的要求。這個請求可能包含的修改項目多半會全部成功,也可能全部失敗。

JSON 表示法
{
  "labelModifications": [
    {
      object (LabelModification)
    }
  ],
  "kind": string
}
欄位
labelModifications[]

object (LabelModification)

要套用至檔案標籤的修改項目清單。

kind

string

一律為 drive#modifyLabelsRequest

LabelModification

修改檔案標籤。LabelModification 可用來為檔案套用標籤、更新檔案的現有標籤,或是移除檔案的標籤。

JSON 表示法
{
  "labelId": string,
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "removeLabel": boolean,
  "kind": string
}
欄位
labelId

string

要修改的標籤 ID。

fieldModifications[]

object (FieldModification)

這個標籤欄位的修改清單。

removeLabel

boolean

如果為 true,則會從檔案中移除標籤。

kind

string

一律為 drive#labelModification

FieldModification

修改標籤欄位。

JSON 表示法
{
  "fieldId": string,
  "kind": string,
  "setDateValues": [
    string
  ],
  "setTextValues": [
    string
  ],
  "setSelectionValues": [
    string
  ],
  "setIntegerValues": [
    string
  ],
  "setUserValues": [
    string
  ],
  "unsetValues": boolean
}
欄位
fieldId

string

要修改的欄位 ID。

kind

string

一律為 drive#labelFieldModification

setDateValues[]

string

date 欄位的值替換為這些新值。此字串必須採用 RFC 3339 完整日期格式:YYYY-MM-DD。

setTextValues[]

string

設定 text 欄位的值。

setSelectionValues[]

string

selection 欄位替換為這些新值。

setIntegerValues[]

string (int64 format)

integer 欄位的值替換為這些新值。

setUserValues[]

string

user 欄位替換為這些新值。值必須是有效的電子郵件地址。

unsetValues

boolean

取消設定這個欄位的值。