Method: labels.delta

Atualiza um único marcador aplicando um conjunto de solicitações de atualização, resultando em uma nova revisão de rascunho. A atualização em lote é tudo ou nada: se alguma das solicitações de atualização for inválida, nenhuma alteração será aplicada. O rascunho da revisão resultante precisa ser publicado antes que as alterações possam ser usadas com os 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)

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

object (Request)

Uma lista de atualizações para aplicar 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 verificará se o usuário é um administrador do marcador 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 for true.

Corpo da resposta

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

Resposta para atualização do marcador.

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

object (Response)

A resposta das atualizações. Ele mapeia individualmente com as atualizações, embora as respostas a algumas solicitações possam ficar vazias.
updatedLabel

object (Label)

O marcador após a aplicação das atualizações. Isso só será definido se [BatchUpdateLabelResponse2.include_label_in_response] for true e não houver erros.

Escopos de autorização

Requer um dos seguintes escopos de 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 para aplicar 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. Exatamente um campo é obrigatório. kind pode ser apenas de um dos tipos a seguir:
updateLabel

object (UpdateLabelPropertiesRequest)

Atualiza as propriedades do rótulo.
createField

object (CreateFieldRequest)

Cria um novo Field.
updateField

object (UpdateFieldPropertiesRequest)

Atualiza as propriedades básicas de um Field.
updateFieldType

object (UpdateFieldTypeRequest)

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

object (EnableFieldRequest)

Ativa o campo.
disableField

object (DisableFieldRequest)

Desativa o campo.
deleteField

object (DeleteFieldRequest)

Exclui um campo do rótulo.
createSelectionChoice

object (CreateSelectionChoiceRequest)

Cria Escolha em um campo "Selection".
updateSelectionChoiceProperties

object (UpdateSelectionChoicePropertiesRequest)

Atualizar as propriedades de uma Opção em um campo de seleção.
enableSelectionChoice

object (EnableSelectionChoiceRequest)

Ativar 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 identificador.

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

string (FieldMask format)

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

object (Properties)

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

CreateFieldRequest

Solicitação para criar um campo dentro de um marcador.

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

object (Field)

Obrigatório. Campo a ser criado.

UpdateFieldPropertiesRequest

Solicitação para atualizar as propriedades de campo.

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

string (FieldMask format)

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

string

Obrigatório. O campo a ser atualizado.
properties

object (Properties)

Obrigatório. Propriedades básicas de campo.

UpdateFieldTypeRequest

Solicitação para alterar 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)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "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 serão atualizados. É necessário especificar pelo menos um campo. A raiz de type_options está implícita e não deve ser especificada. Um único * pode ser usado como abreviação para atualizar cada campo.
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 "Text".
longTextOptions

object (LongTextOptions)

Atualize o campo para "Texto longo".
integerOptions

object (IntegerOptions)

Atualize o campo para número inteiro.
dateOptions

object (DateOptions)

Atualize o campo para "Data".
selectionOptions

object (SelectionOptions)

Atualização do campo para seleção.
userOptions

object (UserOptions)

Atualize o campo para "Usuário".

LongTextOptions

Opções do tipo de campo "Texto longo".

Representação JSON 
{
  "minLength": integer,
  "maxLength": integer
}
Campos
minLength

integer

Apenas saída. O tamanho mínimo válido dos valores para o campo de texto.
maxLength

integer

Apenas saída. O tamanho máximo válido dos valores para o campo de texto.

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 serão atualizados. É necessário especificar pelo menos um campo. A raiz disabledPolicy está implícita e não deve ser especificada. Um único * pode ser usado como abreviação para atualizar cada campo.
id

string

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

object (DisabledPolicy)

Obrigatório. Política de campo desativada.

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 escolha de criar.

UpdateSelectionChoicePropertiesRequest

Solicitação para atualizar as propriedades de Choice.

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

string (FieldMask format)

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

string

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

string

Obrigatório. A Opção de atualizar.
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 Opção será ativada.
id

string

Obrigatório. Opção de 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 serão atualizados. É necessário especificar pelo menos um campo. A raiz disabledPolicy está implícita e não deve ser especificada. Um único * pode ser usado como abreviação para atualizar cada campo.
fieldId

string

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

string

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

object (DisabledPolicy)

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

DeleteSelectionChoiceRequest

Pedido para excluir uma Opção.

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

string

Obrigatório. O campo de seleção do qual uma Opção será excluída.
id

string

Obrigatório. Opção de 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ção das propriedades básicas de um identificador.
createField

object (CreateFieldResponse)

Cria um novo Field.
updateField

object (UpdateFieldPropertiesResponse)

Atualiza as propriedades básicas de um Field.
updateFieldType

object (UpdateFieldTypeResponse)

Atualize as opções de tipo e/ou tipo de campo.
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 nova 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)

Ativa uma Opção 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

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

CreateFieldResponse

Resposta após criação de campo.

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

string

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

integer

A prioridade do campo criado. A prioridade pode mudar em relação à especificada para garantir prioridades contíguas entre os campos (1-n).

UpdateFieldPropertiesResponse

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

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

integer

A prioridade do campo atualizado. A prioridade pode mudar em relação à especificada para garantir prioridades contíguas entre os campos (1-n).

UpdateFieldTypeResponse

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

EnableFieldResponse

Resposta após ativação de campo.

DisableFieldResponse

Campo de resposta seguinte desativado.

DeleteFieldResponse

Resposta após a exclusão de campo.

CreateSelectionChoiceResponse

Resposta após a criação da escolha da 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 da Escolha da seleção.

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

integer

A prioridade da opção atualizada. A prioridade pode mudar em relação à especificada para garantir prioridades contíguas entre as opções (1-n).

EnableSelectionChoiceResponse

Resposta ativada após a escolha.

DisableSelectionChoiceResponse

Resposta após escolha desativada.

DeleteSelectionChoiceResponse

Resposta após a exclusão da Opção.