Class Form

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Форма

Форма, содержащая общие свойства и элементы. Свойства включают заголовок, настройки и место, где хранятся ответы. Элементы включают элементы вопросов, такие как флажки или переключатели, а элементы макета относятся к таким вещам, как разрывы страниц. Доступ к формам или их создание можно получить из FormApp .

// Open a form by ID and create a new spreadsheet.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var ss = SpreadsheetApp.create('Spreadsheet Name');

// Update form properties via chaining.
form.setTitle('Form Name')
    .setDescription('Description of form')
    .setConfirmationMessage('Thanks for responding!')
    .setAllowResponseEdits(true)
    .setAcceptingResponses(false);

// Update the form's response destination.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

Методы

Метод Тип возврата Краткое описание
addCheckboxGridItem() CheckboxGridItem Добавляет новый элемент вопроса, представленный в виде сетки столбцов и строк, что позволяет респонденту выбрать несколько вариантов ответа в строке из последовательности флажков.
addCheckboxItem() CheckboxItem Добавляет новый элемент вопроса, который позволяет респонденту выбрать один или несколько флажков, а также необязательное поле «Другое».
addDateItem() DateItem Добавляет новый элемент вопроса, который позволяет респонденту указать дату.
addDateTimeItem() DateTimeItem Добавляет новый элемент вопроса, который позволяет респонденту указать дату и время.
addDurationItem() DurationItem Добавляет новый элемент вопроса, который позволяет респонденту указать период времени.
addEditor(emailAddress) Form Добавляет данного пользователя в список редакторов Form .
addEditor(user) Form Добавляет данного пользователя в список редакторов Form .
addEditors(emailAddresses) Form Добавляет указанный массив пользователей в список редакторов Form .
addGridItem() GridItem Добавляет новый элемент вопроса, представленный в виде сетки столбцов и строк, что позволяет респонденту выбрать один вариант ответа в строке из последовательности переключателей.
addImageItem() ImageItem Добавляет новый элемент макета, отображающий изображение.
addListItem() ListItem Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из раскрывающегося списка.
addMultipleChoiceItem() MultipleChoiceItem Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из списка переключателей или необязательного поля «другое».
addPageBreakItem() PageBreakItem Добавляет новый элемент макета, который отмечает начало страницы.
addParagraphTextItem() ParagraphTextItem Добавляет новый элемент вопроса, который позволяет респонденту ввести блок текста.
addScaleItem() ScaleItem Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из пронумерованной последовательности переключателей.
addSectionHeaderItem() SectionHeaderItem Добавляет новый элемент макета, который визуально указывает начало раздела.
addTextItem() TextItem Добавляет новый элемент вопроса, который позволяет респонденту ввести одну строку текста.
addTimeItem() TimeItem Добавляет новый элемент вопроса, который позволяет респонденту указать время суток.
addVideoItem() VideoItem Добавляет новый элемент макета, отображающий видео.
canEditResponse() Boolean Определяет, отображается ли в форме ссылка для редактирования ответа после его отправки.
collectsEmail() Boolean Определяет, собирает ли форма адреса электронной почты респондентов.
createResponse() FormResponse Создает новый ответ на форму.
deleteAllResponses() Form Удаляет все отправленные ответы из хранилища ответов формы.
deleteItem(index) void Удаляет элемент с заданным индексом среди всех элементов в форме.
deleteItem(item) void Удаляет указанный элемент.
deleteResponse(responseId) Form Удаляет один ответ из хранилища ответов формы.
getConfirmationMessage() String Получает сообщение подтверждения формы.
getCustomClosedFormMessage() String Получает настраиваемое сообщение, которое будет отображаться, если форма не принимает ответы, или пустую строку, если настраиваемое сообщение не задано.
getDescription() String Получает описание формы.
getDestinationId() String Получает идентификатор адресата ответа формы.
getDestinationType() DestinationType Получает тип адресата ответа формы.
getEditUrl() String Получает URL-адрес, который можно использовать для доступа к режиму редактирования формы.
getEditors() User[] Получает список редакторов для этой Form .
getId() String Получает идентификатор формы.
getItemById(id) Item Получает элемент с заданным идентификатором.
getItems() Item[] Получает массив всех элементов формы.
getItems(itemType) Item[] Получает массив всех элементов заданного типа.
getPublishedUrl() String Получает URL-адрес, который можно использовать для ответа на форму.
getResponse(responseId) FormResponse Получает один ответ формы на основе его идентификатора ответа.
getResponses() FormResponse[] Получает массив всех ответов формы.
getResponses(timestamp) FormResponse[] Получает массив всех ответов формы после заданной даты и времени.
getShuffleQuestions() Boolean Определяет, является ли порядок вопросов на каждой странице формы случайным.
getSummaryUrl() String Получает URL-адрес, который можно использовать для просмотра сводки ответов формы.
getTitle() String Получает заголовок формы.
hasLimitOneResponsePerUser() Boolean Определяет, допускает ли форма только один ответ на одного респондента.
hasProgressBar() Boolean Определяет, отображает ли форма индикатор выполнения.
hasRespondAgainLink() Boolean Определяет, отображается ли в форме ссылка для отправки другого ответа после того, как респондент заполнит форму.
isAcceptingResponses() Boolean Определяет, принимает ли форма в настоящее время ответы.
isPublishingSummary() Boolean Определяет, отображается ли в форме ссылка для просмотра сводки ответов после того, как респондент заполнит форму.
isQuiz() Boolean Определяет, является ли форма викториной.
moveItem(from, to) Item Перемещает элемент с заданным индексом среди всех элементов в форме на другой заданный индекс.
moveItem(item, toIndex) Item Перемещает заданный элемент в указанный индекс среди всех элементов в форме.
removeDestination() Form Разъединяет форму с текущим адресатом ответа.
removeEditor(emailAddress) Form Удаляет данного пользователя из списка редакторов Form .
removeEditor(user) Form Удаляет данного пользователя из списка редакторов Form .
requiresLogin() Boolean Определяет, требует ли форма от респондентов входа в учетную запись в том же домене или поддомене перед ответом.
setAcceptingResponses(enabled) Form Устанавливает, принимает ли форма в настоящее время ответы.
setAllowResponseEdits(enabled) Form Определяет, будет ли форма отображать ссылку для редактирования ответа после его отправки.
setCollectEmail(collect) Form Определяет, будет ли форма собирать адреса электронной почты респондентов.
setConfirmationMessage(message) Form Устанавливает сообщение подтверждения формы.
setCustomClosedFormMessage(message) Form Устанавливает сообщение для отображения, если форма не принимает ответы.
setDescription(description) Form Устанавливает описание формы.
setDestination(type, id) Form Задает место назначения, в котором сохраняются ответы формы.
setIsQuiz(enabled) Form Устанавливает, является ли форма викториной.
setLimitOneResponsePerUser(enabled) Form Устанавливает, разрешает ли форма только один ответ на одного респондента.
setProgressBar(enabled) Form Устанавливает, имеет ли форма индикатор выполнения.
setPublishingSummary(enabled) Form Определяет, будет ли форма отображать ссылку для просмотра сводки ответов после того, как респондент отправит форму.
setRequireLogin(requireLogin) Form Устанавливает, требует ли форма, чтобы респонденты входили в учетную запись в том же домене или поддомене перед ответом.
setShowLinkToRespondAgain(enabled) Form Определяет, будет ли форма отображать ссылку для отправки другого ответа после того, как респондент заполнит форму.
setShuffleQuestions(shuffle) Form Устанавливает, является ли порядок вопросов на каждой странице формы случайным.
setTitle(title) Form Устанавливает заголовок формы.
shortenFormUrl(url) String Преобразует длинный URL-адрес формы в короткий URL-адрес.
submitGrades(responses) Form Отправляет оценки для заданных ответов FormResponse.

