Class CheckboxItem

CheckboxItem

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

// 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 |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 .
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 Указывает, есть ли у товара опция "другое".

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

clearValidation()

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

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

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

Авторизация

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

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

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

createResponse(responses)

Создает новый объект ItemResponse для этого флажка. Аргумент responses представляет собой массив String[] , содержащий значения, которые необходимо отметить. Генерирует исключение, если какое-либо значение не соответствует допустимому выбору для этого элемента, за исключением случаев, когда showOtherOption(enabled) установлено в true .

Параметры

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

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

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

Авторизация

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

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

duplicate()

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

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

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

Авторизация

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

  • 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

hasOtherOption()

Определяет, есть ли у товара вариант "другое".

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

Booleantrue если у элемента есть вариант "другое"; false если нет.

Авторизация

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

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

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

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

Авторизация

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

  • 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[] множество вариантов выбора

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

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

Броски

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 очистит обратную связь.

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

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

Авторизация

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

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

setFeedbackForIncorrect(feedback)

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

Параметры

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

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

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

Авторизация

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

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

setHelpText(text)

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

Параметры

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

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

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

Авторизация

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

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

setPoints(points)

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

Параметры

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

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

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

Авторизация

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

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

setRequired(enabled)

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

Параметры

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

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

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

Авторизация

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

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

setTitle(title)

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

Параметры

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

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

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

Авторизация

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

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

setValidation(validation)

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

Параметры

Имя Тип Описание
validation Checkbox Validation Проверка состояния (CheckboxValidation), применяемая к этому элементу.

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

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

Авторизация

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

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

showOtherOption(enabled)

Определяет, есть ли у элемента вариант "другое". Значение по умолчанию для нового элемента CheckboxItem или MultipleChoiceItemfalse .

Параметры

Имя Тип Описание
enabled Boolean true если у товара есть вариант "другое"; false если нет.

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

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

Авторизация

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

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