Method: files.modifyLabels

修改应用于文件的一组标签。返回已添加或修改标签的列表。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
fileId

string

标签所属的文件的 ID。

请求正文

请求正文包含一个 ModifyLabelsRequest 实例。

响应正文

对 files.modify 标签 请求的响应。其中仅包含由相应请求添加或更新的标签。

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

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

取消设置此字段的值。