Подробная документация

addCheckboxGridItem()

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

Возвращаться

CheckboxGridItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addCheckboxItem()

Добавляет новый элемент вопроса, который позволяет респонденту выбрать один или несколько флажков, а также необязательное поле «Другое».

Возвращаться

CheckboxItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addDateItem()

Добавляет новый элемент вопроса, который позволяет респонденту указать дату.

Возвращаться

DateItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addDateTimeItem()

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

Возвращаться

DateTimeItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addDurationItem()

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

Возвращаться

DurationItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addEditor(emailAddress)

Добавляет данного пользователя в список редакторов Form . Если пользователь уже был в списке зрителей, этот метод продвигает пользователя из списка зрителей.

Параметры

Имя Тип Описание
emailAddress String Адрес электронной почты добавляемого пользователя.

Возвращаться

Form — эта Form для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addEditor(user)

Добавляет данного пользователя в список редакторов Form . Если пользователь уже был в списке зрителей, этот метод продвигает пользователя из списка зрителей.

Параметры

Имя Тип Описание
user User Представление пользователя для добавления.

Возвращаться

Form — эта Form для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addEditors(emailAddresses)

Добавляет указанный массив пользователей в список редакторов Form . Если кто-то из пользователей уже был в списке зрителей, этот метод продвигает их из списка зрителей.

