Interface Item

Элемент

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

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

// 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 ).

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

as Checkbox Grid Item()

Возвращает элемент в виде элемента сетки флажка. Вызывает исключение скрипта, если Item Type ещё не CHECKBOX_GRID .

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

Checkbox Grid Item — элемент сетки флажка

Броски

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

Авторизация

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

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

as Checkbox Item()

Возвращает элемент как флажок. Вызывает исключение скрипта, если Item Type ещё не CHECKBOX .

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

Checkbox Item — элемент флажка

Броски

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

Авторизация

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

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

as Date Item()

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

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

Date Item — элемент даты

Броски

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

Авторизация

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

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

as Date Time Item()

Возвращает элемент как элемент даты и времени. Вызывает исключение скрипта, если Item Type ещё не DATETIME .

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

Date Time Item — элемент даты и времени

Броски

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

Авторизация

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

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

as Duration Item()

Возвращает элемент как элемент длительности. Вызывает исключение скрипта, если Item Type ещё не DURATION .

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

Duration Item — элемент длительности

Броски

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

Авторизация

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

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

as Grid Item()

Возвращает элемент как элемент сетки. Вызывает исключение скрипта, если Item Type ещё не GRID .

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

Grid Item — элемент сетки

Броски

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

Авторизация

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

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

as Image Item()

Возвращает элемент как изображение. Вызывает исключение скрипта, если Item Type не был IMAGE .

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

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

Броски

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

as List Item()

Возвращает элемент как элемент списка. Вызывает исключение скрипта, если Item Type ещё не LIST .

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

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

Броски

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

Авторизация

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

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

as Multiple Choice Item()

Возвращает элемент как элемент с множественным выбором. Вызывает исключение скрипта, если Item Type ещё не был MULTIPLE_CHOICE .

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

Multiple Choice Item — задание с множественным выбором

Броски

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

Авторизация

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

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

as Page Break Item()

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

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

Page Break Item — элемент разрыва страницы

Броски

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

Авторизация

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

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

as Paragraph Text Item()

Возвращает элемент как текстовый абзац. Вызывает исключение скрипта, если Item Type ещё не был PARAGRAPH_TEXT .

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

Paragraph Text Item — элемент текста абзаца

Броски

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

Авторизация

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

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

as Rating Item()

Возвращает элемент как элемент рейтинга. Вызывает исключение ScriptingException, если Item Type ещё не равен 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();

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

Rating Item — элемент рейтинга.

Броски

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

Авторизация

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

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

as Scale Item()

Возвращает элемент как элемент масштаба. Вызывает исключение скрипта, если Item Type ещё не SCALE .

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

Scale Item — элемент шкалы

Броски

Error — если предмет не является предметом шкалы

Авторизация

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

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

as Section Header Item()

Возвращает элемент как заголовок раздела. Вызывает исключение скрипта, если Item Type ещё не SECTION_HEADER .

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

Section Header Item — элемент заголовка раздела

Броски

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

Авторизация

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

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

as Text Item()

Возвращает элемент как текстовый элемент. Вызывает исключение скрипта, если Item Type ещё не был TEXT .

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

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

Броски

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

Авторизация

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

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

as Time Item()

Возвращает элемент как элемент времени. Вызывает исключение скрипта, если Item Type ещё не был TIME .

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

Time Item — элемент времени

Броски

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

Авторизация

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

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

as Video Item()

Возвращает элемент как видеоэлемент. Вызывает исключение скрипта, если Item Type не был VIDEO .

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

Video Item — видео элемент

Броски

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

duplicate()

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

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

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

Авторизация

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

  • 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 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

set Help Text(text)

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

Параметры

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

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

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

Авторизация

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

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

set Title(title)

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

Параметры

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

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

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

Авторизация

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

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