Interface Item

Элемент

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

Для работы со свойствами, специфичными для типа, используйте getType() , чтобы проверить ItemType элемента, а затем приведите элемент к соответствующему классу, используя такой метод, как asCheckboxItem() .

// Create a new form and add a text item.
const form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
const items = form.getItems();
const item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() === 'TEXT') {
  const textItem = item.asTextItem();
  textItem.setRequired(false);
}

Реализация классов

Имя Краткое описание

Методы

Метод Тип возвращаемого значения Краткое описание
as Checkbox Grid Item() Checkbox Grid Item Возвращает элемент в виде сетки с флажками.
as Checkbox Item() Checkbox Item Возвращает элемент в виде флажка.
as Date Item() Date Item Возвращает элемент в виде даты.
as Date Time Item() Date Time Item Возвращает элемент в формате даты и времени.
as Duration Item() Duration Item Возвращает элемент в виде значения продолжительности.
as Grid Item() Grid Item Возвращает элемент в виде сетки.
as Image Item() Image Item Возвращает элемент в виде изображения.
as List Item() List Item Возвращает элемент в виде списка.
as Multiple Choice Item() Multiple Choice Item Возвращает элемент в виде варианта ответа с несколькими вариантами.
as Page Break Item() Page Break Item Возвращает элемент в качестве элемента разрыва страницы.
as Paragraph Text Item() Paragraph Text Item Возвращает элемент в виде текстового абзаца.
as Rating Item() Rating Item Возвращает элемент в виде рейтингового списка.
as Scale Item() Scale Item Возвращает элемент в виде масштабируемого объекта.
as Section Header Item() Section Header Item Возвращает элемент в качестве заголовка раздела.
as Text Item() Text Item Возвращает элемент в текстовом виде.
as Time Item() Time Item Возвращает элемент в виде временного значения.
as Video Item() Video Item Возвращает элемент в виде видеофайла.
duplicate() Item Создает копию этого элемента и добавляет ее в конец формы.
get Help Text() String Получает справочный текст элемента (иногда называемый описательным текстом для элементов макета, таких как Image Items , Page Break Items и Section Header Items ).
get Id() Integer Получает уникальный идентификатор элемента.
get Index() Integer Получает индекс элемента среди всех элементов в форме.
get Title() String Получает заголовок элемента (иногда называемый текстом заголовка, в случае Section Header Item ).
get Type() Item Type Получает тип элемента, представленный в виде Item Type .
set Help Text(text) Item Задает текст справки для элемента (иногда называемый текстом описания для элементов макета, таких как Image Items , Page Break Items и Section Header Items ).
set Title(title) Item Задает заголовок элемента (иногда называемый текстом заголовка, в случае Section Header Item ).

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

asCheckboxGridItem()

Возвращает элемент в виде сетки с флажками. Генерирует исключение скрипта, если тип ItemType не был CHECKBOX_GRID .

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

CheckboxGridItem — элемент сетки в виде флажка.

Броски

Error — если элемент не является элементом сетки с флажками.

Авторизация

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

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

asCheckboxItem()

Возвращает элемент в виде флажка. Генерирует исключение скрипта, если тип ItemType еще не был CHECKBOX .

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

CheckboxItem — элемент флажка

Броски

Error — если элемент не является флажком.

Авторизация

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

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

asDateItem()

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

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

DateItem — элемент даты

Броски

Error — если элемент не является элементом типа «дата».

Авторизация

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

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

asDateTimeItem()

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

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

DateTimeItem — элемент даты и времени

Броски

Error — если элемент не является элементом даты и времени.

Авторизация

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

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

asDurationItem()

Возвращает элемент в виде значения длительности. Генерирует исключение скрипта, если ItemType не был DURATION .

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

DurationItem — элемент продолжительности

Броски

Error — если элемент не является элементом, определяющим продолжительность.

Авторизация

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

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

asGridItem()

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

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

GridItem — элемент сетки

Броски

Error — если элемент не является элементом сетки.

Авторизация

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

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

asImageItem()

Возвращает элемент в виде изображения. Генерирует исключение скрипта, если ItemType не был IMAGE .

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

ImageItem — элемент изображения

Броски

Error — если элемент не является изображением.

asListItem()

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

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

ListItem — элемент списка

Броски

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

Авторизация

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

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

asMultipleChoiceItem()

Возвращает элемент в виде варианта с несколькими вариантами ответа. Генерирует исключение скрипта, если ItemType еще не был MULTIPLE_CHOICE .

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

MultipleChoiceItem — вопрос с несколькими вариантами ответа

Броски

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

Авторизация

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

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

asPageBreakItem()

Возвращает элемент в качестве элемента разрыва страницы. Генерирует исключение скрипта, если ItemType еще не был PAGE_BREAK .

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

PageBreakItem — элемент разрыва страницы

Броски

Error — если элемент не является элементом разрыва страницы.

Авторизация

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

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

asParagraphTextItem()

Возвращает элемент в виде текстового абзаца. Генерирует исключение скрипта, если ItemType еще не был PARAGRAPH_TEXT .

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

ParagraphTextItem — элемент текста абзаца

Броски

Error — если элемент не является текстовым элементом абзаца.

Авторизация

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

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

asRatingItem()

Возвращает элемент в виде рейтингового объекта. Генерирует исключение ScriptingException, если ItemType еще не был RATING .

// Opens the Forms file by its URL. If you created your script from within a
// Google Forms file, you can use FormApp.getActiveForm() instead.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl('https://docs.google.com/forms/d/abc123456/edit');

// Fetch any item which is of type rating.
const item = form.getItems(FormApp.ItemType.RATING)[0];

// Convert the item to a rating item.
const ratingItem = item.asRatingItem();

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

RatingItem — элемент, за который выставляется оценка.

Броски

Error — если элемент не является элементом оценки.

Авторизация

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

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

asScaleItem()

Возвращает элемент в виде масштабируемого объекта. Генерирует исключение скрипта, если ItemType еще не был SCALE .

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

ScaleItem — элемент шкалы

Броски

Error — если элемент не относится к весовым элементам.

Авторизация

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

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

asSectionHeaderItem()

Возвращает элемент в виде заголовка раздела. Генерирует исключение скрипта, если ItemType еще не был SECTION_HEADER .

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

SectionHeaderItem — элемент заголовка раздела

Броски

Error — если элемент не является заголовком раздела.

Авторизация

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

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

asTextItem()

Возвращает элемент в текстовом формате. Генерирует исключение скрипта, если ItemType еще не был TEXT .

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

TextItem — текстовый элемент

Броски

Error — если элемент не является текстовым элементом.

Авторизация

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

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

asTimeItem()

Возвращает элемент в виде временного значения. Генерирует исключение скрипта, если ItemType еще не был TIME .

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

TimeItem — временной элемент

Броски

Error — если элемент не является временным элементом.

Авторизация

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

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

asVideoItem()

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

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

VideoItem — видеоэлемент

Броски

Error — если элемент не является видеоэлементом

duplicate()

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

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

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

Авторизация

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

  • 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

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

setHelpText(text)

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

Параметры

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

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

Item — этот Item , для соединения в цепочку.

Авторизация

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

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

setTitle(title)

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

Параметры

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

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

Item — этот Item , для соединения в цепочку.

Авторизация

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

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