Параметры

Имя Тип Описание
emailAddresses String[] Массив адресов электронной почты пользователей для добавления.

Возвращаться

Form — эта Form для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addGridItem()

Добавляет новый элемент вопроса, представленный в виде сетки столбцов и строк, что позволяет респонденту выбрать один вариант ответа в строке из последовательности переключателей.

Возвращаться

GridItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addImageItem()

Добавляет новый элемент макета, отображающий изображение.

Возвращаться

ImageItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addListItem()

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

Возвращаться

ListItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addMultipleChoiceItem()

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

Возвращаться

MultipleChoiceItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addPageBreakItem()

Добавляет новый элемент макета, который отмечает начало страницы.

Возвращаться

PageBreakItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addParagraphTextItem()

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

Возвращаться

ParagraphTextItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addScaleItem()

Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из пронумерованной последовательности переключателей.

Возвращаться

ScaleItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addSectionHeaderItem()

Добавляет новый элемент макета, который визуально указывает начало раздела.

Возвращаться

SectionHeaderItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addTextItem()

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

Возвращаться

TextItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addTimeItem()

Добавляет новый элемент вопроса, который позволяет респонденту указать время суток.

Возвращаться

TimeItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

addVideoItem()

Добавляет новый элемент макета, отображающий видео.

Возвращаться

VideoItem — вновь созданный элемент

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

canEditResponse()

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

Независимо от этого параметра метод FormResponse.getEditResponseUrl() позволяет автору скрипта, имеющему доступ к редактированию формы, создать URL-адрес, который можно использовать для редактирования ответа.

Возвращаться

Booleantrue , если в форме отображается ссылка «Редактировать ответ»; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

collectsEmail()

Определяет, собирает ли форма адреса электронной почты респондентов.

Возвращаться

Booleantrue , если форма собирает адреса электронной почты; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

createResponse()

Создает новый ответ на форму. Чтобы ответить на элемент вопроса, создайте ItemResponse из элемента, а затем прикрепите его к этому ответу формы, вызвав FormResponse.withItemResponse(response) . Чтобы сохранить собранный ответ, вызовите FormResponse.submit() .

Возвращаться

FormResponse — только что созданный ответ формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

deleteAllResponses()

Удаляет все отправленные ответы из хранилища ответов формы. Этот метод не удаляет копии ответов, хранящиеся во внешнем месте назначения ответов (например, в электронной таблице), но очищает представление сводки формы.

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

deleteItem(index)

Удаляет элемент с заданным индексом среди всех элементов в форме. Выдает исключение сценария, если по данному индексу не существует элемента.

