- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- Запрос
- Запрос UpdateLabelPropertiesRequest
- CreateFieldRequest
- Запрос UpdateFieldPropertiesRequest
- UpdateFieldTypeRequest
- Параметры Лонгтекста
- EnableFieldRequest
- Деактивироватьфилдреквест
- Удалитьфилдрекуест
- Создать запрос выбора выбора
- ОбновлениеВыборВыборСвойстваЗапрос
- EnableSelectionChoiceRequest
- DisableSelectionChoiceRequest
- УдалитьВыборВыборЗапрос
- Ответ
- UpdateLabelPropertiesResponse
- CreateFieldResponse
- UpdateFieldPropertiesResponse
- UpdateFieldTypeResponse
- EnableFieldResponse
- DisableFieldResponse
- Удалитьфилдответ
- CreateSelectionChoiceResponse
- UpdateSelectionChoicePropertiesResponse
- EnableSelectionChoiceResponse
- DisableSelectionChoiceResponse
- Удалитьселектиончойцеответ
- Попробуй это!
Обновляет одну метку, применяя набор запросов на обновление, в результате чего создается новая черновая версия. Пакетное обновление осуществляется по принципу «все или ничего»: если какой-либо из запросов на обновление недействителен, никакие изменения не применяются. Полученный черновой вариант необходимо опубликовать, прежде чем изменения можно будет использовать с элементами Диска.
HTTP-запрос
POST https://drivelabels.googleapis.com/v2/{name=labels/*}:delta
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
name | Необходимый. Имя ресурса метки, которую необходимо обновить. |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "writeControl": { object ( |
Поля | |
---|---|
writeControl | Обеспечивает контроль над выполнением запросов на запись. |
requests[] | Список обновлений, которые можно применить к ярлыку. Запросы будут применяться в том порядке, в котором они указаны. |
useAdminAccess | Установите значение |
view | Если указано, будут возвращены только определенные поля, принадлежащие указанному представлению. |
languageCode | Код языка BCP-47, используемый для оценки локализованных меток полей, когда |
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
Ответ на обновление метки.
JSON-представление |
---|
{ "responses": [ { object ( |
Поля | |
---|---|
responses[] | Ответ обновлений. Это соответствует 1:1 обновлениям, хотя ответы на некоторые запросы могут быть пустыми. |
updatedLabel | Ярлык после применения обновлений. Это значение устанавливается только в том случае, если [BatchUpdateLabelResponse2.include_label_in_response] имеет |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/drive.labels
-
https://www.googleapis.com/auth/drive.admin.labels
Дополнительную информацию см. в руководстве по авторизации .
Запрос
Единственный тип обновления, применяемый к метке.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
kind поля Союза. Тип обновления. Требуется ровно одно поле. kind может быть только одним из следующих: | |
updateLabel | Обновляет свойства метки. |
createField | Создает новое поле. |
updateField | Обновляет основные свойства поля. |
updateFieldType | Обновите тип поля и/или параметры типа. |
enableField | Включает поле. |
disableField | Отключает поле. |
deleteField | Удаляет поле из метки. |
createSelectionChoice | Создает выбор в поле выбора. |
updateSelectionChoiceProperties | Обновите свойства выбора в поле выбора. |
enableSelectionChoice | Включите выбор в поле выбора. |
disableSelectionChoice | Отключить выбор в поле выбора. |
deleteSelectionChoice | Удаление выбора в поле выбора. |
Запрос UpdateLabelPropertiesRequest
Обновляет основные свойства метки.
JSON-представление |
---|
{
"updateMask": string,
"properties": {
object ( |
Поля | |
---|---|
updateMask | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой элемент |
properties | Необходимый. Свойства метки для обновления. |
CreateFieldRequest
Запрос на создание поля внутри метки.
JSON-представление |
---|
{
"field": {
object ( |
Поля | |
---|---|
field | Необходимый. Поле для создания. |
Запрос UpdateFieldPropertiesRequest
Запрос на обновление свойств поля.
JSON-представление |
---|
{
"updateMask": string,
"id": string,
"properties": {
object ( |
Поля | |
---|---|
updateMask | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневые |
id | Необходимый. Поле для обновления. |
properties | Необходимый. Основные свойства поля. |
UpdateFieldTypeRequest
Запрос на изменение типа поля.
JSON-представление |
---|
{ "updateMask": string, "id": string, // Union field |
Поля | |
---|---|
updateMask | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корень |
id | Необходимый. Поле для обновления. |
Поле объединения | |
textOptions | Обновите поле до «Текст». |
longTextOptions | Обновите поле до длинного текста. |
integerOptions | Обновите поле до целого числа. |
dateOptions | Обновите поле до даты. |
selectionOptions | Обновите поле до «Выбор». |
userOptions | Обновите поле до «Пользователь». |
Параметры Лонгтекста
Опции типа поля «Длинный текст».
JSON-представление |
---|
{ "minLength": integer, "maxLength": integer } |
Поля | |
---|---|
minLength | Только вывод. Минимальная допустимая длина значений для текстового поля. |
maxLength | Только вывод. Максимальная допустимая длина значений для текстового поля. |
EnableFieldRequest
Запрос на включение поля.
JSON-представление |
---|
{ "id": string } |
Поля | |
---|---|
id | Необходимый. Идентификатор поля, которое нужно включить. |
Деактивироватьфилдреквест
Запрос на отключение поля.
JSON-представление |
---|
{
"updateMask": string,
"id": string,
"disabledPolicy": {
object ( |
Поля | |
---|---|
updateMask | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой |
id | Необходимый. Ключ поля для отключения. |
disabledPolicy | Необходимый. Политика отключения поля. |
Удалитьфилдрекуест
Запрос на удаление поля.
JSON-представление |
---|
{ "id": string } |
Поля | |
---|---|
id | Необходимый. Идентификатор поля, которое необходимо удалить. |
Создать запрос выбора выбора
Запрос на создание выбора выбора.
JSON-представление |
---|
{
"fieldId": string,
"choice": {
object ( |
Поля | |
---|---|
fieldId | Необходимый. Поле выбора, в котором будет создан вариант выбора. |
choice | Необходимый. Выбор творить. |
ОбновлениеВыборВыборСвойстваЗапрос
Запрос на обновление свойств выбора.
JSON-представление |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"properties": {
object ( |
Поля | |
---|---|
updateMask | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневые |
fieldId | Необходимый. Поле выбора для обновления. |
id | Необходимый. Выбор обновления. |
properties | Необходимый. Свойства выбора для обновления. |
EnableSelectionChoiceRequest
Запрос на включение выбора.
JSON-представление |
---|
{ "fieldId": string, "id": string } |
Поля | |
---|---|
fieldId | Необходимый. Поле выбора, в котором будет доступен выбор. |
id | Необходимый. Выбор включения. |
DisableSelectionChoiceRequest
Запрос на отключение выбора.
JSON-представление |
---|
{
"updateMask": string,
"fieldId": string,
"id": string,
"disabledPolicy": {
object ( |
Поля | |
---|---|
updateMask | Поля, которые следует обновить. Должно быть указано хотя бы одно поле. Корневой |
fieldId | Необходимый. Поле выбора, в котором выбор будет отключен. |
id | Необходимый. Выбор отключить. |
disabledPolicy | Необходимый. Отключенная политика для обновления. |
УдалитьВыборВыборЗапрос
Запрос на удаление выбора.
JSON-представление |
---|
{ "fieldId": string, "id": string } |
Поля | |
---|---|
fieldId | Необходимый. Поле выбора, из которого будет удален вариант выбора. |
id | Необходимый. Выбор удаления. |
Ответ
Единственный ответ на обновление.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
response поля Союза. Ответ на соответствующий запрос. response может быть только одним из следующих: | |
updateLabel | Обновлены основные свойства Ярлыка. |
createField | Создает новое поле. |
updateField | Обновляет основные свойства поля. |
updateFieldType | Обновите тип поля и/или параметры типа. |
enableField | Включает поле. |
disableField | Отключает поле. |
deleteField | Удаляет поле из метки. |
createSelectionChoice | Создает новый параметр списка выбора для добавления в поле выбора. |
updateSelectionChoiceProperties | Обновляет выбор в поле выбора. |
enableSelectionChoice | Позволяет выбор в поле выбора. |
disableSelectionChoice | Отключает выбор в поле выбора. |
deleteSelectionChoice | Удаляет выбор из поля выбора. |
UpdateLabelPropertiesResponse
Ответ после обновления свойств метки.
CreateFieldResponse
Ответ после создания поля.
JSON-представление |
---|
{ "id": string, "priority": integer } |
Поля | |
---|---|
id | Поле созданного поля. Если в запросе на создание оставить поле пустым, ключ будет сгенерирован автоматически и его можно будет идентифицировать здесь. |
priority | Приоритет создаваемого поля. Приоритет может измениться по сравнению с указанным, чтобы обеспечить непрерывные приоритеты между полями (1-n). |
UpdateFieldPropertiesResponse
Ответ после обновления свойств поля.
JSON-представление |
---|
{ "priority": integer } |
Поля | |
---|---|
priority | Приоритет обновляемого поля. Приоритет может измениться по сравнению с указанным, чтобы обеспечить непрерывные приоритеты между полями (1-n). |
UpdateFieldTypeResponse
Ответ после обновления типа поля.
EnableFieldResponse
Ответ после включения поля.
DisableFieldResponse
Ответ после отключения поля.
Удалитьфилдответ
Ответ после удаления поля.
CreateSelectionChoiceResponse
Ответ после создания выбора выбора.
JSON-представление |
---|
{ "fieldId": string, "id": string } |
Поля | |
---|---|
fieldId | Идентификатор поля, сгенерированный сервером. |
id | Сгенерированный сервером идентификатор созданного выбора в поле. |
UpdateSelectionChoicePropertiesResponse
Ответ после обновления свойств выбора выбора.
JSON-представление |
---|
{ "priority": integer } |
Поля | |
---|---|
priority | Приоритет обновленного выбора. Приоритет может измениться по сравнению с указанным, чтобы обеспечить непрерывные приоритеты между вариантами (1-n). |
EnableSelectionChoiceResponse
Ответ после включения выбора.
DisableSelectionChoiceResponse
Ответ после выбора отключения.
Удалитьселектиончойцеответ
Ответ после удаления выбора.