Установка поля метки в файле

На этой странице описано, как задать Field метку для отдельного файла Google Диска.

Для добавления метаданных к файлу путем установки метки файла используйте метод files.modifyLabels . Тело запроса содержит экземпляр ModifyLabelsRequest для изменения набора меток файла. Запрос может содержать несколько изменений, которые применяются атомарно. То есть, если какие-либо изменения недействительны, то все обновление будет неудачным, и ни одно из (потенциально зависимых) изменений не будет применено.

Объект ModifyLabelsRequest содержит экземпляр LabelModification , представляющий собой изменение метки в файле. Он также может содержать экземпляр FieldModification , представляющий собой изменение поля метки.

В случае успеха тело ответа содержит метки, добавленные или обновленные в результате запроса. Они находятся в объекте modifiedLabels типа Label .

Пример

В приведенном ниже примере кода показано, как использовать fieldId текстового поля для установки значения этого Field в файле. Когда метка Field устанавливается для файла, она применяется к файлу. Затем вы можете отменить установку отдельного поля или удалить все поля, связанные с меткой. Для получения дополнительной информации см. разделы «Отмена установки метки поля в файле» и «Удаление метки из файла» .

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',
      requestBody: labelModificationRequest,
    });
    return updateResponse;
  } catch (err) {
    // TODO (developer) - Handle error
    throw err;
  }
}

Замените следующее:

  • FIELD_ID : fieldId поля, которое нужно изменить. Чтобы найти fieldId , получите метку с помощью API меток Google Drive .
  • VALUE : Новое value для этого поля.
  • LABEL_ID : labelId метки, которую необходимо изменить.
  • FILE_ID : fileId файла, для которого изменяются метки.

Примечания

  • Чтобы задать метку без полей, примените labelModifications , если fieldModifications отсутствуют.
  • Чтобы задать значения для параметров поля выбора, используйте идентификатор Choice id), который можно получить, запросив схему меток в API меток дисков .
  • Только Field , поддерживающее списки значений, может иметь несколько заданных значений, в противном случае вы получите ошибку 400: Bad Request .
  • Укажите правильный тип значения для выбранного Field (например, целое число, текст, пользователь и т. д.), иначе вы получите ошибку 400: Bad Request . Тип данных поля можно получить с помощью API меток дисков .