Параметры

Имя Тип Описание
index Integer индекс элемента среди всех элементов в форме

Броски

Error — если по данному индексу не существует элемента

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

deleteItem(item)

Удаляет указанный элемент. Выдает исключение сценария, если элемент уже удален.

Параметры

Имя Тип Описание
item Item элемент, который нужно удалить

Броски

Error — если элемент не существует в форме

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

deleteResponse(responseId)

Удаляет один ответ из хранилища ответов формы. Этот метод не удаляет копии ответов, хранящиеся во внешнем месте назначения ответов (например, в электронной таблице), но удаляет ответ из сводного представления формы. Идентификатор ответа можно получить с помощью FormResponse.getId() .

Параметры

Имя Тип Описание
responseId String ID ответа формы на удаление

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getConfirmationMessage()

Получает сообщение подтверждения формы.

Возвращаться

String — сообщение подтверждения формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getCustomClosedFormMessage()

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

Возвращаться

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

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getDescription()

Получает описание формы.

Возвращаться

String — описание формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getDestinationId()

Получает идентификатор адресата ответа формы.

Возвращаться

String — идентификатор адресата ответа формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getDestinationType()

Получает тип адресата ответа формы.

Возвращаться

DestinationType — тип адресата ответа формы.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getEditUrl()

Получает URL-адрес, который можно использовать для доступа к режиму редактирования формы.

Возвращаться

String — URL для редактирования формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getEditors()

Получает список редакторов для этой Form .

Возвращаться

User[] — Массив пользователей с правами редактирования.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getId()

Получает идентификатор формы.

Возвращаться

String — идентификатор формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getItemById(id)

Получает элемент с заданным идентификатором. Возвращает null , если идентификатор не соответствует элементу в форме.

Параметры

Имя Тип Описание
id Integer идентификатор предмета

Возвращаться

Item — элемент с заданным идентификатором или null , если элемент не существует в форме.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getItems()

Получает массив всех элементов формы.

Возвращаться

Item[] — массив всех элементов формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getItems(itemType)

Получает массив всех элементов заданного типа.

Параметры

Имя Тип Описание
itemType ItemType тип элементов для извлечения

Возвращаться

Item[] — массив всех элементов этого типа

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getPublishedUrl()

Получает URL-адрес, который можно использовать для ответа на форму.

Возвращаться

String — URL для ответа на форму

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getResponse(responseId)

Получает один ответ формы на основе его идентификатора ответа. Идентификаторы ответов можно получить из FormResponse.getId() .

Параметры

Имя Тип Описание
responseId String идентификатор ответа формы

Возвращаться

FormResponse — ответ формы

Броски

Error — если ответ не существует

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getResponses()

Получает массив всех ответов формы.

Возвращаться

FormResponse[] — массив всех ответов формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getResponses(timestamp)

Получает массив всех ответов формы после заданной даты и времени.

Параметры

Имя Тип Описание
timestamp Date самая ранняя дата и время, для которых должны быть возвращены ответы формы

Возвращаться

FormResponse[] — список ответов формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getShuffleQuestions()

Определяет, является ли порядок вопросов на каждой странице формы случайным.

Возвращаться

Booleantrue , если порядок вопросов на каждой странице формы произвольный; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getSummaryUrl()

Получает URL-адрес, который можно использовать для просмотра сводки ответов формы. Если setPublishingSummary(enabled) не установлено значение true , только пользователи с разрешением на редактирование формы смогут получить доступ к URL-адресу.

Возвращаться

String — URL-адрес для просмотра сводки ответов.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

getTitle()

Получает заголовок формы.

Возвращаться

String — заголовок формы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

hasLimitOneResponsePerUser()

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

Возвращаться

Booleantrue , если форма допускает только один ответ на одного респондента; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

hasProgressBar()

Определяет, отображает ли форма индикатор выполнения.

Возвращаться

Booleantrue , если форма отображает индикатор выполнения; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

