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

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

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

The ModifyLabelsRequest contains an instance of LabelModification which is a modification to a label on a file. It might also contain an instance of FieldModification which is a modification to a label's field.

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

Пример

The following code sample shows how to use the fieldId of a text field to set a value for this Field on a file. When a label Field is initially set on a file, it applies the label to the file. You can then unset a single field or remove all fields associated with the label. For more information, see Unset a label field on a file and Remove a label from a file .

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 .
  • Set the proper value type for the selected Field (such as integer, text, user, etc.), otherwise you'll receive a 400: Bad Request error response. You can retrieve the field data type using the Drive Labels API .