Definir um campo de marcador em um arquivo

Nesta página, descrevemos como definir um marcador Field em um único arquivo do Google Drive.

Para adicionar metadados a um arquivo definindo um rótulo de arquivo, use o método files.modifyLabels. O corpo da solicitação contém uma instância de ModifyLabelsRequest para modificar o conjunto de rótulos em um arquivo. A solicitação pode conter várias modificações que são aplicadas atomicamente. Ou seja, se alguma modificação não for válida, toda a atualização falhará e nenhuma das alterações (possivelmente dependentes) será aplicada.

O ModifyLabelsRequest contém uma instância de LabelModification, que é uma modificação de um rótulo em um arquivo. Ele também pode conter uma instância de FieldModification, que é uma modificação no campo de um rótulo.

Se bem-sucedido, o corpo da resposta conterá os rótulos adicionados ou atualizados pela solicitação. Eles existem em um objeto modifiedLabels do tipo Label.

Exemplo

O exemplo de código a seguir mostra como usar o fieldId de um campo de texto para definir um valor para essa Field em um arquivo. Quando um rótulo Field é definido inicialmente em um arquivo, ele o aplica a ele. Depois, é possível cancelar a configuração de um único campo ou remover todos os campos associados ao rótulo. Para saber mais, consulte Cancelar a definição de um campo de rótulo em um arquivo e Remover um rótulo de um arquivo.

Java

LabelFieldModification fieldModification =
new LabelFieldModification().setFieldId("FIELD_ID").setSetTextValues(ImmutableList.of("VALUE"));

ModifyLabelsRequest modifyLabelsRequest =
  new ModifyLabelsRequest()
      .setLabelModifications(
          ImmutableList.of(
              new LabelModification()
                .setLabelId("LABEL_ID")
                .setFieldModifications(ImmutableList.of(fieldModification))));

ModifyLabelsResponse modifyLabelsResponse = driveService.files().modifyLabels("FILE_ID", modifyLabelsRequest).execute();

Python

field_modification = {'fieldId':'FIELD_ID','setTextValues':['VALUE']}
label_modification = {'labelId':'LABEL_ID', 'fieldModifications':[field_modification]}

modified_labels = drive_service.files().modifyLabels(fileId="FILE_ID", body = {'labelModifications' : [label_modification]}).execute();

Node.js

/**
* Set a label with a text field on a Drive file
* @return{obj} updated label data
**/
async function setLabelTextField() {
  // Get credentials and build service
  // TODO (developer) - Use appropriate auth mechanism for your app

  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  const auth = new GoogleAuth({scopes: 'https://www.googleapis.com/auth/drive'});
  const service = google.drive({version: 'v3', auth});
  const fieldModification = {
    'fieldId': 'FIELD_ID',
    'setTextValues': ['VALUE'],
  };
  const labelModification = {
    'labelId': 'LABEL_ID',
    'fieldModifications': [fieldModification],
  };
  const labelModificationRequest = {
    'labelModifications': [labelModification],
  };
  try {
    const updateResponse = await service.files.modifyLabels({
      fileId: 'FILE_ID',
      resource: labelModificationRequest,
    });
    return updateResponse;
  } catch (err) {
    // TODO (developer) - Handle error
    throw err;
  }
}

Substitua:

  • FIELD_ID: o fieldId do campo a ser modificado. Para localizar o fieldId, recupere o rótulo usando a API Google Drive Labels.
  • VALUE: o novo value para este campo.
  • LABEL_ID: o labelId do rótulo a ser modificado.
  • FILE_ID: o fileId do arquivo em que os rótulos são modificados.

Observações

  • Para definir um rótulo sem campos, aplique labelModifications sem fieldModifications presente.
  • Para definir valores para as opções de campo de seleção, use o ID Choice do valor que você pode receber buscando o esquema do marcador na API Drive Labels.
  • Somente um Field compatível com listas de valores pode ter vários valores definidos. Caso contrário, você receberá uma resposta de erro 400: Bad Request.
  • Defina o tipo de valor adequado para o Field selecionado (como número inteiro, texto, usuário etc.). Caso contrário, você vai receber uma resposta de erro 400: Bad Request. É possível recuperar o tipo de dados do campo usando a API Drive Labels.