Method: labels.delta

通过应用一组更新请求来更新单个标签，从而生成新的草稿修订版本。批量更新是“全部或全无”的：如果任何更新请求无效，系统都不会应用任何更改。您必须先发布生成的草稿修订版，然后才能将更改应用于云端硬盘项。

HTTP 请求

POST https://drivelabels.googleapis.com/v2beta/{name=labels/*}:delta

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要更新的标签的资源名称。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
字段
writeControl

object (WriteControl)

用于控制写入请求的执行方式。
requests[]

object (Request)

要应用于标签的更新列表。系统会按照指定的顺序应用请求。
useAdminAccess

boolean

设置为 true 以使用用户的管理员凭据。服务器会先验证用户是否为标签的管理员，然后再允许访问。
view

enum (LabelView)

指定此参数后，系统将仅返回属于所指视图的特定字段。
languageCode

string

当 include_label_in_response 为 true 时，用于评估本地化字段标签的 BCP-47 语言代码。

响应正文

标签更新的响应。

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

JSON 表示法 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
字段
responses[]

object (Response)

更新的回复。这与更新 1 对 1 对应，但对某些请求的响应可能为空。
updatedLabel

object (Label)

应用更新后的标签。只有当 [BatchUpdateLabelResponse2.include_label_in_response] 为 true 且没有错误时，才会设置此值。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

如需了解详情，请参阅授权指南。

请求

要应用于标签的单种更新。

JSON 表示法 
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
字段
联合字段 kind。更新类型。必须正好指定一个字段。kind 只能是下列其中一项：
updateLabel

object (UpdateLabelPropertiesRequest)

更新标签属性。
createField

object (CreateFieldRequest)

创建新字段。
updateField

object (UpdateFieldPropertiesRequest)

更新字段的基本属性。
updateFieldType

object (UpdateFieldTypeRequest)

更新字段类型和/或类型选项。
enableField

object (EnableFieldRequest)

启用该字段。
disableField

object (DisableFieldRequest)

停用该字段。
deleteField

object (DeleteFieldRequest)

从标签中删除字段。
createSelectionChoice

object (CreateSelectionChoiceRequest)

在“选择”字段中创建“选项”。
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

更新选择字段中的“选择”属性。
enableSelectionChoice

object (EnableSelectionChoiceRequest)

在选择字段中启用“选择”。
disableSelectionChoice

object (DisableSelectionChoiceRequest)

停用选择字段中的选项。
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

删除选择字段中的选项。

UpdateLabelPropertiesRequest

更新标签的基本属性。

JSON 表示法 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
字段
updateMask

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 label_properties 是隐含的，不应指定。您可以使用单个 * 作为更新每个字段的简写形式。
properties

object (Properties)

必需。要更新的标签属性。

CreateFieldRequest

请求在标签中创建字段。

JSON 表示法 
{
  "field": {
    object (Field)
  }
}
字段
field

object (Field)

必需。要创建的字段。

UpdateFieldPropertiesRequest

请求更新字段属性。

JSON 表示法 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
字段
updateMask

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 properties 是隐含的，不应指定。您可以使用单个 * 作为更新每个字段的简写形式。
id

string

必需。要更新的字段。
properties

object (Properties)

必需。基本字段属性。

UpdateFieldTypeRequest

请求更改字段的类型。

JSON 表示法 
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
字段
updateMask

string (FieldMask format)

应更新的字段。必须至少指定一个字段。type_options 的根是隐含的，不应指定。您可以使用单个 * 作为更新每个字段的简写形式。
id

string

必需。要更新的字段。

联合字段 type_options。

type_options 只能是下列其中一项：
textOptions

object (TextOptions)

将字段更新为“文本”。
integerOptions

object (IntegerOptions)

将字段更新为整数。
dateOptions

object (DateOptions)

将字段更新为“日期”。
selectionOptions

object (SelectionOptions)

将“更新字段”更改为“选择”。
userOptions

object (UserOptions)

将字段更新为“用户”。

EnableFieldRequest

请求启用该字段。

JSON 表示法 
{
  "id": string
}
字段
id

string

必需。要启用的字段的 ID。

DisableFieldRequest

请求停用该字段。

JSON 表示法 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
字段
updateMask

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 disabledPolicy 是隐含的，不应指定。您可以使用单个 * 作为更新每个字段的简写形式。
id

string

必需。要停用的字段的键。
disabledPolicy

object (DisabledPolicy)

必需。“字段已停用”政策。

DeleteFieldRequest

请求删除字段。

