Method: files.modifyLabels

Изменяет набор меток, применённых к файлу. Подробнее см. в разделе Установка поля метки для файла .

Возвращает список меток, которые были добавлены или изменены.

HTTP-запрос

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

URL использует синтаксис перекодировки gRPC .

Параметры пути

Параметры
fileId

string

Идентификатор файла, к которому принадлежат метки.

Текст запроса

Тело запроса содержит экземпляр ModifyLabelsRequest .

Тело ответа

Ответ на запрос files.modifyLabels . Содержит только те метки, которые были добавлены или обновлены в результате запроса.

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "modifiedLabels": [
    {
      object (Label)
    }
  ],
  "kind": string
}
Поля
modifiedLabels[]

object ( Label )

Список меток, которые были добавлены или обновлены по запросу.

kind

string

Это всегда "drive#modifyLabelsResponse" .

Области авторизации

Требуется одна из следующих областей OAuth:

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

Некоторые области действия ограничены, и для их использования вашему приложению требуется оценка безопасности. Подробнее см. в руководстве по авторизации .

ModifyLabelsRequest

Запрос на изменение набора меток файла. Этот запрос может содержать множество изменений, которые либо все будут выполнены успешно, либо все атомарно завершатся неудачей.

JSON-представление 
{
  "labelModifications": [
    {
      object (LabelModification)
    }
  ],
  "kind": string
}
Поля
labelModifications[]

object ( LabelModification )

Список изменений, которые следует внести в метки файла.

kind

string

Это всегда "drive#modifyLabelsRequest" .

МеткаМодификация

Изменение метки файла. LabelModification можно использовать для добавления метки к файлу, обновления существующей метки файла или удаления метки с файла.

JSON-представление 
{
  "fieldModifications": [
    {
      object (FieldModification)
    }
  ],
  "labelId": string,
  "removeLabel": boolean,
  "kind": string
}
Поля
fieldModifications[]

object ( FieldModification )

Список изменений полей этой метки.

labelId

string

Идентификатор метки, которую необходимо изменить.

removeLabel

boolean

Если true, метка будет удалена из файла.

kind

string

Это всегда "drive#labelModification" .

FieldModification

Изменение поля метки.

JSON-представление 
{
  "setDateValues": [
    string
  ],
  "setTextValues": [
    string
  ],
  "setSelectionValues": [
    string
  ],
  "setIntegerValues": [
    string
  ],
  "setUserValues": [
    string
  ],
  "fieldId": string,
  "kind": string,
  "unsetValues": boolean
}
Поля
setDateValues[]

string

Заменяет значение поля date этими новыми значениями. Строка должна быть в полном формате даты RFC 3339: ГГГГ-ММ-ДД.

setTextValues[]

string

Устанавливает значение text поля.

setSelectionValues[]

string

Заменяет поле selection этими новыми значениями.

setIntegerValues[]

string ( int64 format)

Заменяет значение integer поля этими новыми значениями.

setUserValues[]

string

Заменяет поле user этими новыми значениями. Значения должны быть действительными адресами электронной почты.

fieldId

string

Идентификатор поля, которое необходимо изменить.

kind

string

Это всегда "drive#labelFieldModification" .

unsetValues

boolean

Отменяет значения для этого поля.