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

Это всегда диск#modifyLabelsResponse

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

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

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

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

Запрос Модифиелейблсреквест

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

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

object ( LabelModification )

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

kind

string

Это всегда диск#modifyLabelsRequest.

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

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

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

string

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

fieldModifications[]

object ( FieldModification )

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

removeLabel

boolean

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

kind

string

Это всегда диск#labelModification.

ПолеМодификация

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

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

string

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

kind

string

Это всегда диск#labelFieldModification.

setDateValues[]

string

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

setTextValues[]

string

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

setSelectionValues[]

string

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

setIntegerValues[]

string ( int64 format)

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

setUserValues[]

string

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

unsetValues

boolean

Сбрасывает значения для этого поля.