Interface Item

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Вещь

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

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

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

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

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

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

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

Методы

Метод Тип возврата Краткое описание
asCheckboxGridItem() CheckboxGridItem Возвращает элемент как элемент сетки флажка.
asCheckboxItem() CheckboxItem Возвращает элемент как элемент флажка.
asDateItem() DateItem Возвращает элемент как элемент даты.
asDateTimeItem() DateTimeItem Возвращает элемент как элемент даты и времени.
asDurationItem() DurationItem Возвращает элемент как элемент длительности.
asGridItem() GridItem Возвращает элемент как элемент сетки.
asImageItem() ImageItem Возвращает элемент как элемент изображения.
asListItem() ListItem Возвращает элемент как элемент списка.
asMultipleChoiceItem() MultipleChoiceItem Возвращает элемент как элемент с множественным выбором.
asPageBreakItem() PageBreakItem Возвращает элемент как элемент разрыва страницы.
asParagraphTextItem() ParagraphTextItem Возвращает элемент как текстовый элемент абзаца.
asScaleItem() ScaleItem Возвращает элемент как элемент шкалы.
asSectionHeaderItem() SectionHeaderItem Возвращает элемент как элемент заголовка раздела.
asTextItem() TextItem Возвращает элемент как текстовый элемент.
asTimeItem() TimeItem Возвращает элемент как элемент времени.
asVideoItem() VideoItem Возвращает элемент как элемент видео.
duplicate() Item Создает копию этого элемента и добавляет ее в конец формы.
getHelpText() String Получает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ).
getId() Integer Получает уникальный идентификатор элемента.
getIndex() Integer Получает индекс элемента среди всех элементов в форме.
getTitle() String Получает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ).
getType() ItemType Получает тип элемента, представленный как ItemType .
setHelpText(text) Item Задает текст справки элемента (иногда называемый текстом описания для таких элементов макета, как ImageItems , PageBreakItems и SectionHeaderItems ).
setTitle(title) Item Устанавливает заголовок элемента (иногда называемый текстом заголовка, в случае SectionHeaderItem ).

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

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

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