Method: files.modifyLabels

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

HTTP 要求

POST https://www.googleapis.com/drive/v3/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 表示法 
{
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "labelId": string,
  "removeLabel": boolean,
  "kind": string
}
欄位
fieldModifications[]

object (FieldModification)

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

string

要修改的標籤 ID。
removeLabel

boolean

如果是 true，系統會從檔案移除標籤。
kind

string

這項值一律為 drive#labelModification。

FieldModification

修改標籤的欄位。

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

string

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

string

設定 text 欄位的值。
setSelectionValues[]

string

以這些新值取代 selection 欄位。
setIntegerValues[]

string (int64 format)

以這些新值取代 integer 欄位的值。
setUserValues[]

string

以這些新值取代 user 欄位。值必須是有效的電子郵件地址。
fieldId

string

要修改的欄位 ID。
kind

string

這項值一律為 drive#labelFieldModification。
unsetValues

boolean

取消設定這個欄位的值。