Method: labels.delta

Обновляет одну метку, применяя набор запросов на обновление, что приводит к созданию новой версии черновика. Подробнее см. в разделе Обновление метки .

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

HTTP-запрос

POST https://drivelabels.googleapis.com/v2/{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 )

Метка после применения обновлений. Устанавливается только в том случае, если include_label_in_response имеет true и не было ошибок.

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

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

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

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

Запрос

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

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

  "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)
  }
}
Поля
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,

  "textOptions": {
    object (TextOptions)
  },
  "integerOptions": {
    object (IntegerOptions)
  },
  "dateOptions": {
    object (DateOptions)
  },
  "selectionOptions": {
    object (SelectionOptions)
  },
  "userOptions": {
    object (UserOptions)
  }
}
Поля
updateMask

string ( FieldMask format)

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

id

string

Обязательно. Поле для обновления.

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

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

textOptions

object ( TextOptions )

Обновить поле на Текст.

integerOptions

object ( IntegerOptions )

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

dateOptions

object ( DateOptions )

Обновить поле на Дата.

selectionOptions

object ( SelectionOptions )

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

userOptions

object ( UserOptions )

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

EnableFieldRequest

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

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

string

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

DisableFieldRequest

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

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

string ( FieldMask format)

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

id

string

Обязательно. Ключ поля, которое необходимо отключить.

disabledPolicy

object ( DisabledPolicy )

Обязательно. Поле отключено.

DeleteFieldRequest

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

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

string

Обязательно. Идентификатор поля для удаления.

CreateSelectionChoiceRequest

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

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

string

Обязательно. Поле выбора, в котором будет создан выбор.

choice

object ( Choice )

Обязательно. Возможность создать.

UpdateSelectionChoicePropertiesRequest

Запрос на обновление выбранного объекта недвижимости.

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 )

Обязательно. Отключенная политика для обновления.

DeleteSelectionChoiceRequest

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

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

string

Обязательно. Поле выбора, из которого будет удалён выбор.

id

string

Обязательно. Возможность удаления.

Ответ

Один ответ из обновления.

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

  "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)
  }
}
Поля
Поле объединения 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

Этот тип не имеет полей.

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

DeleteFieldResponse

Этот тип не имеет полей.

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

CreateSelectionChoiceResponse

Ответ после выбора создать.

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

string

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

id

string

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

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

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

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

integer

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

EnableSelectionChoiceResponse

Этот тип не имеет полей.

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

DisableSelectionChoiceResponse

Этот тип не имеет полей.

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

DeleteSelectionChoiceResponse

Этот тип не имеет полей.

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