Method: labels.delta

Atualiza um único rótulo aplicando um conjunto de solicitações de atualização que resultam em uma nova revisão de rascunho. Para mais informações, consulte Atualizar um rótulo.

A atualização em lote é tudo ou nada: se alguma das solicitações de atualização for inválida, nenhuma mudança será aplicada. O rascunho resultante precisa ser publicado antes que as mudanças possam ser usadas com itens do Drive.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso do rótulo a ser atualizado.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
Campos
writeControl

object (WriteControl)

Oferece controle sobre como as solicitações de gravação são executadas.
requests[]

object (Request)

Uma lista de atualizações a serem aplicadas ao rótulo. As solicitações serão aplicadas na ordem em que forem especificadas.
useAdminAccess

boolean

Defina como true para usar as credenciais de administrador do usuário. O servidor vai verificar se o usuário é administrador do rótulo antes de permitir o acesso.
view

enum (LabelView)

Quando especificado, apenas alguns campos pertencentes à visualização indicada serão retornados.
languageCode

string

O código de idioma BCP-47 a ser usado para avaliar rótulos de campo localizados quando include_label_in_response é true.

Corpo da resposta

Resposta para atualização de rótulo.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "responses": [
    {
      object (Response)
    }
  ],
  "updatedLabel": {
    object (Label)
  }
}
Campos
responses[]

object (Response)

A resposta das atualizações. Isso mapeia 1:1 com as atualizações, embora as respostas a algumas solicitações possam estar vazias.
updatedLabel

object (Label)

O rótulo depois que as atualizações foram aplicadas. Isso só será definido se include_label_in_response for true e não houver erros.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o guia de autorização.

Solicitação

Um único tipo de atualização a ser aplicada a um rótulo.

Representação 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.
}
Campos
Campo de união kind. O tipo de atualização. É necessário especificar exatamente um campo. kind pode ser apenas de um dos tipos a seguir:
updateLabel

object (UpdateLabelPropertiesRequest)

Atualiza as propriedades do rótulo.
createField

object (CreateFieldRequest)

Cria um campo.
updateField

object (UpdateFieldPropertiesRequest)

Atualiza as propriedades básicas de um campo.
updateFieldType

object (UpdateFieldTypeRequest)

Atualize o tipo de campo e/ou as opções de tipo.
enableField

object (EnableFieldRequest)

Ativa o campo.
disableField

object (DisableFieldRequest)

Desativa o campo.
deleteField

object (DeleteFieldRequest)

Exclui um campo do rótulo.
createSelectionChoice

object (CreateSelectionChoiceRequest)

Crie uma opção em um campo de seleção.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Atualiza uma propriedade de escolha em um campo de seleção.
enableSelectionChoice

object (EnableSelectionChoiceRequest)

Ativa uma opção em um campo de seleção.
disableSelectionChoice

object (DisableSelectionChoiceRequest)

Desativar uma opção em um campo de seleção.
deleteSelectionChoice

object (DeleteSelectionChoiceRequest)

Excluir uma opção em um campo de seleção.

UpdateLabelPropertiesRequest

Atualiza as propriedades básicas de um rótulo.

Representação JSON 
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
Campos
updateMask

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz label_properties está implícita e não precisa ser especificada. Um único * pode ser usado como um atalho para atualizar todos os campos.
properties

object (Properties)

Obrigatório. Propriedades do rótulo a serem atualizadas.

CreateFieldRequest

Solicitação para criar um campo em um marcador.

Representação JSON 
{
  "field": {
    object (Field)
  }
}
Campos
field

object (Field)

Obrigatório. Campo a ser criado.

UpdateFieldPropertiesRequest

Solicitação para atualizar propriedades de campo.

Representação JSON 
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Campos
updateMask

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz properties está implícita e não precisa ser especificada. Um único * pode ser usado como um atalho para atualizar todos os campos.
id

string

Obrigatório. O campo a ser atualizado.
properties

object (Properties)

Obrigatório. Propriedades básicas do campo.

UpdateFieldTypeRequest

Solicitação para mudar o tipo de um campo.

Representação 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.
}
Campos
updateMask

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz de type_options está implícita e não precisa ser especificada. Um único * pode ser usado como um atalho para atualizar todos os campos.
id

string

Obrigatório. O campo a ser atualizado.

Campo de união type_options.

type_options pode ser apenas de um dos tipos a seguir:
textOptions

object (TextOptions)

Atualize o campo para "Texto".
integerOptions

object (IntegerOptions)

Atualize o campo para "Integer".
dateOptions

object (DateOptions)

Atualize o campo para "Data".
selectionOptions

object (SelectionOptions)

Atualize o campo para "Selection".
userOptions

object (UserOptions)

Atualize o campo para "Usuário".

EnableFieldRequest

Solicitação para ativar o campo.

Representação JSON 
{
  "id": string
}
Campos
id

string

Obrigatório. ID do campo a ser ativado.

DisableFieldRequest

Solicitação para desativar o campo.

Representação JSON 
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Campos
updateMask

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz disabledPolicy está implícita e não precisa ser especificada. Um único * pode ser usado como um atalho para atualizar todos os campos.
id

string

Obrigatório. Chave do campo a ser desativado.
disabledPolicy

object (DisabledPolicy)

Obrigatório. Política de campo desativado.

DeleteFieldRequest

Solicitação para excluir o campo.

Representação JSON 
{
  "id": string
}
Campos
id

string

Obrigatório. ID do campo a ser excluído.

