Method: labels.delta

Обновляет одну метку, применяя набор запросов на обновление, в результате чего создается новая черновая версия. Пакетное обновление осуществляется по принципу «все или ничего»: если какой-либо из запросов на обновление недействителен, никакие изменения не применяются. Полученный черновой вариант необходимо опубликовать, прежде чем изменения можно будет использовать с элементами Диска.

HTTP-запрос

POST https://drivelabels.googleapis.com/v2beta/{name=labels/*}:delta

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

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

Параметры
name

string

Необходимый. Имя ресурса метки, которую необходимо обновить.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "writeControl": {
    object (WriteControl)
  },
  "requests": [
    {
      object (Request)
    }
  ],
  "useAdminAccess": boolean,
  "view": enum (LabelView),
  "languageCode": string
}
Поля
writeControl

object ( WriteControl )

Обеспечивает контроль над выполнением запросов на запись.

requests[]

object ( Request )

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

useAdminAccess

boolean

Установите значение true , чтобы использовать учетные данные администратора пользователя. Прежде чем разрешить доступ, сервер проверит, является ли пользователь администратором метки.

view

enum ( LabelView )

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

languageCode

string

Код языка BCP-47, используемый для оценки локализованных меток полей, когда include_label_in_response имеет true .

Тело ответа

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

Ответ на обновление метки.

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

object ( Response )

Ответ обновлений. Это соответствует 1:1 обновлениям, хотя ответы на некоторые запросы могут быть пустыми.

updatedLabel

object ( Label )

Ярлык после применения обновлений. Это значение устанавливается только в том случае, если [BatchUpdateLabelResponse2.include_label_in_response] имеет true и ошибок не было.

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

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

  • https://www.googleapis.com/auth/drive.labels
  • https://www.googleapis.com/auth/drive.admin.labels

Дополнительную информацию см. в руководстве по авторизации .

Запрос

Единственный тип обновления, применяемый к метке.

JSON-представление
{

  // Union field kind can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesRequest)
  },
  "createField": {
    object (CreateFieldRequest)
  },
  "updateField": {
    object (UpdateFieldPropertiesRequest)
  },
  "updateFieldType": {
    object (UpdateFieldTypeRequest)
  },
  "enableField": {
    object (EnableFieldRequest)
  },
  "disableField": {
    object (DisableFieldRequest)
  },
  "deleteField": {
    object (DeleteFieldRequest)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceRequest)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesRequest)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceRequest)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceRequest)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceRequest)
  }
  // End of list of possible types for union field kind.
}
Поля
kind поля Союза. Тип обновления. Требуется ровно одно поле. kind может быть только одним из следующих:
updateLabel

object ( UpdateLabelPropertiesRequest )

Обновляет свойства метки.

createField

object ( CreateFieldRequest )

Создает новое поле.

updateField

object ( UpdateFieldPropertiesRequest )

Обновляет основные свойства поля.

updateFieldType

object ( UpdateFieldTypeRequest )

Обновите тип поля и/или параметры типа.

enableField

object ( EnableFieldRequest )

Включает поле.

disableField

object ( DisableFieldRequest )

Отключает поле.

deleteField

object ( DeleteFieldRequest )

Удаляет поле из метки.

createSelectionChoice

object ( CreateSelectionChoiceRequest )

Создает выбор в поле выбора.

updateSelectionChoiceProperties

object ( UpdateSelectionChoicePropertiesRequest )

Обновите свойства выбора в поле выбора.

enableSelectionChoice

object ( EnableSelectionChoiceRequest )

Включите выбор в поле выбора.

disableSelectionChoice

object ( DisableSelectionChoiceRequest )

Отключить выбор в поле выбора.

deleteSelectionChoice

object ( DeleteSelectionChoiceRequest )

Удаление выбора в поле выбора.

Запрос UpdateLabelPropertiesRequest

Обновляет основные свойства метки.

JSON-представление
{
  "updateMask": string,
  "properties": {
    object (Properties)
  }
}
Поля
updateMask

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой элемент label_properties подразумевается и не должен указываться. Один * можно использовать как сокращение для обновления каждого поля.

properties

object ( Properties )

Необходимый. Свойства метки для обновления.

CreateFieldRequest

Запрос на создание поля внутри метки.

JSON-представление
{
  "field": {
    object (Field)
  }
}
Поля
field

