Class CheckboxItem

Элемент флажка

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

// Open a form by ID and add a new checkbox item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?')
    .setChoices([
      item.createChoice('Ketchup'),
      item.createChoice('Mustard'),
      item.createChoice('Relish'),
    ])
    .showOtherOption(true);

Методы

Метод Тип возврата Краткое описание
clear Validation() Checkbox Item Удаляет любую проверку данных для этого элемента флажка.
create Choice(value) Choice Создает новый выбор.
create Choice(value, isCorrect) Choice Создает новый выбор.
create Response(responses) Item Response Создает новый Item Response для этого элемента флажка.
duplicate() Checkbox 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 .
has Other Option() Boolean Определяет, есть ли у элемента опция «другое».
is Required() Boolean Определяет, должен ли респондент отвечать на вопрос.
set Choice Values(values) Checkbox Item Устанавливает варианты выбора для элемента из массива строк.
set Choices(choices) Checkbox Item Устанавливает массив вариантов для элемента.
set Feedback For Correct(feedback) Checkbox Item Устанавливает обратную связь, которая будет отображаться респондентам, когда они правильно ответят на вопрос.
set Feedback For Incorrect(feedback) Checkbox Item Устанавливает обратную связь, которая будет отображаться респондентам, когда они неправильно отвечают на вопрос.
set Help Text(text) Checkbox Item Устанавливает текст справки для элемента (иногда называемый текстом описания для таких элементов макета, как Image Items , Page Break Items » и Section Header Items ).
set Points(points) Checkbox Item Устанавливает количество баллов, которое дает оцениваемый предмет.
set Required(enabled) Checkbox Item Устанавливает, должен ли респондент отвечать на вопрос.
set Title(title) Checkbox Item Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае Section Header Item ).
set Validation(validation) Checkbox Item Устанавливает проверку данных для этого элемента флажка.
show Other Option(enabled) Checkbox Item Устанавливает, имеет ли элемент опцию «другое».

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

clear Validation()

Удаляет любую проверку данных для этого элемента флажка.

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

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

Авторизация

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

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

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 Response(responses)

Создает новый Item Response для этого элемента флажка. responses на аргументы представляют собой массив String[] содержащий значения, которые необходимо проверить. Выдает исключение, если какое-либо значение не соответствует допустимому выбору для этого элемента, если только для show Other Option(enabled) не установлено значение true .

Параметры

Имя Тип Описание
responses String[] массив допустимых ответов для этого элемента с множественным выбором

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

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

Авторизация

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

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

duplicate()

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

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

Checkbox Item — дубликат этого Checkbox 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

has Other Option()

Определяет, есть ли у элемента опция «другое».

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

Boolean — true , если у элемента есть опция «другой»; false если нет

Авторизация

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

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

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

Checkbox Item — этот Checkbox 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[] множество вариантов

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

Checkbox Item — этот Checkbox 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 новый отзыв. Нулевое значение очистит обратную связь.

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

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

Авторизация

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

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

set Feedback For Incorrect(feedback)

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

Параметры

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

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

Checkbox Item — этот Checkbox 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 новый текст справки

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

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

Авторизация

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

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

set Points(points)

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

Параметры

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

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

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

Авторизация

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

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

set Required(enabled)

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

Параметры

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

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

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

Авторизация

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

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

set Title(title)

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

Параметры

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

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

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

Авторизация

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

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

set Validation(validation)

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

Параметры

Имя Тип Описание
validation Checkbox Validation CheckboxValidation для применения к этому элементу.

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

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

Авторизация

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

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

show Other Option(enabled)

Устанавливает, имеет ли элемент опцию «другое». По умолчанию для нового Checkbox Item или Multiple Choice Item установлено false .

Параметры

Имя Тип Описание
enabled Boolean true если у элемента есть опция «другой»; false если нет

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

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

Авторизация

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

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