Method: files.modifyLabels

Modifica o conjunto de marcadores aplicados a um arquivo. Para mais informações, consulte Definir um campo de rótulo em um arquivo.

Retorna uma lista dos rótulos que foram adicionados ou modificados.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
fileId

string

O ID do arquivo a que os rótulos pertencem.

Corpo da solicitação

O corpo da solicitação contém uma instância de ModifyLabelsRequest.

Corpo da resposta

Resposta a uma solicitação files.modifyLabels. Contém apenas os rótulos adicionados ou atualizados pela solicitação.

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

Representação JSON 
{
  "modifiedLabels": [
    {
      object (Label)
    }
  ],
  "kind": string
}
Campos
modifiedLabels[]

object (Label)

A lista de rótulos adicionados ou atualizados pela solicitação.
kind

string

Esse valor é sempre "drive#modifyLabelsResponse".

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata

Alguns escopos são restritos e exigem uma avaliação de segurança para que o app possa usá-los. Para mais informações, consulte o guia de autorização.

ModifyLabelsRequest

Uma solicitação para modificar o conjunto de rótulos em um arquivo. Essa solicitação pode conter muitas modificações que serão bem-sucedidas ou falharão atomicamente.

Representação JSON 
{
  "labelModifications": [
    {
      object (LabelModification)
    }
  ],
  "kind": string
}
Campos
labelModifications[]

object (LabelModification)

A lista de modificações a serem aplicadas aos marcadores no arquivo.
kind

string

Esse valor é sempre "drive#modifyLabelsRequest".

LabelModification

Uma modificação em um rótulo de um arquivo. Um LabelModification pode ser usado para aplicar, atualizar ou remover um rótulo de um arquivo.

Representação JSON 
{
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "labelId": string,
  "removeLabel": boolean,
  "kind": string
}
Campos
fieldModifications[]

object (FieldModification)

A lista de modificações nos campos deste rótulo.
labelId

string

O ID do marcador a ser modificado.
removeLabel

boolean

Se for "true", o marcador será removido do arquivo.
kind

string

Esse valor é sempre "drive#labelModification".

FieldModification

Uma modificação no campo de um marcador.

Representação JSON 
{
  "setDateValues": [
    string
  ],
  "setTextValues": [
    string
  ],
  "setSelectionValues": [
    string
  ],
  "setIntegerValues": [
    string
  ],
  "setUserValues": [
    string
  ],
  "fieldId": string,
  "kind": string,
  "unsetValues": boolean
}
Campos
setDateValues[]

string

Substitui o valor de um campo date por estes novos valores. A string precisa estar no formato de data completa RFC 3339: AAAA-MM-DD.
setTextValues[]

string

Define o valor de um campo text.
setSelectionValues[]

string

Substitui um campo selection por estes novos valores.
setIntegerValues[]

string (int64 format)

Substitui o valor de um campo integer por estes novos valores.
setUserValues[]

string

Substitui um campo user por estes novos valores. Os valores precisam ser endereços de e-mail válidos.
fieldId

string

O ID do campo a ser modificado.
kind

string

Esse valor é sempre "drive#labelFieldModification".
unsetValues

boolean

Remove os valores desse campo.