object ( Field )

Необходимый. Поле для создания.

Запрос UpdateFieldPropertiesRequest

Запрос на обновление свойств поля.

JSON-представление
{
  "updateMask": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Поля
updateMask

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневые properties подразумеваются и не должны указываться. Один * можно использовать как сокращение для обновления каждого поля.

id

string

Необходимый. Поле для обновления.

properties

object ( Properties )

Необходимый. Основные свойства поля.

UpdateFieldTypeRequest

Запрос на изменение типа поля.

JSON-представление
{
  "updateMask": string,
  "id": string,

  // Union field type_options can be only one of the following:
  "textOptions": {
    object (TextOptions)
  },
  "longTextOptions": {
    object (LongTextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
  // End of list of possible types for union field type_options.
}
Поля
updateMask

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корень type_options подразумевается и не должен указываться. Один * можно использовать как сокращение для обновления каждого поля.

id

string

Необходимый. Поле для обновления.

Поле объединения type_options .

type_options может быть только одним из следующих:

textOptions

object ( TextOptions )

Обновите поле до «Текст».

longTextOptions

object ( LongTextOptions )

Обновите поле до длинного текста.

integerOptions

object ( IntegerOptions )

Обновите поле до целого числа.

dateOptions

object ( DateOptions )

Обновите поле до даты.

selectionOptions

object ( SelectionOptions )

Обновите поле до «Выбор».

userOptions

object ( UserOptions )

Обновите поле до «Пользователь».

Параметры Лонгтекста

Опции типа поля «Длинный текст».

JSON-представление
{
  "minLength": integer,
  "maxLength": integer
}
Поля
minLength

integer

Только вывод. Минимальная допустимая длина значений для текстового поля.

maxLength

integer

Только вывод. Максимальная допустимая длина значений для текстового поля.

EnableFieldRequest

Запрос на включение поля.

JSON-представление
{
  "id": string
}
Поля
id

string

Необходимый. Идентификатор поля, которое нужно включить.

Деактивироватьфилдреквест

Запрос на отключение поля.

JSON-представление
{
  "updateMask": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Поля
updateMask

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой disabledPolicy подразумевается и не должен указываться. Один * можно использовать как сокращение для обновления каждого поля.

id

string

Необходимый. Ключ поля для отключения.

disabledPolicy

object ( DisabledPolicy )

Необходимый. Политика отключения поля.

Удалитьфилдрекуест

Запрос на удаление поля.

JSON-представление
{
  "id": string
}
Поля
id

string

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

Создать запрос выбора выбора

Запрос на создание выбора выбора.

JSON-представление
{
  "fieldId": string,
  "choice": {
    object (Choice)
  }
}
Поля
fieldId

string

Необходимый. Поле выбора, в котором будет создан вариант выбора.

choice

object ( Choice )

Необходимый. Выбор творить.

ОбновлениеВыборВыборСвойстваЗапрос

Запрос на обновление свойств выбора.

JSON-представление
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "properties": {
    object (Properties)
  }
}
Поля
updateMask

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневые properties подразумеваются и не должны указываться. Один * можно использовать как сокращение для обновления каждого поля.

fieldId

string

Необходимый. Поле выбора для обновления.

id

string

Необходимый. Выбор обновления.

properties

object ( Properties )

Необходимый. Свойства выбора для обновления.

EnableSelectionChoiceRequest

Запрос на включение выбора.

JSON-представление
{
  "fieldId": string,
  "id": string
}
Поля
fieldId

string

Необходимый. Поле выбора, в котором будет доступен выбор.

id

string

Необходимый. Выбор включения.

DisableSelectionChoiceRequest

Запрос на отключение выбора.

JSON-представление
{
  "updateMask": string,
  "fieldId": string,
  "id": string,
  "disabledPolicy": {
    object (DisabledPolicy)
  }
}
Поля
updateMask

string ( FieldMask format)

Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой disabledPolicy подразумевается и не должен указываться. Один * можно использовать как сокращение для обновления каждого поля.

fieldId

string

Необходимый. Поле выбора, в котором выбор будет отключен.

id

string

Необходимый. Выбор отключить.

disabledPolicy

object ( DisabledPolicy )

Необходимый. Отключенная политика для обновления.

УдалитьВыборВыборЗапрос

Запрос на удаление выбора.

JSON-представление
{
  "fieldId": string,
  "id": string
}
Поля
fieldId

string

Необходимый. Поле выбора, из которого будет удален вариант выбора.

id

string

Необходимый. Выбор удаления.

Ответ

Единственный ответ на обновление.

JSON-представление
{

  // Union field response can be only one of the following:
  "updateLabel": {
    object (UpdateLabelPropertiesResponse)
  },
  "createField": {
    object (CreateFieldResponse)
  },
  "updateField": {
    object (UpdateFieldPropertiesResponse)
  },
  "updateFieldType": {
    object (UpdateFieldTypeResponse)
  },
  "enableField": {
    object (EnableFieldResponse)
  },
  "disableField": {
    object (DisableFieldResponse)
  },
  "deleteField": {
    object (DeleteFieldResponse)
  },
  "createSelectionChoice": {
    object (CreateSelectionChoiceResponse)
  },
  "updateSelectionChoiceProperties": {
    object (UpdateSelectionChoicePropertiesResponse)
  },
  "enableSelectionChoice": {
    object (EnableSelectionChoiceResponse)
  },
  "disableSelectionChoice": {
    object (DisableSelectionChoiceResponse)
  },
  "deleteSelectionChoice": {
    object (DeleteSelectionChoiceResponse)
  }
  // End of list of possible types for union field response.
}
Поля
response поля Союза. Ответ на соответствующий запрос. response может быть только одним из следующих:
updateLabel

object ( UpdateLabelPropertiesResponse )

Обновлены основные свойства Ярлыка.

createField

object ( CreateFieldResponse )

Создает новое поле.

updateField

object ( UpdateFieldPropertiesResponse )

Обновляет основные свойства поля.

updateFieldType

object ( UpdateFieldTypeResponse )

Обновите тип поля и/или параметры типа.

enableField

object ( EnableFieldResponse )

Включает поле.

disableField

object ( DisableFieldResponse )

Отключает поле.

deleteField

object ( DeleteFieldResponse )

Удаляет поле из метки.

createSelectionChoice

object ( CreateSelectionChoiceResponse )

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

updateSelectionChoiceProperties

object ( UpdateSelectionChoicePropertiesResponse )

Обновляет выбор в поле выбора.

enableSelectionChoice

object ( EnableSelectionChoiceResponse )

Позволяет выбор в поле выбора.

disableSelectionChoice

object ( DisableSelectionChoiceResponse )

Отключает выбор в поле выбора.

deleteSelectionChoice

object ( DeleteSelectionChoiceResponse )

Удаляет выбор из поля выбора.

UpdateLabelPropertiesResponse

Ответ после обновления свойств метки.

CreateFieldResponse

Ответ после создания поля.

JSON-представление
{
  "id": string,
  "priority": integer
}
Поля
id

string

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

priority

integer

Приоритет создаваемого поля. Приоритет может измениться по сравнению с указанным, чтобы обеспечить непрерывные приоритеты между полями (1-n).

UpdateFieldPropertiesResponse

Ответ после обновления свойств поля.

JSON-представление
{
  "priority": integer
}
Поля
priority

integer

Приоритет обновляемого поля. Приоритет может измениться по сравнению с указанным, чтобы обеспечить непрерывные приоритеты между полями (1-n).

UpdateFieldTypeResponse

Ответ после обновления типа поля.

EnableFieldResponse

Ответ после включения поля.

DisableFieldResponse

Ответ после отключения поля.

Удалитьфилдответ

Ответ после удаления поля.

CreateSelectionChoiceResponse

Ответ после создания выбора выбора.

JSON-представление
{
  "fieldId": string,
  "id": string
}
Поля
fieldId

string

Идентификатор поля, сгенерированный сервером.

id

string

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

UpdateSelectionChoicePropertiesResponse

Ответ после обновления свойств выбора выбора.

JSON-представление
{
  "priority": integer
}
Поля
priority

integer

Приоритет обновленного выбора. Приоритет может измениться по сравнению с указанным, чтобы обеспечить непрерывные приоритеты между вариантами (1-n).

EnableSelectionChoiceResponse

Ответ после включения выбора.

DisableSelectionChoiceResponse

Ответ после выбора отключения.

Удалитьселектиончойцеответ

Ответ после удаления выбора.