JSON 表示法 
{
  "id": string
}
字段
id

string

必需。要删除的字段的 ID。

CreateSelectionChoiceRequest

请求创建选择选项。

JSON 表示法 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
字段
fieldId

string

必需。用于创建选项的选择字段。
choice

object (Choice)

必需。要创建的选项。

UpdateSelectionChoicePropertiesRequest

请求更新 Choice 属性。

JSON 表示法 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
字段
updateMask

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 properties 是隐含的，不应指定。您可以使用单个 * 作为更新每个字段的简写形式。
fieldId

string

必需。要更新的选择字段。
id

string

必需。要更新的选项。
properties

object (Properties)

必需。要更新的 Choice 属性。

EnableSelectionChoiceRequest

请求启用选项。

JSON 表示法 
{
  "fieldId": string,
  "id": string
}
字段
fieldId

string

必需。将启用“选择”的选择字段。
id

string

必需。启用选项。

DisableSelectionChoiceRequest

请求停用选项。

JSON 表示法 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
字段
updateMask

string (FieldMask format)

应更新的字段。必须至少指定一个字段。根 disabledPolicy 是隐含的，不应指定。您可以使用单个 * 作为更新每个字段的简写形式。
fieldId

string

必需。要停用的选项所在的选择字段。
id

string

必需。停用选项。
disabledPolicy

object (DisabledPolicy)

必需。要更新的已停用政策。

DeleteSelectionChoiceRequest

请求删除选项。

JSON 表示法 
{
  "fieldId": string,
  "id": string
}
字段
fieldId

string

必需。要从中删除选项的选择字段。
id

string

必需。删除选项。

响应

更新中的单个响应。

JSON 表示法 
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
字段
联合字段 response。相应请求的响应。response 只能是下列其中一项：
updateLabel

object (UpdateLabelPropertiesResponse)

更新了标签的基本属性。
createField

object (CreateFieldResponse)

创建新字段。
updateField

object (UpdateFieldPropertiesResponse)

更新字段的基本属性。
updateFieldType

object (UpdateFieldTypeResponse)

更新字段类型和/或类型选项。
enableField

object (EnableFieldResponse)

启用字段。
disableField

object (DisableFieldResponse)

停用字段。
deleteField

object (DeleteFieldResponse)

从标签中删除字段。
createSelectionChoice

object (CreateSelectionChoiceResponse)

创建要添加到选择字段的新选择列表选项。
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

更新选择字段中的选项。
enableSelectionChoice

object (EnableSelectionChoiceResponse)

在选择字段中启用“选择”。
disableSelectionChoice

object (DisableSelectionChoiceResponse)

停用选择字段中的选项。
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

从选择字段中删除选项。

UpdateLabelPropertiesResponse

此类型没有字段。

更新标签属性后的响应。

CreateFieldResponse

创建字段后的响应。

JSON 表示法 
{
  "id": string,
  "priority": integer
}
字段
id

string

所创建字段的字段。如果在创建请求中留空，系统会自动生成一个键，您可以在此处识别该键。
priority

integer

创建的字段的优先级。优先级可能会与指定的优先级不同，以确保字段之间的优先级连续（1-n）。

UpdateFieldPropertiesResponse

更新字段属性后的响应。

JSON 表示法 
{
  "priority": integer
}
字段
priority

integer

更新的字段的优先级。优先级可能会与指定的优先级不同，以确保字段之间的优先级连续（1-n）。

UpdateFieldTypeResponse

此类型没有字段。

更新字段类型后的响应。

EnableFieldResponse

此类型没有字段。

启用了“响应后跟随”字段。

DisableFieldResponse

此类型没有字段。

响应以下字段已停用。

DeleteFieldResponse

此类型没有字段。

删除字段后的响应。

CreateSelectionChoiceResponse

创建选择选项后的响应。

JSON 表示法 
{
  "fieldId": string,
  "id": string
}
字段
fieldId

string

服务器为该字段生成的 ID。
id

string

服务器为字段中创建的选项生成的 ID

UpdateSelectionChoicePropertiesResponse

更新选择选项属性后的响应。

JSON 表示法 
{
  "priority": integer
}
字段
priority

integer

更新后的选项的优先级。优先级可能会与指定的优先级不同，以确保选项之间的优先级连续（1-n）。

EnableSelectionChoiceResponse

此类型没有字段。

启用“选择后响应”功能。

DisableSelectionChoiceResponse

此类型没有字段。

停用“选择后响应”。

DeleteSelectionChoiceResponse

此类型没有字段。

删除选项后的响应。