- HTTP-запрос
- Параметры пути
- Тело запроса
- Тело ответа
- Области авторизации
- Запрос
- Обновлениеформинфореквест
- Запрос на обновление настроек
- CreateItemRequest
- Расположение
- MoveItemRequest
- Удалитьемрекуест
- Запрос обновления элемента
- WriteControl
- Ответ
- CreateItemResponse
- Попробуйте!
Измените форму с помощью пакета обновлений.
HTTP-запрос
POST https://forms.googleapis.com/v1/forms/{formId}:batchUpdate
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
formId | Необходимый. Идентификатор формы. |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "includeFormInResponse": boolean, "requests": [ { object ( |
Поля | |
---|---|
includeFormInResponse | Возвращать ли в ответ обновленную версию модели. |
requests[] | Необходимый. Запросы на обновление этого пакета. |
writeControl | Обеспечивает контроль над выполнением запросов на запись. |
Тело ответа
Ответ на запрос BatchUpdateFormRequest.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{ "form": { object ( |
Поля | |
---|---|
form | В зависимости от поля запроса bool |
replies[] | Ответ обновлений. Это соответствует 1:1 запросам на обновление, хотя ответы на некоторые запросы могут быть пустыми. |
writeControl | Обновлено управление записью после применения запроса. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/drive
-
https://www.googleapis.com/auth/drive.file
-
https://www.googleapis.com/auth/forms.body
Дополнительную информацию см. в руководстве по авторизации .
Запрос
Виды запросов на обновление, которые можно сделать.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
kind поля Союза. Тип запроса. kind может быть только одним из следующих: | |
updateFormInfo | Обновить информацию формы. |
updateSettings | Обновляет настройки формы. |
createItem | Создайте новый элемент. |
moveItem | Переместить элемент в указанное место. |
deleteItem | Удалить элемент. |
updateItem | Обновите элемент. |
Обновлениеформинфореквест
Обновить информацию формы.
JSON-представление |
---|
{
"info": {
object ( |
Поля | |
---|---|
info | Информация для обновления. |
updateMask | Необходимый. Изменяются только значения, указанные в этой маске. Должно быть указано хотя бы одно поле. Это разделенный запятыми список полных имен полей. Пример: |
Запрос на обновление настроек
Обновите FormSettings
формы.
JSON-представление |
---|
{
"settings": {
object ( |
Поля | |
---|---|
settings | Необходимый. Настройки для обновления. |
updateMask | Необходимый. Изменяются только значения, указанные в этой маске. Должно быть указано хотя бы одно поле. Корневые Это разделенный запятыми список полных имен полей. Пример: |
CreateItemRequest
Создайте элемент в форме.
JSON-представление |
---|
{ "item": { object ( |
Поля | |
---|---|
item | Необходимый. Элемент, который нужно создать. |
location | Необходимый. Где разместить новый предмет. |
Расположение
Определенное местоположение в форме.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения where . Необходимый. Укажите местоположение в форме. where может быть только одно из следующих: | |
index | Индекс элемента в форме. Это должно быть в диапазоне , где N — количество элементов в форме. |
MoveItemRequest
Переместить элемент в форме.
JSON-представление |
---|
{ "originalLocation": { object ( |
Поля | |
---|---|
originalLocation | Необходимый. Местоположение предмета, который нужно переместить. |
newLocation | Необходимый. Новое местоположение элемента. |
Удалитьемрекуест
Удаление элемента в форме.
JSON-представление |
---|
{
"location": {
object ( |
Поля | |
---|---|
location | Необходимый. Местоположение элемента, который нужно удалить. |
Запрос обновления элемента
Обновите элемент в форме.
JSON-представление |
---|
{ "item": { object ( |
Поля | |
---|---|
item | Необходимый. Новые значения для элемента. Обратите внимание, что идентификаторы элементов и вопросов используются, если они указаны (и находятся в маске поля). Если идентификатор пуст (и в маске поля), генерируется новый идентификатор. Это означает, что вы можете изменить элемент, получив форму через |
location | Необходимый. Местоположение, идентифицирующее элемент для обновления. |
updateMask | Необходимый. Изменяются только значения, указанные в этой маске. Это разделенный запятыми список полных имен полей. Пример: |
WriteControl
Обеспечивает контроль над выполнением запросов на запись.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Полевой control Союза. Определяет версию формы, из которой должны быть применены изменения, и то, как должен вести себя запрос, если эта версия не является текущей версией формы. control может быть только одним из следующих: | |
requiredRevisionId | Идентификатор редакции формы, к которой применяется запрос на запись. Если это не последняя версия формы, запрос не обрабатывается и возвращает ошибку 400 bad request. |
targetRevisionId | Идентификатор целевой версии формы, к которой применяется запрос на запись. Если изменения произошли после этой версии, изменения в этом запросе на обновление преобразуются в соответствии с этими изменениями. В результате создается новая версия формы, включающая как изменения в запросе, так и промежуточные изменения, при этом сервер разрешает конфликтующие изменения. Идентификатор целевой версии можно использовать только для записи в последние версии формы. Если целевая версия слишком сильно отстает от последней, запрос не обрабатывается и возвращает 400 (ошибка неверного запроса). Запрос можно повторить после прочтения последней версии формы. В большинстве случаев целевой идентификатор редакции остается действительным в течение нескольких минут после его считывания, но для часто редактируемых форм это окно может быть короче. |
Ответ
Единственный ответ на обновление.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
kind поля Союза. Тип ответа. kind может быть только одним из следующих: | |
createItem | Результат создания предмета. |
CreateItemResponse
Результат создания предмета.
JSON-представление |
---|
{ "itemId": string, "questionId": [ string ] } |
Поля | |
---|---|
itemId | Идентификатор созданного элемента. |
questionId[] | Идентификатор вопроса, созданного как часть этого элемента. Для группы вопросов перечислены идентификаторы всех вопросов, созданных для этого элемента. |