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 Возвращает обратную связь, которая отображается респондентам, когда они правильно отвечают на вопрос.
get Feedback For Incorrect() Quiz Feedback Возвращает обратную связь, которая отображается респондентам, когда они неправильно отвечают на вопрос.
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 ).

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

create Choice(value)

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

Параметры

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

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

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

Авторизация

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

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

create Choice(value, isCorrect)

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

Параметры

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

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

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

Авторизация

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

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

create Choice(value, navigationItem)

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

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

Параметры

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

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

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

Авторизация

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

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

create Choice(value, navigationType)

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

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

Параметры

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

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

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

Авторизация

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

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

create Response(response)

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

Параметры

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

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

Item Response — ответ элемента

Авторизация

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

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

duplicate()

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

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

List Item — дубликат этого List Item для объединения в цепочку.

Авторизация

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

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

get Choices()

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

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

Choice[] — массив вариантов

Авторизация

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

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

get Feedback For Correct()

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

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

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

Авторизация

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

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

get Feedback For Incorrect()

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

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

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

Авторизация

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

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

get Help Text()

Получает текст справки по элементу (иногда называемый текстом описания для таких элементов макета, как Image Items , Page Break Items и Section Header Items ).

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

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

Авторизация

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

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

get Id()

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

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

Integer — идентификатор предмета

Авторизация

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

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

get Index()

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

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

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

Авторизация

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

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

get Points()

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

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

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

Авторизация

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

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

get Title()

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

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

String — заголовок или текст заголовка элемента.

Авторизация

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

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

get Type()

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

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

Item Type — тип предмета.

Авторизация

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

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

is Required()

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

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

Boolean — должен ли респондент отвечать на вопрос

Авторизация

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

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

set Choice Values(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[] массив значений выбора, которые респонденты видят в виде меток при просмотре формы

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

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

Авторизация

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

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

set Choices(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[] множество вариантов

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

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

Броски

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

Авторизация

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

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

set Feedback For Correct(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().setDisplayText('Dogs rule, cats drool.').build(),
);

Параметры

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

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

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

Авторизация

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

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

set Feedback For Incorrect(feedback)

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

Параметры

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

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

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

Авторизация

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

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

set Help Text(text)

Устанавливает текст справки для элемента (иногда называемый текстом описания для таких элементов макета, как Image Items , Page Break Items » и Section Header Items ).

Параметры

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

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

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

Авторизация

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

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

set Points(points)

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

Параметры

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

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

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

Авторизация

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

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

set Required(enabled)

Устанавливает, должен ли респондент отвечать на вопрос.

Параметры

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

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

List Item — текущий элемент (для цепочки)

Авторизация

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

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

set Title(title)

Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае Section Header Item ).

Параметры

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

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

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

Авторизация

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

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