Class ListItem

ListItem

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

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

Методы

Метод Тип возврата Краткое описание
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 ).

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

createChoice(value)

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

Параметры

Имя Тип Описание
value String ценность выбора, которую респонденты видят в виде ярлыка при просмотре формы

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

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

Авторизация

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

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

createChoice(value, isCorrect)

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

Параметры

Имя Тип Описание
value String ценность выбора, которую респонденты видят в виде ярлыка при просмотре формы
isCorrect 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 . Варианты выбора, использующие навигацию по страницам, не могут быть объединены в одном элементе с вариантами, не использующими навигацию по страницам.

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

Параметры

Имя Тип Описание
value String ценность выбора, которую респонденты видят в виде ярлыка при просмотре формы
navigationItem PageBreakItem элемент, к которому нужно перейти

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

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

Авторизация

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

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

createChoice(value, navigationType)

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

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

Параметры

Имя Тип Описание
value String ценность выбора, которую респонденты видят в виде ярлыка при просмотре формы
navigationType PageNavigationType выбранный тип навигации

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

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 — обратная связь, если она есть.

Авторизация

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

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

getFeedbackForIncorrect()

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

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

QuizFeedback — обратная связь, если она есть.

Авторизация

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

  • 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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.
var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
var 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().setDisplayText("Dogs rule, cats drool.").build());

Параметры

Имя Тип Описание
feedback QuizFeedback новый отзыв. Нулевое значение очистит обратную связь.

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

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

Авторизация

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

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

setFeedbackForIncorrect(feedback)

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

Параметры

Имя Тип Описание
feedback QuizFeedback новый отзыв

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

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