Class FormApp

Форма приложения

Позволяет сценарию открыть существующую Form или создать новую.

// Open a form by ID.
const existingForm = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

// Create and open a form.
const newForm = FormApp.create('Form Name');

Характеристики

Свойство Тип Описание
Alignment Alignment Перечень типов выравнивания изображения.
Destination Type Destination Type Перечисление типов мест назначения, которые могут хранить ответы на формы.
Feedback Type Feedback Type Перечисление типов формы Feedbacks .
Item Type Item Type Перечисление типов формы Items .
Page Navigation Type Page Navigation Type Перечень возможных вариантов поведения при навигации по страницам.
Rating Icon Type Rating Icon Type Перечень типов Rating Icons

Методы

Метод Тип возврата Краткое описание
create(title) Form Создает и возвращает новую Form .
create(title, isPublished) Form Создает и возвращает новую Form в запрошенном состоянии публикации.
create Checkbox Grid Validation() Checkbox Grid Validation Builder Возвращает экземпляр CheckboxGridValidationBuilder, который можно использовать для установки проверки Checkbox Grid Item .
create Checkbox Validation() Checkbox Validation Builder Возвращает экземпляр CheckboxValidationBuilder, который можно использовать для установки проверки Checkbox Item .
create Feedback() Quiz Feedback Builder Возвращает экземпляр QuizFeedbackBuilder, который можно использовать для установки отзыва об оцениваемом Item .
create Grid Validation() Grid Validation Builder Возвращает экземпляр GridValidationBuilder, который можно использовать для установки проверки Grid Item .
create Paragraph Text Validation() Paragraph Text Validation Builder Возвращает экземпляр ParagraphTextValidationBuilder, который можно использовать для установки проверки Paragraph Text Item .
create Text Validation() Text Validation Builder Возвращает экземпляр TextValidationBuilder, который можно использовать для установки проверки Text Item .
get Active Form() Form Возвращает форму, к которой скрипт привязан к контейнеру .
get Ui() Ui Возвращает экземпляр среды пользовательского интерфейса редактора форм, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели.
open By Id(id) Form Возвращает Form с указанным идентификатором.
open By Url(url) Form Возвращает Form с указанным URL-адресом.

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

create(title)

Создает и возвращает новую Form . Выдает исключение, если заданный заголовок имеет значение null или пуст.

// Create and open a form.
const form = FormApp.create('Form Name');

Параметры

Имя Тип Описание
title String Имя новой формы.

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

Form — Новая форма.

Броски

Error — если данный заголовок имеет значение null или пуст.

Авторизация

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

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

create(title, isPublished)

Создает и возвращает новую Form в запрошенном состоянии публикации. Выдает исключение, если заданный заголовок имеет значение null или пуст.

// Create, publish and open a form.
const form = FormApp.create('Form Name', true);

Параметры

Имя Тип Описание
title String Имя новой формы.
is Published Boolean Следует ли публиковать форму.

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

Form — Новая форма.

Броски

Error — если данный заголовок имеет значение null или пуст.

Авторизация

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

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

create Checkbox Grid Validation()

Возвращает экземпляр CheckboxGridValidationBuilder, который можно использовать для установки проверки Checkbox Grid Item .

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

Checkbox Grid Validation Builder

create Checkbox Validation()

Возвращает экземпляр CheckboxValidationBuilder, который можно использовать для установки проверки Checkbox Item .

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

Checkbox Validation Builder

create Feedback()

Возвращает экземпляр QuizFeedbackBuilder, который можно использовать для установки отзыва об оцениваемом Item .

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

Quiz Feedback Builder

create Grid Validation()

Возвращает экземпляр GridValidationBuilder, который можно использовать для установки проверки Grid Item .

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

Grid Validation Builder

create Paragraph Text Validation()

Возвращает экземпляр ParagraphTextValidationBuilder, который можно использовать для установки проверки Paragraph Text Item .

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

Paragraph Text Validation Builder

create Text Validation()

Возвращает экземпляр TextValidationBuilder, который можно использовать для установки проверки Text Item .

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

Text Validation Builder

get Active Form()

Возвращает форму, к которой скрипт привязан к контейнеру . Чтобы взаимодействовать с формами, к которым скрипт не привязан к контейнеру, используйте вместо этого open By Id(id) или open By Url(url) .

// Get the form to which this script is bound.
const form = FormApp.getActiveForm();

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

Form — форма, к которой привязан скрипт, или null если скрипт не привязан к форме.

Авторизация

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

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

get Ui()

Возвращает экземпляр среды пользовательского интерфейса редактора форм, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели. Сценарий может взаимодействовать только с пользовательским интерфейсом текущего экземпляра редактора открытой формы (а не с тем представлением, которое видит респондент), и только если сценарий привязан к форме. Дополнительную информацию см. в руководствах по меню , диалоговым окнам и боковым панелям .

// Add a custom menu to the active form, including a separator and a sub-menu.
function onOpen(e) {
  FormApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          FormApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

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

Ui — экземпляр среды пользовательского интерфейса этой формы.

open By Id(id)

Возвращает Form с указанным идентификатором. Выдает исключение, если идентификатор недействителен или у пользователя нет разрешения на открытие формы.

// Open a form by ID.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');

Параметры

Имя Тип Описание
id String идентификатор формы, которую нужно открыть

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

Form — форма с заданным идентификатором

Броски

Error — если указанный идентификатор недействителен или у пользователя недостаточно прав.

Авторизация

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

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

open By Url(url)

Возвращает Form с указанным URL-адресом. Выдает исключение, если URL-адрес недействителен или у пользователя нет разрешения на открытие формы.

// Open a form by URL.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

Параметры

Имя Тип Описание
url String URL-адрес формы, которую нужно открыть

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

Form — форма с заданным URL

Броски

Error — если указанный URL-адрес недействителен или у пользователя недостаточно прав.

Авторизация

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

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