Class ListItem

Элемент списка

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

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?').setChoices([
  item.createChoice('Cats'), item.createChoice('Dogs')
]);

Методы

Метод Тип возвращаемого значения Краткое описание
create Choice(value) Choice Создает новый вариант выбора.
create Choice(value, isCorrect) Choice Создает новый вариант выбора.
create Choice(value, navigationItem) Choice Создает новый вариант выбора с опцией навигации по страницам, которая позволяет перейти к указанному элементу разрыва страницы.
create Choice(value, navigationType) Choice Создает новый вариант выбора с опцией навигации по страницам.
create Response(response) Item Response Создает новый Item Response для этого элемента списка.
duplicate() List Item Создает копию этого элемента и добавляет ее в конец формы.
get Choices() Choice[] Получает все варианты выбора товара.
get Feedback For Correct() Quiz Feedback |null Возвращает обратную связь, которая отображается респондентам, когда они правильно отвечают на вопрос.
get Feedback For Incorrect() Quiz Feedback |null Возвращает обратную связь, которая отображается респондентам, когда они дают неверный ответ на вопрос.
get Help Text() String Получает справочный текст элемента (иногда называемый описательным текстом для элементов макета, таких как Image Items , Page Break Items и Section Header Items ).
get Id() Integer Получает уникальный идентификатор элемента.
get Index() Integer Получает индекс элемента среди всех элементов в форме.
get Points() Integer Возвращает балльное значение оцениваемого элемента.
get Title() String Получает заголовок элемента (иногда называемый текстом заголовка, в случае Section Header Item ).
get Type() Item Type Получает тип элемента, представленный в виде Item Type .
is Required() Boolean Определяет, обязан ли респондент ответить на вопрос.
set Choice Values(values) List Item Задает варианты выбора элемента из массива строк.
set Choices(choices) List Item Задает массив вариантов выбора для элемента.
set Feedback For Correct(feedback) List Item Задает параметры обратной связи, отображаемые респондентам при правильном ответе на вопрос.
set Feedback For Incorrect(feedback) List Item Задает параметры обратной связи, отображаемые респондентам в случае неправильного ответа на вопрос.
set Help Text(text) List Item Задает текст справки для элемента (иногда называемый текстом описания для элементов макета, таких как Image Items , Page Break Items и Section Header Items ).
set Points(points) List Item Устанавливает количество баллов, которое может быть присуждено оцениваемому элементу.
set Required(enabled) List Item Определяет, обязан ли респондент ответить на вопрос.
set Title(title) List Item Задает заголовок элемента (иногда называемый текстом заголовка, в случае Section Header Item ).

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

createChoice(value)

Создает новый вариант выбора.

Параметры

Имя Тип Описание
value String Значение выбора, которое респонденты видят в форме в виде метки.

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

Choice — новый выбор

Авторизация

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

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

createChoice(value, isCorrect)

Создает новый вариант выбора.

Параметры

Имя Тип Описание
value String Значение выбора, которое респонденты видят в форме в виде метки.
is Correct Boolean является ли этот выбор правильным ответом

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

Choice — новый выбор

Авторизация

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

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

createChoice(value, navigationItem)

Создает новый вариант выбора с опцией навигации по страницам, которая переходит к заданному элементу разрыва страницы. Это эквивалентно функции createChoice(value, navigationType) с navigationType , установленным в FormApp.PageNavigationType.GO_TO_PAGE . Варианты выбора, использующие навигацию по страницам, нельзя объединять в одном элементе с вариантами выбора, не использующими навигацию по страницам.

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

Обратите внимание, что использование навигации по страницам для элемента жестко задает маршрутизацию, а это значит, что showOtherOption(true) не следует использовать одновременно.

Параметры

Имя Тип Описание
value String Значение выбора, которое респонденты видят в форме в виде метки.
navigation Item Page Break Item элемент, к которому нужно перейти

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

Choice — новый выбор

Авторизация

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

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

createChoice(value, navigationType)

Создает новый вариант выбора с возможностью постраничной навигации. Варианты выбора, использующие постраничную навигацию, нельзя объединять в одном элементе с вариантами выбора, не использующими постраничную навигацию.

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

Обратите внимание, что использование навигации по страницам для элемента жестко задает маршрутизацию, а это значит, что showOtherOption(true) не следует использовать одновременно.

Параметры

