Эта служба позволяет сценариям создавать, получать доступ и изменять формы Google.
// Create a new form, then add a checkbox question, a multiple choice question, // a page break, then a date question and a grid of questions. var form = FormApp.create('New Form'); var item = form.addCheckboxItem(); item.setTitle('What condiments would you like on your hot dog?'); item.setChoices([ item.createChoice('Ketchup'), item.createChoice('Mustard'), item.createChoice('Relish') ]); form.addMultipleChoiceItem() .setTitle('Do you prefer cats or dogs?') .setChoiceValues(['Cats','Dogs']) .showOtherOption(true); form.addPageBreakItem() .setTitle('Getting to know you'); form.addDateItem() .setTitle('When were you born?'); form.addGridItem() .setTitle('Rate your interests') .setRows(['Cars', 'Computers', 'Celebrities']) .setColumns(['Boring', 'So-so', 'Interesting']); Logger.log('Published URL: ' + form.getPublishedUrl()); Logger.log('Editor URL: ' + form.getEditUrl());
Классы
Имя | Краткое описание |
---|---|
Alignment | Перечисление, представляющее поддерживаемые типы выравнивания изображения. |
CheckboxGridItem | Элемент вопроса, представленный в виде сетки столбцов и строк, который позволяет респонденту выбрать несколько вариантов ответа в строке из последовательности флажков. |
CheckboxGridValidation | DataValidation для CheckboxGridItem . |
CheckboxGridValidationBuilder | DataValidationBuilder для CheckboxGridValidation . |
CheckboxItem | Элемент вопроса, который позволяет респонденту выбрать один или несколько флажков, а также необязательное поле «Другое». |
CheckboxValidation | DataValidation для CheckboxItem . |
CheckboxValidationBuilder | DataValidationBuilder для CheckboxValidation . |
Choice | Один выбор, связанный с типом Item , который поддерживает выбор, например CheckboxItem , ListItem или MultipleChoiceItem . |
DateItem | Элемент вопроса, который позволяет респонденту указать дату. |
DateTimeItem | Пункт вопроса, который позволяет респонденту указать дату и время. |
DestinationType | Перечисление, представляющее поддерживаемые типы адресатов формы-ответа. |
DurationItem | Пункт вопроса, который позволяет респонденту указать продолжительность времени. |
FeedbackType | Перечисление, представляющее поддерживаемые типы обратной связи. |
Form | Форма, содержащая общие свойства и элементы. |
FormApp | Позволяет скрипту открывать существующую Form или создавать новую. |
FormResponse | Ответ на форму в целом. |
GridItem | Элемент вопроса, представленный в виде сетки столбцов и строк, который позволяет респонденту выбрать один вариант ответа в строке из последовательности переключателей. |
GridValidation | DataValidation для GridItem . |
GridValidationBuilder | DataValidationBuilder для GridValidation . |
ImageItem | Элемент макета, отображающий изображение. |
Item | Общий элемент формы, который содержит свойства, общие для всех элементов, такие как заголовок и текст справки. |
ItemResponse | Ответ на один вопрос в форме. |
ItemType | Перечисление, представляющее поддерживаемые типы элементов формы. |
ListItem | Элемент вопроса, который позволяет респонденту выбрать один вариант ответа из раскрывающегося списка. |
MultipleChoiceItem | Элемент вопроса, который позволяет респонденту выбрать один вариант из списка переключателей или необязательного поля «другое». |
PageBreakItem | Элемент макета, обозначающий начало страницы. |
PageNavigationType | Перечисление, представляющее поддерживаемые типы навигации по страницам. |
ParagraphTextItem | Элемент вопроса, который позволяет респонденту ввести блок текста. |
ParagraphTextValidation | DataValidation для ParagraphTextItem . |
ParagraphTextValidationBuilder | DataValidationBuilder для ParagraphTextValidation . |
QuizFeedback | Реализация компонента Feedback, который содержит свойства, общие для всех отзывов, такие как отображаемый текст или ссылки. |
QuizFeedbackBuilder | Базовый объект FeedbackBuilder, содержащий установщики свойств, общих для всех отзывов, таких как отображаемый текст. |
ScaleItem | Элемент вопроса, который позволяет респонденту выбрать один вариант из пронумерованной последовательности переключателей. |
SectionHeaderItem | Элемент макета, который визуально указывает начало раздела. |
TextItem | Элемент вопроса, который позволяет респонденту ввести одну строку текста. |
TextValidation | DataValidation для TextItem . |
TextValidationBuilder | DataValidationBuilder для TextValidation . |
TimeItem | Элемент вопроса, который позволяет респонденту указать время суток. |
VideoItem | Элемент макета, отображающий видео. |
Alignment
Характеристики
Свойство | Тип | Описание |
---|---|---|
LEFT | Enum | Выровняйте изображение по левому краю формы. |
CENTER | Enum | Выровняйте изображение по центру формы. |
RIGHT | Enum | Выровняйте изображение по правому краю формы. |
CheckboxGridItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
clearValidation() | CheckboxGridItem | Удаляет любую проверку данных для этого элемента сетки. |
createResponse(responses) | ItemResponse | Создает новый ItemResponse для этого элемента сетки флажков. |
duplicate() | CheckboxGridItem | Создает копию этого элемента и добавляет ее в конец формы. |
getColumns() | String[] | Получает значения для каждого столбца в сетке. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getRows() | String[] | Получает значения для каждой строки в сетке. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setColumns(columns) | CheckboxGridItem | Задает столбцы сетки на основе массива значений. |
setHelpText(text) | CheckboxGridItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setRequired(enabled) | CheckboxGridItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setRows(rows) | CheckboxGridItem | Задает строки сетки на основе массива значений. |
setTitle(title) | CheckboxGridItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
setValidation(validation) | CheckboxGridItem | Задает проверку данных для этого элемента сетки флажков. |
CheckboxGridValidation
CheckboxGridValidationBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
requireLimitOneResponsePerColumn() | CheckboxGridValidationBuilder | Требуется ограничение в один ответ на столбец для элемента сетки. |
CheckboxItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
clearValidation() | CheckboxItem | Удаляет любую проверку данных для этого флажка. |
createChoice(value) | Choice | Создает новый выбор. |
createChoice(value, isCorrect) | Choice | Создает новый выбор. |
createResponse(responses) | ItemResponse | Создает новый ItemResponse для этого флажка. |
duplicate() | CheckboxItem | Создает копию этого элемента и добавляет ее в конец формы. |
getChoices() | Choice[] | Получает все варианты выбора для элемента. |
getFeedbackForCorrect() | QuizFeedback | Возвращает отзыв, который показывается респондентам, когда они правильно отвечают на вопрос. |
getFeedbackForIncorrect() | QuizFeedback | Возвращает обратную связь, которая показывается респондентам, когда они неправильно отвечают на вопрос. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getPoints() | Integer | Возвращает количество баллов оцениваемого предмета. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
hasOtherOption() | Boolean | Определяет, есть ли у элемента опция «другое». |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setChoiceValues(values) | CheckboxItem | Задает варианты выбора элемента из массива строк. |
setChoices(choices) | CheckboxItem | Устанавливает массив вариантов выбора для элемента. |
setFeedbackForCorrect(feedback) | CheckboxItem | Устанавливает, что респондентам будет показана обратная связь, когда они правильно ответят на вопрос. |
setFeedbackForIncorrect(feedback) | CheckboxItem | Устанавливает обратную связь, которая будет отображаться для респондентов, когда они неправильно отвечают на вопрос. |
setHelpText(text) | CheckboxItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setPoints(points) | CheckboxItem | Устанавливает количество баллов, которое оценивается оцениваемым элементом. |
setRequired(enabled) | CheckboxItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setTitle(title) | CheckboxItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
setValidation(validation) | CheckboxItem | Задает проверку данных для этого флажка. |
showOtherOption(enabled) | CheckboxItem | Устанавливает, имеет ли элемент «другое» значение. |
CheckboxValidation
CheckboxValidationBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
requireSelectAtLeast(number) | CheckboxValidationBuilder | Требовать, чтобы было выбрано как минимум это количество вариантов. |
requireSelectAtMost(number) | CheckboxValidationBuilder | Требовать, чтобы было выбрано не более этого количества вариантов. |
requireSelectExactly(number) | CheckboxValidationBuilder | Требовать, чтобы было выбрано ровно столько вариантов. |
Choice
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getGotoPage() | PageBreakItem | Возвращает PageBreakItem установленный как место назначения GO_TO_PAGE , если отвечающая сторона выбирает этот вариант и завершает текущую страницу. |
getPageNavigationType() | PageNavigationType | Получает PageNavigationType , который возникает, если отвечающая сторона выбирает этот вариант и завершает текущую страницу. |
getValue() | String | Получает значение выбора, которое респонденты видят в виде метки при просмотре формы. |
isCorrectAnswer() | Boolean | Получает, является ли выбор правильным ответом на вопрос. |
DateItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
createResponse(response) | ItemResponse | Создает новый ItemResponse для этого элемента даты. |
duplicate() | DateItem | Создает копию этого элемента и добавляет ее в конец формы. |
getGeneralFeedback() | QuizFeedback | Возвращает отзыв, который показывается респондентам, когда они отвечают на оцениваемый вопрос. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getPoints() | Integer | Возвращает количество баллов оцениваемого предмета. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
includesYear() | Boolean | Определяет, включает ли элемент даты параметр года. |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setGeneralFeedback(feedback) | DateItem | Настраивает отображение обратной связи для респондентов, когда они отвечают на оцениваемый вопрос, на который нет правильного или неправильного ответа (т. е. вопросы, требующие оценивания вручную). |
setHelpText(text) | DateItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setIncludesYear(enableYear) | DateItem | Устанавливает, включает ли элемент даты настройку года. |
setPoints(points) | DateItem | Устанавливает количество баллов, которое оценивается оцениваемым элементом. |
setRequired(enabled) | DateItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setTitle(title) | DateItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
DateTimeItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
createResponse(response) | ItemResponse | Создает новый ItemResponse для этого элемента даты и времени. |
duplicate() | DateTimeItem | Создает копию этого элемента и добавляет ее в конец формы. |
getGeneralFeedback() | QuizFeedback | Возвращает отзыв, который показывается респондентам, когда они отвечают на оцениваемый вопрос. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getPoints() | Integer | Возвращает количество баллов оцениваемого предмета. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
includesYear() | Boolean | Определяет, включает ли элемент даты параметр года. |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setGeneralFeedback(feedback) | DateTimeItem | Настраивает отображение обратной связи для респондентов, когда они отвечают на оцениваемый вопрос, на который нет правильного или неправильного ответа (т. е. вопросы, требующие оценивания вручную). |
setHelpText(text) | DateTimeItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setIncludesYear(enableYear) | DateTimeItem | Устанавливает, включает ли элемент даты настройку года. |
setPoints(points) | DateTimeItem | Устанавливает количество баллов, которое оценивается оцениваемым элементом. |
setRequired(enabled) | DateTimeItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setTitle(title) | DateTimeItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
DestinationType
Характеристики
Свойство | Тип | Описание |
---|---|---|
SPREADSHEET | Enum | Электронная таблица Google Sheets в качестве места назначения для ответов формы. |
DurationItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
createResponse(hours, minutes, seconds) | ItemResponse | Создает новый ItemResponse для этого элемента даты. |
duplicate() | DurationItem | Создает копию этого элемента и добавляет ее в конец формы. |
getGeneralFeedback() | QuizFeedback | Возвращает отзыв, который показывается респондентам, когда они отвечают на оцениваемый вопрос. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getPoints() | Integer | Возвращает количество баллов оцениваемого предмета. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setGeneralFeedback(feedback) | DurationItem | Настраивает отображение обратной связи для респондентов, когда они отвечают на оцениваемый вопрос, на который нет правильного или неправильного ответа (т. е. вопросы, требующие оценивания вручную). |
setHelpText(text) | DurationItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setPoints(points) | DurationItem | Устанавливает количество баллов, которое оценивается оцениваемым элементом. |
setRequired(enabled) | DurationItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setTitle(title) | DurationItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
FeedbackType
Характеристики
Свойство | Тип | Описание |
---|---|---|
CORRECT | Enum | Отзыв, автоматически отображаемый респондентам при правильном ответе на вопрос. |
INCORRECT | Enum | Обратная связь, которая автоматически отображается респондентам в случае неправильного ответа на вопрос. |
GENERAL | Enum | Отзыв, который автоматически отображается для респондентов, когда они отправляют свой ответ. |
Form
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
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. |
FormApp
Характеристики
Свойство | Тип | Описание |
---|---|---|
Alignment | Alignment | Перечень типов выравнивания изображения. |
DestinationType | DestinationType | Перечисление типов мест назначения, которые могут хранить ответы формы. |
FeedbackType | FeedbackType | Перечень типов формы Feedbacks . |
ItemType | ItemType | Перечисление типов Items формы. |
PageNavigationType | PageNavigationType | Перечисление возможных вариантов поведения для навигации по страницам. |
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
create(title) | Form | Создает и возвращает новую Form . |
createCheckboxGridValidation() | CheckboxGridValidationBuilder | Возвращает экземпляр CheckboxGridValidationBuilder, который можно использовать для установки проверки CheckboxGridItem . |
createCheckboxValidation() | CheckboxValidationBuilder | Возвращает экземпляр CheckboxValidationBuilder, который можно использовать для установки проверки CheckboxItem . |
createFeedback() | QuizFeedbackBuilder | Возвращает экземпляр QuizFeedbackBuilder, который можно использовать для установки отзыва об оцениваемом Item . |
createGridValidation() | GridValidationBuilder | Возвращает экземпляр GridValidationBuilder, который можно использовать для установки проверки GridItem . |
createParagraphTextValidation() | ParagraphTextValidationBuilder | Возвращает экземпляр ParagraphTextValidationBuilder, который можно использовать для установки проверки для ParagraphTextItem . |
createTextValidation() | TextValidationBuilder | Возвращает экземпляр TextValidationBuilder, который можно использовать для установки проверки TextItem . |
getActiveForm() | Form | Возвращает форму, к которой скрипт привязывается к контейнеру . |
getUi() | Ui | Возвращает экземпляр среды пользовательского интерфейса редактора форм, которая позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели. |
openById(id) | Form | Возвращает Form с указанным идентификатором. |
openByUrl(url) | Form | Возвращает Form с указанным URL. |
FormResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getEditResponseUrl() | String | Создает URL-адрес, который можно использовать для редактирования уже отправленного ответа. |
getGradableItemResponses() | ItemResponse[] | Получает все ответы на элементы, содержащиеся в ответе формы, в том же порядке, в котором элементы отображаются в форме. |
getGradableResponseForItem(item) | ItemResponse | Получает ответ элемента, содержащийся в ответе формы для данного элемента. |
getId() | String | Получает идентификатор ответа формы. |
getItemResponses() | ItemResponse[] | Получает все ответы на элементы, содержащиеся в ответе формы, в том же порядке, в котором элементы отображаются в форме. |
getRespondentEmail() | String | Получает адрес электронной почты лица, отправившего ответ, если параметр Form.setCollectEmail(collect) включен. |
getResponseForItem(item) | ItemResponse | Получает ответ элемента, содержащийся в этом ответе формы для данного элемента. |
getTimestamp() | Date | Получает метку времени для отправки ответа формы. |
submit() | FormResponse | Отправляет ответ. |
toPrefilledUrl() | String | Создает URL-адрес для формы, в которой ответы предварительно заполняются на основе ответов в этом ответе формы. |
withItemGrade(gradedResponse) | FormResponse | Добавляет оценки данного ответа элемента к ответу формы. |
withItemResponse(response) | FormResponse | Добавляет данный ответ элемента к ответу формы. |
GridItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
clearValidation() | GridItem | Удаляет любую проверку данных для этого элемента сетки. |
createResponse(responses) | ItemResponse | Создает новый ItemResponse для этого элемента сетки. |
duplicate() | GridItem | Создает копию этого элемента и добавляет ее в конец формы. |
getColumns() | String[] | Получает значения для каждого столбца в сетке. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getRows() | String[] | Получает значения для каждой строки в сетке. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setColumns(columns) | GridItem | Задает столбцы сетки на основе массива значений. |
setHelpText(text) | GridItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setRequired(enabled) | GridItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setRows(rows) | GridItem | Задает строки сетки на основе массива значений. |
setTitle(title) | GridItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
setValidation(validation) | GridItem | Задает проверку данных для этого элемента сетки. |
GridValidation
GridValidationBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
requireLimitOneResponsePerColumn() | GridValidationBuilder | Требуется ограничение в один ответ на столбец для элемента сетки. |
ImageItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
duplicate() | ImageItem | Создает копию этого элемента и добавляет ее в конец формы. |
getAlignment() | Alignment | Получает горизонтальное выравнивание изображения. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getImage() | Blob | Получает изображение, которое в настоящее время назначено элементу. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
getWidth() | Integer | Получает ширину изображения в пикселях. |
setAlignment(alignment) | ImageItem | Устанавливает горизонтальное выравнивание изображения. |
setHelpText(text) | ImageItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setImage(image) | ImageItem | Устанавливает само изображение. |
setTitle(title) | ImageItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
setWidth(width) | ImageItem | Устанавливает ширину изображения в пикселях. |
Item
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
asCheckboxGridItem() | CheckboxGridItem | Возвращает элемент как элемент сетки флажков. |
asCheckboxItem() | CheckboxItem | Возвращает элемент как элемент флажка. |
asDateItem() | DateItem | Возвращает элемент как элемент даты. |
asDateTimeItem() | DateTimeItem | Возвращает элемент как элемент даты и времени. |
asDurationItem() | DurationItem | Возвращает элемент как элемент длительности. |
asGridItem() | GridItem | Возвращает элемент как элемент сетки. |
asImageItem() | ImageItem | Возвращает элемент как элемент изображения. |
asListItem() | ListItem | Возвращает элемент как элемент списка. |
asMultipleChoiceItem() | MultipleChoiceItem | Возвращает элемент как элемент с множественным выбором. |
asPageBreakItem() | PageBreakItem | Возвращает элемент как элемент разрыва страницы. |
asParagraphTextItem() | ParagraphTextItem | Возвращает элемент как текстовый элемент абзаца. |
asScaleItem() | ScaleItem | Возвращает элемент как элемент шкалы. |
asSectionHeaderItem() | SectionHeaderItem | Возвращает элемент как элемент заголовка раздела. |
asTextItem() | TextItem | Возвращает элемент как текстовый элемент. |
asTimeItem() | TimeItem | Возвращает элемент как элемент времени. |
asVideoItem() | VideoItem | Возвращает элемент как элемент видео. |
duplicate() | Item | Создает копию этого элемента и добавляет ее в конец формы. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
setHelpText(text) | Item | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setTitle(title) | Item | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
ItemResponse
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getFeedback() | Object | Получает отзыв, который был предоставлен для отправленного ответа респондента. |
getItem() | Item | Получает элемент вопроса, на который отвечает этот ответ. |
getResponse() | Object | Получает ответ, отправленный респондентом. |
getScore() | Object | Получает оценку за представленный ответ респондента. |
setFeedback(feedback) | ItemResponse | Устанавливает отзыв, который должен отображаться для отправленного ответа респондента. |
setScore(score) | ItemResponse | Устанавливает балл за представленный ответ респондента. |
ItemType
Характеристики
Свойство | Тип | Описание |
---|---|---|
CHECKBOX | Enum | Элемент вопроса, который позволяет респонденту выбрать один или несколько флажков, а также необязательное поле «Другое». |
CHECKBOX_GRID | Enum | Элемент вопроса, представленный в виде сетки столбцов и строк, который позволяет респонденту выбрать несколько вариантов ответа в строке из последовательности флажков. |
DATE | Enum | Элемент вопроса, который позволяет респонденту указать дату. |
DATETIME | Enum | Пункт вопроса, который позволяет респонденту указать дату и время. |
DURATION | Enum | Пункт вопроса, который позволяет респонденту указать продолжительность времени. |
GRID | Enum | Элемент вопроса, представленный в виде сетки столбцов и строк, который позволяет респонденту выбрать один вариант ответа в строке из последовательности переключателей. |
IMAGE | Enum | Элемент макета, отображающий изображение. |
LIST | Enum | Элемент вопроса, который позволяет респонденту выбрать один вариант ответа из раскрывающегося списка. |
MULTIPLE_CHOICE | Enum | Элемент вопроса, который позволяет респонденту выбрать один вариант из списка переключателей или необязательного поля «другое». |
PAGE_BREAK | Enum | Элемент макета, обозначающий начало страницы. |
PARAGRAPH_TEXT | Enum | Элемент вопроса, который позволяет респонденту ввести блок текста. |
SCALE | Enum | Элемент вопроса, который позволяет респонденту выбрать один вариант из пронумерованной последовательности переключателей. |
SECTION_HEADER | Enum | Элемент макета, который визуально указывает начало раздела. |
TEXT | Enum | Элемент вопроса, который позволяет респонденту ввести одну строку текста. |
TIME | Enum | Элемент вопроса, который позволяет респонденту указать время суток. |
VIDEO | Enum | Элемент макета, отображающий видео YouTube. |
FILE_UPLOAD | Enum | Элемент вопроса, который позволяет респонденту загрузить файл. |
ListItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
createChoice(value) | Choice | Создает новый выбор. |
createChoice(value, isCorrect) | Choice | Создает новый выбор. |
createChoice(value, navigationItem) | Choice | Создает новый выбор с параметром навигации по страницам, который переходит к заданному элементу разрыва страницы. |
createChoice(value, navigationType) | Choice | Создает новый выбор с возможностью навигации по страницам. |
createResponse(response) | ItemResponse | Создает новый ItemResponse для этого элемента списка. |
duplicate() | ListItem | Создает копию этого элемента и добавляет ее в конец формы. |
getChoices() | Choice[] | Получает все варианты выбора для элемента. |
getFeedbackForCorrect() | QuizFeedback | Возвращает отзыв, который показывается респондентам, когда они правильно отвечают на вопрос. |
getFeedbackForIncorrect() | QuizFeedback | Возвращает обратную связь, которая показывается респондентам, когда они неправильно отвечают на вопрос. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getPoints() | Integer | Возвращает количество баллов оцениваемого предмета. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setChoiceValues(values) | ListItem | Задает варианты выбора элемента из массива строк. |
setChoices(choices) | ListItem | Устанавливает массив вариантов выбора для элемента. |
setFeedbackForCorrect(feedback) | ListItem | Устанавливает, что респондентам будет показана обратная связь, когда они правильно ответят на вопрос. |
setFeedbackForIncorrect(feedback) | ListItem | Устанавливает обратную связь, которая будет отображаться для респондентов, когда они неправильно отвечают на вопрос. |
setHelpText(text) | ListItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setPoints(points) | ListItem | Устанавливает количество баллов, которое оценивается оцениваемым элементом. |
setRequired(enabled) | ListItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setTitle(title) | ListItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
MultipleChoiceItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
createChoice(value) | Choice | Создает новый выбор. |
createChoice(value, isCorrect) | Choice | Создает новый выбор. |
createChoice(value, navigationItem) | Choice | Создает новый выбор с параметром навигации по страницам, который переходит к заданному элементу разрыва страницы. |
createChoice(value, navigationType) | Choice | Создает новый выбор с возможностью навигации по страницам. |
createResponse(response) | ItemResponse | Создает новый ItemResponse для этого элемента множественного выбора. |
duplicate() | MultipleChoiceItem | Создает копию этого элемента и добавляет ее в конец формы. |
getChoices() | Choice[] | Получает все варианты выбора для элемента. |
getFeedbackForCorrect() | QuizFeedback | Возвращает отзыв, который показывается респондентам, когда они правильно отвечают на вопрос. |
getFeedbackForIncorrect() | QuizFeedback | Возвращает обратную связь, которая показывается респондентам, когда они неправильно отвечают на вопрос. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getPoints() | Integer | Возвращает количество баллов оцениваемого предмета. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
hasOtherOption() | Boolean | Определяет, есть ли у элемента опция «другое». |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setChoiceValues(values) | MultipleChoiceItem | Задает варианты выбора элемента из массива строк. |
setChoices(choices) | MultipleChoiceItem | Устанавливает массив вариантов выбора для элемента. |
setFeedbackForCorrect(feedback) | MultipleChoiceItem | Устанавливает, что респондентам будет показана обратная связь, когда они правильно ответят на вопрос. |
setFeedbackForIncorrect(feedback) | MultipleChoiceItem | Устанавливает обратную связь, которая будет отображаться для респондентов, когда они неправильно отвечают на вопрос. |
setHelpText(text) | MultipleChoiceItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setPoints(points) | MultipleChoiceItem | Устанавливает количество баллов, которое оценивается оцениваемым элементом. |
setRequired(enabled) | MultipleChoiceItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setTitle(title) | MultipleChoiceItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
showOtherOption(enabled) | MultipleChoiceItem | Устанавливает, имеет ли элемент «другое» значение. |
PageBreakItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
duplicate() | PageBreakItem | Создает копию этого элемента и добавляет ее в конец формы. |
getGoToPage() | PageBreakItem | Получает объект PageBreakItem , на который перейдет форма после завершения страницы до этого разрыва страницы (то есть при достижении этого разрыва страницы путем обычного линейного продвижения по форме). |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getPageNavigationType() | PageNavigationType | Получает тип перехода по странице, который происходит после завершения страницы до этого разрыва страницы (то есть при достижении этого разрыва страницы путем обычного линейного продвижения по форме). |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
setGoToPage(goToPageItem) | PageBreakItem | Устанавливает страницу для перехода после завершения страницы до этого разрыва страницы (то есть, при достижении этого разрыва страницы обычным линейным продвижением по форме). |
setGoToPage(navigationType) | PageBreakItem | Устанавливает тип навигации по странице, которая происходит после завершения страницы до этого разрыва страницы (то есть при достижении этого разрыва страницы путем обычного линейного продвижения по форме). |
setHelpText(text) | PageBreakItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setTitle(title) | PageBreakItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
PageNavigationType
Характеристики
Свойство | Тип | Описание |
---|---|---|
CONTINUE | Enum | Перейдите к следующей странице формы после заполнения текущей страницы. |
GO_TO_PAGE | Enum | Переход к указанной странице формы после завершения текущей страницы. |
RESTART | Enum | Перезапустите форму с самого начала, не удаляя ранее введенные ответы, после завершения текущей страницы. |
SUBMIT | Enum | Отправьте ответ формы после заполнения текущей страницы. |
ParagraphTextItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
clearValidation() | ParagraphTextItem | Удаляет любую проверку данных для этого текстового элемента абзаца. |
createResponse(response) | ItemResponse | Создает новый ItemResponse для этого текстового элемента абзаца. |
duplicate() | ParagraphTextItem | Создает копию этого элемента и добавляет ее в конец формы. |
getGeneralFeedback() | QuizFeedback | Возвращает отзыв, который показывается респондентам, когда они отвечают на оцениваемый вопрос. |
getHelpText() | String | Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
getId() | Integer | Получает уникальный идентификатор элемента. |
getIndex() | Integer | Получает индекс элемента среди всех элементов в форме. |
getPoints() | Integer | Возвращает количество баллов оцениваемого предмета. |
getTitle() | String | Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
getType() | ItemType | Получает тип элемента, представленный как ItemType . |
isRequired() | Boolean | Определяет, должен ли респондент отвечать на вопрос. |
setGeneralFeedback(feedback) | ParagraphTextItem | Настраивает отображение обратной связи для респондентов, когда они отвечают на оцениваемый вопрос, на который нет правильного или неправильного ответа (т. е. вопросы, требующие оценивания вручную). |
setHelpText(text) | ParagraphTextItem | Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ). |
setPoints(points) | ParagraphTextItem | Устанавливает количество баллов, которое оценивается оцениваемым элементом. |
setRequired(enabled) | ParagraphTextItem | Устанавливает, должен ли респондент отвечать на вопрос. |
setTitle(title) | ParagraphTextItem | Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ). |
setValidation(validation) | ParagraphTextItem | Задает проверку данных для этого текстового элемента абзаца. |
ParagraphTextValidation
ParagraphTextValidationBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
requireTextContainsPattern(pattern) | ParagraphTextValidationBuilder | Требуется ответ, содержащий шаблон. |
requireTextDoesNotContainPattern(pattern) | ParagraphTextValidationBuilder | Требуется ответ, чтобы не содержать шаблон. |
requireTextDoesNotMatchPattern(pattern) | ParagraphTextValidationBuilder | Требуется ответ на несоответствие шаблону. |
requireTextLengthGreaterThanOrEqualTo(number) | ParagraphTextValidationBuilder | Требуется, чтобы длина ответа была больше или равна значению. |
requireTextLengthLessThanOrEqualTo(number) | ParagraphTextValidationBuilder | Требуется, чтобы длина ответа была меньше значения. |
requireTextMatchesPattern(pattern) | ParagraphTextValidationBuilder | Требуется ответ для соответствия шаблону. |
QuizFeedback
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
getLinkUrls() | String[] | Получает список URL-адресов, связанных с отзывом. |
getText() | String | Получает отображаемый текст обратной связи. |
QuizFeedbackBuilder
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addLink(url) | QuizFeedbackBuilder | Добавляет ссылку на дополнительный материал отзыва. |
addLink(url, displayText) | QuizFeedbackBuilder | Добавляет ссылку на дополнительный материал отзыва. |
build() | QuizFeedback | Строит Обратную связь соответствующего типа для данного построителя. |
copy() | QuizFeedbackBuilder | Возвращает копию этого построителя. |
setText(text) | QuizFeedbackBuilder | Устанавливает текст обратной связи. |
ScaleItem
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
createResponse(response) | ItemResponse | Создает новый ItemResponse для этого элемента шкалы. |
duplicate() | ScaleItem | Создает копию этого элемента и добавляет ее в конец формы. |
getGeneralFeedback() | QuizFeedback | Возвращает отзыв, который показывается респондентам, когда они отвечают на оцениваемый вопрос. |
getHelpText() | String | Gets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
getId() | Integer | Gets the item's unique identifier. |
getIndex() | Integer | Gets the index of the item among all the items in the form. |
getLeftLabel() | String | Gets the label for the scale's lower bound, if any. |
getLowerBound() | Integer | Gets the scale's lower bound. |
getPoints() | Integer | Returns the point value of a gradeable item. |
getRightLabel() | String | Gets the label for the scale's upper bound, if any. |
getTitle() | String | Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
getType() | ItemType | Gets the item's type, represented as an ItemType . |
getUpperBound() | Integer | Gets the scale's upper bound. |
isRequired() | Boolean | Determines whether the respondent must answer the question. |
setBounds(lower, upper) | ScaleItem | Sets the scale's lower and upper bounds. |
setGeneralFeedback(feedback) | ScaleItem | Sets the feedback to be shown to respondents when they respond to a gradeable question that doesn't have a correct or incorrect answer (ie questions that require manual grading). |
setHelpText(text) | ScaleItem | Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
setLabels(lower, upper) | ScaleItem | Sets labels for the scale's lower and upper bounds. |
setPoints(points) | ScaleItem | Sets the number of points a gradeable item is worth. |
setRequired(enabled) | ScaleItem | Sets whether the respondent must answer the question. |
setTitle(title) | ScaleItem | Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
SectionHeaderItem
Methods
Method | Return type | Brief description |
---|---|---|
duplicate() | SectionHeaderItem | Creates a copy of this item and appends it to the end of the form. |
getHelpText() | String | Gets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
getId() | Integer | Gets the item's unique identifier. |
getIndex() | Integer | Gets the index of the item among all the items in the form. |
getTitle() | String | Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
getType() | ItemType | Gets the item's type, represented as an ItemType . |
setHelpText(text) | SectionHeaderItem | Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
setTitle(title) | SectionHeaderItem | Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
TextItem
Methods
Method | Return type | Brief description |
---|---|---|
clearValidation() | TextItem | Removes any data validation for this text item. |
createResponse(response) | ItemResponse | Creates a new ItemResponse for this text item. |
duplicate() | TextItem | Creates a copy of this item and appends it to the end of the form. |
getGeneralFeedback() | QuizFeedback | Returns the feedback that is shown to respondents when they respond to a gradeable question. |
getHelpText() | String | Gets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
getId() | Integer | Gets the item's unique identifier. |
getIndex() | Integer | Gets the index of the item among all the items in the form. |
getPoints() | Integer | Returns the point value of a gradeable item. |
getTitle() | String | Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
getType() | ItemType | Gets the item's type, represented as an ItemType . |
isRequired() | Boolean | Determines whether the respondent must answer the question. |
setGeneralFeedback(feedback) | TextItem | Sets the feedback to be shown to respondents when they respond to a gradeable question that doesn't have a correct or incorrect answer (ie questions that require manual grading). |
setHelpText(text) | TextItem | Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
setPoints(points) | TextItem | Sets the number of points a gradeable item is worth. |
setRequired(enabled) | TextItem | Sets whether the respondent must answer the question. |
setTitle(title) | TextItem | Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
setValidation(validation) | TextItem | Sets the data validation for this text item. |
TextValidation
TextValidationBuilder
Methods
Method | Return type | Brief description |
---|---|---|
requireNumber() | TextValidationBuilder | Requires text item to be a number. |
requireNumberBetween(start, end) | TextValidationBuilder | Requires text item to be a number between start and end, inclusive. |
requireNumberEqualTo(number) | TextValidationBuilder | Requires text item to be a number equal to value specified. |
requireNumberGreaterThan(number) | TextValidationBuilder | Requires text item to be a number greater than the value specified. |
requireNumberGreaterThanOrEqualTo(number) | TextValidationBuilder | Requires text item to be a number greater than or equal to the value specified. |
requireNumberLessThan(number) | TextValidationBuilder | Requires text item to be a number less than the value specified. |
requireNumberLessThanOrEqualTo(number) | TextValidationBuilder | Requires text item to be a number less than or equal to the value specified. |
requireNumberNotBetween(start, end) | TextValidationBuilder | Requires text item to be a number not between start and end, inclusive. |
requireNumberNotEqualTo(number) | TextValidationBuilder | Requires text item to be a number not equal to the value specified. |
requireTextContainsPattern(pattern) | TextValidationBuilder | Requires response to contain pattern. |
requireTextDoesNotContainPattern(pattern) | TextValidationBuilder | Requires response to not contain pattern. |
requireTextDoesNotMatchPattern(pattern) | TextValidationBuilder | Requires response to not match pattern. |
requireTextIsEmail() | TextValidationBuilder | Requires text item to be an email address. |
requireTextIsUrl() | TextValidationBuilder | Requires text item to be a URL. |
requireTextLengthGreaterThanOrEqualTo(number) | TextValidationBuilder | Requires response length to be greater than or equal to value. |
requireTextLengthLessThanOrEqualTo(number) | TextValidationBuilder | Requires response length to be less than value. |
requireTextMatchesPattern(pattern) | TextValidationBuilder | Requires response to match pattern. |
requireWholeNumber() | TextValidationBuilder | Requires text item to be a whole number. |
TimeItem
Methods
Method | Return type | Brief description |
---|---|---|
createResponse(hour, minute) | ItemResponse | Creates a new ItemResponse for this time item. |
duplicate() | TimeItem | Creates a copy of this item and appends it to the end of the form. |
getGeneralFeedback() | QuizFeedback | Returns the feedback that is shown to respondents when they respond to a gradeable question. |
getHelpText() | String | Gets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
getId() | Integer | Gets the item's unique identifier. |
getIndex() | Integer | Gets the index of the item among all the items in the form. |
getPoints() | Integer | Returns the point value of a gradeable item. |
getTitle() | String | Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
getType() | ItemType | Gets the item's type, represented as an ItemType . |
isRequired() | Boolean | Determines whether the respondent must answer the question. |
setGeneralFeedback(feedback) | TimeItem | Sets the feedback to be shown to respondents when they respond to a gradeable question that doesn't have a correct or incorrect answer (ie questions that require manual grading). |
setHelpText(text) | TimeItem | Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
setPoints(points) | TimeItem | Sets the number of points a gradeable item is worth. |
setRequired(enabled) | TimeItem | Sets whether the respondent must answer the question. |
setTitle(title) | TimeItem | Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
VideoItem
Methods
Method | Return type | Brief description |
---|---|---|
duplicate() | VideoItem | Creates a copy of this item and appends it to the end of the form. |
getAlignment() | Alignment | Gets the video's horizontal alignment. |
getHelpText() | String | Gets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
getId() | Integer | Gets the item's unique identifier. |
getIndex() | Integer | Gets the index of the item among all the items in the form. |
getTitle() | String | Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
getType() | ItemType | Gets the item's type, represented as an ItemType . |
getWidth() | Integer | Gets the video's width in pixels. |
setAlignment(alignment) | VideoItem | Sets the video's horizontal alignment. |
setHelpText(text) | VideoItem | Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ). |
setTitle(title) | VideoItem | Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ). |
setVideoUrl(youtubeUrl) | VideoItem | Sets the video itself from a given YouTube URL or YouTube video ID. |
setWidth(width) | VideoItem | Sets the video's width in pixels. |