Определяет, отображается ли в форме ссылка для отправки другого ответа после того, как респондент заполнит форму.

Возвращаться

Booleantrue , если в форме отображается ссылка «Отправить другой ответ»; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

isAcceptingResponses()

Определяет, принимает ли форма в настоящее время ответы.

Возвращаться

Booleantrue , если форма принимает ответы; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

isPublishingSummary()

Определяет, отображается ли в форме ссылка для просмотра сводки ответов после того, как респондент заполнит форму.

Возвращаться

Booleantrue , если в форме отображается ссылка «Посмотреть предыдущие ответы»; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

isQuiz()

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

Возвращаться

Booleantrue , если форма принимает ответы; false , если нет

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

moveItem(from, to)

Перемещает элемент с заданным индексом среди всех элементов в форме на другой заданный индекс. Выдает исключение сценария, если индекс to выходит за пределы.

Параметры

Имя Тип Описание
from Integer текущий индекс элемента среди всех элементов в форме
to Integer новый индекс для элемента среди всех элементов в форме

Возвращаться

Item — предмет, который был перемещен

Броски

Error — если какой-либо индекс выходит за пределы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

moveItem(item, toIndex)

Перемещает заданный элемент в указанный индекс среди всех элементов в форме. Выдает исключение сценария, если данный индекс выходит за пределы.

Параметры

Имя Тип Описание
item Item предмет для перемещения
toIndex Integer новый индекс для элемента среди всех элементов в форме

Возвращаться

Item — предмет, который был перемещен

Броски

Error — если индекс выходит за пределы

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

removeDestination()

Разъединяет форму с текущим адресатом ответа. Несвязанный прежний пункт назначения по-прежнему сохраняет копию всех предыдущих ответов. Все формы, в том числе те, для которых не указано явно назначение, сохраняют копию ответов в хранилище ответов формы . Если форма в настоящее время не имеет получателя ответа, этот метод не действует.

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

removeEditor(emailAddress)

Удаляет данного пользователя из списка редакторов Form . Этот метод не блокирует пользователям доступ к Form , если они принадлежат к классу пользователей с общим доступом, например, если Form используется для всего домена пользователя или если Form находится на общем диске, который пользователь может получить доступ.

Для файлов на Диске это также удаляет пользователя из списка просматривающих.

Параметры

Имя Тип Описание
emailAddress String Адрес электронной почты пользователя, которого необходимо удалить.

Возвращаться

Form — эта Form для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

removeEditor(user)

Удаляет данного пользователя из списка редакторов Form . Этот метод не блокирует пользователям доступ к Form , если они принадлежат к классу пользователей с общим доступом, например, если Form используется для всего домена пользователя или если Form находится на общем диске, который пользователь может получить доступ.

Для файлов на Диске это также удаляет пользователя из списка просматривающих.

Параметры

Имя Тип Описание
user User Представление пользователя, которого необходимо удалить.

Возвращаться

Form — эта Form для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

requiresLogin()

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

Возвращаться

Booleantrue , если форма требует авторизации пользователей; false , если нет


setAcceptingResponses(enabled)

Устанавливает, принимает ли форма в настоящее время ответы. Значение по умолчанию для новых форм — true .

Параметры

Имя Тип Описание
enabled Boolean true , если форма должна принимать ответы; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setAllowResponseEdits(enabled)

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

Независимо от этого параметра метод FormResponse.getEditResponseUrl() позволяет автору скрипта, имеющему разрешение на редактирование формы, создать URL-адрес, который можно использовать для редактирования ответа.

Параметры

Имя Тип Описание
enabled Boolean true , если форма должна отображать ссылку «Изменить ответ»; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setCollectEmail(collect)

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

Параметры

Имя Тип Описание
collect Boolean true , если форма должна собирать адреса электронной почты; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setConfirmationMessage(message)

Устанавливает сообщение подтверждения формы.

Параметры