Имя Тип Описание
value String Значение выбора, которое респонденты видят в форме в виде метки.
navigation Type Page Navigation Type тип навигации в зависимости от выбранного варианта

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

Choice — новый выбор

Авторизация

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

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

createResponse(response)

Создает новый объект ItemResponse для этого элемента списка. Генерирует исключение, если аргумент response не соответствует допустимому варианту выбора для этого элемента.

Параметры

Имя Тип Описание
response String правильный ответ для этого пункта списка

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

ItemResponse — ответ на запрос товара

Авторизация

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

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

duplicate()

Создает копию этого элемента и добавляет ее в конец формы.

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

ListItem — дубликат этого ListItem для создания цепочек вызовов.

Авторизация

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

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

getChoices()

Получает все варианты выбора товара.

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

Choice[] — множество вариантов выбора

Авторизация

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

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

getFeedbackForCorrect()

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

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

QuizFeedback |null — отзыв, если таковой имеется.

Авторизация

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

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

getFeedbackForIncorrect()

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

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

QuizFeedback |null — отзыв, если таковой имеется.

Авторизация

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

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

getHelpText()

Получает справочный текст элемента (иногда называемый описательным текстом для элементов макета, таких как ImageItems , PageBreakItems и SectionHeaderItems ).

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

String — текст справки или описания элемента.

Авторизация

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

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

getId()

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

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

Integer — идентификатор товара.

Авторизация

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

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

getIndex()

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

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

Integer — индекс элемента

Авторизация

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

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

getPoints()

Возвращает балльное значение оцениваемого элемента.

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

Integer — количество баллов, которое стоит вопрос.

Авторизация

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

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

getTitle()

Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ).

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

String — заголовок или подзаголовок элемента

Авторизация

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

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

getType()

Получает тип элемента, представленный в виде объекта ItemType .

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

ItemType — тип товара

Авторизация

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

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

isRequired()

Определяет, обязан ли респондент ответить на вопрос.

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

Boolean — указывает, должен ли респондент ответить на вопрос.

Авторизация

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

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

setChoiceValues(values)

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

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

Параметры

Имя Тип Описание
values String[] Набор значений для выбора, которые респонденты видят в виде меток при просмотре формы.

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

ListItem — этот ListItem для создания цепочек вызовов.

Авторизация

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

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

setChoices(choices)

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

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]);

Параметры

Имя Тип Описание
choices Choice[] множество вариантов выбора

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

ListItem — этот ListItem для создания цепочек вызовов.

Броски

Error — если заданный массив равен null , пуст или содержит null элемент.

Авторизация

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

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

setFeedbackForCorrect(feedback)

Задает параметры обратной связи, отображаемые респондентам при правильном ответе на вопрос.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false),
]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setText('Dogs rule, cats drool.').build(),
);

Параметры

Имя Тип Описание
feedback Quiz Feedback Новая функция обратной связи. Значение null очистит обратную связь.

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

ListItem — этот ListItem для создания цепочек вызовов.

Авторизация

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

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

setFeedbackForIncorrect(feedback)

Задает параметры обратной связи, отображаемые респондентам в случае неправильного ответа на вопрос.

Параметры

Имя Тип Описание
feedback Quiz Feedback новая обратная связь

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

ListItem — этот ListItem для создания цепочек вызовов.

Авторизация

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

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

setHelpText(text)

Задает текст справки для элемента (иногда называемый текстом описания для элементов макета, таких как ImageItems , PageBreakItems и SectionHeaderItems ).

Параметры

Имя Тип Описание
text String новый текст справки

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

ListItem — этот ListItem для создания цепочек вызовов.

Авторизация

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

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

setPoints(points)

Задает количество баллов, которое может быть присуждено оцениваемому предмету. Значение по умолчанию для новых предметов — 0.

Параметры

Имя Тип Описание
points Integer количество баллов, которое стоит вопрос

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

ListItem — этот ListItem для создания цепочек вызовов.

Авторизация

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

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

setRequired(enabled)

Определяет, обязан ли респондент ответить на вопрос.

Параметры

Имя Тип Описание
enabled Boolean должен ли респондент ответить на этот вопрос?

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

ListItem — текущий элемент (для создания цепочек)

Авторизация

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

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

setTitle(title)

Задает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ).

Параметры

Имя Тип Описание
title String новый заголовок или подзаголовочный текст

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

ListItem — этот ListItem для создания цепочек вызовов.

Авторизация

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

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