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