Имя Тип Описание
message String новое сообщение подтверждения формы

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setCustomClosedFormMessage(message)

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

Параметры

Имя Тип Описание
message String сообщение для отображения, если форма не принимает ответы

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setDescription(description)

Устанавливает описание формы.

Параметры

Имя Тип Описание
description String новое описание формы

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setDestination(type, id)

Задает место назначения, в котором сохраняются ответы формы. Все формы, в том числе те, для которых не указано явно назначение, сохраняют копию ответов в хранилище ответов формы .

Параметры

Имя Тип Описание
type DestinationType тип адресата ответа формы
id String ID получателя ответа формы

Возвращаться

Form — это Form , для цепочки

Броски

Error — если указанный идентификатор пункта назначения недействителен

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setIsQuiz(enabled)

Устанавливает, является ли форма викториной. По умолчанию для новых форм установлено значение false .

Оцениваемые вопросы разрешены только в викторинах, поэтому если установить для этого параметра значение false, все параметры оценивания будут удалены из всех вопросов.

Настройки викторины доступны только в новом пользовательском интерфейсе Форм; при создании формы викторины форма будет использовать новый пользовательский интерфейс.

Параметры

Имя Тип Описание
enabled Boolean true , если для формы должны быть включены функции опроса; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setLimitOneResponsePerUser(enabled)

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

Параметры

Имя Тип Описание
enabled Boolean true , если форма должна разрешать только один ответ на одного респондента; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setProgressBar(enabled)

Устанавливает, имеет ли форма индикатор выполнения. По умолчанию для новых форм установлено значение false .

Параметры

Имя Тип Описание
enabled Boolean true , если форма должна отображать индикатор выполнения; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setPublishingSummary(enabled)

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

Параметры

Имя Тип Описание
enabled Boolean true , если форма должна отображать ссылку "Просмотреть предыдущие ответы"; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setRequireLogin(requireLogin)

Устанавливает, требует ли форма, чтобы респонденты входили в учетную запись в том же домене или поддомене перед ответом. По умолчанию для новых форм установлено значение false , если администратор домена не изменит значение по умолчанию.

Эта функция доступна только для форм, созданных пользователями Google Workspace. Пользователям других типов учетных записей Google вход в систему не требуется.

Параметры

Имя Тип Описание
requireLogin Boolean true , если форма требует, чтобы пользователи вошли в систему; false , если нет

Возвращаться

Form — текущая форма (для цепочки)

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setShowLinkToRespondAgain(enabled)

Определяет, будет ли форма отображать ссылку для отправки другого ответа после того, как респондент заполнит форму. Значение по умолчанию для новых форм — true .

Параметры

Имя Тип Описание
enabled Boolean true , если форма должна отображать ссылку «Отправить другой ответ»; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setShuffleQuestions(shuffle)

Устанавливает, является ли порядок вопросов на каждой странице формы случайным.

Параметры

Имя Тип Описание
shuffle Boolean true , если порядок вопросов на каждой странице формы должен быть случайным; false , если нет

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

setTitle(title)

Устанавливает заголовок формы.

Параметры

Имя Тип Описание
title String новое название формы

Возвращаться

Form — это Form , для цепочки

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

shortenFormUrl(url)

Преобразует длинный URL-адрес формы в короткий URL-адрес. Выдает исключение, если длинный URL-адрес не принадлежит Google Forms.

Параметры

Имя Тип Описание
url String

Возвращаться

String — URL в виде http://goo.gl/forms/1234 .

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

submitGrades(responses)

Отправляет оценки для заданных ответов FormResponse.

Если ваш код включает триггер onFormSubmit , вызов submitGrades() запускает условие onFormSubmit и вызывает бесконечный цикл. Чтобы предотвратить бесконечный цикл, добавьте код, который проверяет, существуют ли уже оценки перед вызовом submitGrades() .

Параметры

Имя Тип Описание
responses FormResponse[]

Возвращаться

Form — эта Form для цепочки.

Авторизация

Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms