Method: files.modifyLabels

Modifica o conjunto de marcadores aplicado a 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 marcadores 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. Ele contém apenas os rótulos que foram 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

Este é sempre drive#modifyLabelsResponse

Escopos de autorização

Requer um dos seguintes escopos de 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 sejam usados pelo app. 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 todas 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

É sempre drive#modifyLabelsRequest.

LabelModification

Uma modificação em um rótulo em um arquivo. Uma LabelModificação pode ser usada para aplicar um marcador a um arquivo, atualizar um marcador existente ou remover um marcador de um arquivo.

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

string

O ID do rótulo a ser modificado.

fieldModifications[]

object (FieldModification)

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

removeLabel

boolean

Se for verdadeiro, o rótulo será removido do arquivo.

kind

string

Esse é sempre drive#labelModificação.

FieldModification

Uma modificação no campo de um rótulo.

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

string

O ID do campo a ser modificado.

kind

string

Esse valor é sempre drive#labelFieldModify.

setDateValues[]

string

Substitui o valor de um campo date por esses 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 esses novos valores.

setIntegerValues[]

string (int64 format)

Substitui o valor de um campo integer por esses novos valores.

setUserValues[]

string

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

unsetValues

boolean

Cancela a definição dos valores para este campo.