CreateSelectionChoiceRequest

Solicitação para criar uma opção de seleção.

Representação JSON 
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
Campos
fieldId

string

Obrigatório. O campo de seleção em que uma opção será criada.
choice

object (Choice)

Obrigatório. A opção de criar.

UpdateSelectionChoicePropertiesRequest

Solicitação para atualizar uma propriedade de escolha.

Representação JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Campos
updateMask

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz properties está implícita e não precisa ser especificada. Um único * pode ser usado como um atalho para atualizar todos os campos.
fieldId

string

Obrigatório. O campo de seleção a ser atualizado.
id

string

Obrigatório. A opção de atualização.
properties

object (Properties)

Obrigatório. As propriedades de escolha a serem atualizadas.

EnableSelectionChoiceRequest

Solicitação para ativar uma opção.

Representação JSON 
{
  "fieldId": string,
  "id": string
}
Campos
fieldId

string

Obrigatório. O campo de seleção em que uma escolha será ativada.
id

string

Obrigatório. Opção para ativar.

DisableSelectionChoiceRequest

Solicitação para desativar uma opção.

Representação JSON 
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Campos
updateMask

string (FieldMask format)

Os campos que precisam ser atualizados. É necessário especificar pelo menos um campo. A raiz disabledPolicy está implícita e não precisa ser especificada. Um único * pode ser usado como um atalho para atualizar todos os campos.
fieldId

string

Obrigatório. O campo de seleção em que uma opção será desativada.
id

string

Obrigatório. Opção para desativar.
disabledPolicy

object (DisabledPolicy)

Obrigatório. A política desativada a ser atualizada.

DeleteSelectionChoiceRequest

Solicitação para excluir uma opção.

Representação JSON 
{
  "fieldId": string,
  "id": string
}
Campos
fieldId

string

Obrigatório. O campo de seleção de que uma opção será excluída.
id

string

Obrigatório. Opção para excluir.

Resposta

Uma única resposta de uma atualização.

Representação 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.
}
Campos
Campo de união response. A resposta para a solicitação correspondente. response pode ser apenas de um dos tipos a seguir:
updateLabel

object (UpdateLabelPropertiesResponse)

Atualiza as propriedades básicas de um rótulo.
createField

object (CreateFieldResponse)

Cria um campo.
updateField

object (UpdateFieldPropertiesResponse)

Atualiza as propriedades básicas de um campo.
updateFieldType

object (UpdateFieldTypeResponse)

Atualiza o tipo de campo e/ou as opções de tipo.
enableField

object (EnableFieldResponse)

Ativa o campo.
disableField

object (DisableFieldResponse)

Desativa o campo.
deleteField

object (DeleteFieldResponse)

Exclui um campo do rótulo.
createSelectionChoice

object (CreateSelectionChoiceResponse)

Cria uma opção de lista de seleção para adicionar a um campo de seleção.
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesResponse)

Atualiza uma opção em um campo de seleção.
enableSelectionChoice

object (EnableSelectionChoiceResponse)

Permite uma escolha em um campo de seleção.
disableSelectionChoice

object (DisableSelectionChoiceResponse)

Desativa uma opção em um campo de seleção.
deleteSelectionChoice

object (DeleteSelectionChoiceResponse)

Exclui uma opção de um campo de seleção.

UpdateLabelPropertiesResponse

Esse tipo não tem campos.

Resposta após a atualização das propriedades do rótulo.

CreateFieldResponse

Resposta após a criação do campo.

Representação JSON 
{
  "id": string,
  "priority": integer
}
Campos
id

string

O campo do campo criado. Quando deixada em branco em uma solicitação de criação, uma chave será gerada automaticamente e poderá ser identificada aqui.
priority

integer

A prioridade do campo criado. A prioridade pode mudar do que foi especificado para garantir prioridades contíguas entre os campos (1 a n).

UpdateFieldPropertiesResponse

Resposta após a atualização das propriedades do campo.

Representação JSON 
{
  "priority": integer
}
Campos
priority

integer

A prioridade do campo atualizado. A prioridade pode mudar do que foi especificado para garantir prioridades contíguas entre os campos (1 a n).

UpdateFieldTypeResponse

Esse tipo não tem campos.

Resposta após a atualização do tipo de campo.

EnableFieldResponse

Esse tipo não tem campos.

Resposta após a ativação do campo.

DisableFieldResponse

Esse tipo não tem campos.

Resposta após a desativação do campo.

DeleteFieldResponse

Esse tipo não tem campos.

Resposta após a exclusão do campo.

CreateSelectionChoiceResponse

Resposta após a criação da opção de seleção.

Representação JSON 
{
  "fieldId": string,
  "id": string
}
Campos
fieldId

string

O ID do campo gerado pelo servidor.
id

string

O ID gerado pelo servidor da opção criada no campo.

UpdateSelectionChoicePropertiesResponse

Resposta após a atualização das propriedades de escolha de seleção.

Representação JSON 
{
  "priority": integer
}
Campos
priority

integer

A prioridade da opção atualizada. A prioridade pode mudar do que foi especificado para garantir prioridades contíguas entre as opções (1 a n).

EnableSelectionChoiceResponse

Esse tipo não tem campos.

Resposta após a ativação da escolha.

DisableSelectionChoiceResponse

Esse tipo não tem campos.

Resposta após a desativação da escolha.

DeleteSelectionChoiceResponse

Esse tipo não tem campos.

Resposta após a exclusão da escolha.