Class FormApp

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

createCheckboxGridValidation()

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

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

CheckboxGridValidationBuilder

createCheckboxValidation()

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

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

CheckboxValidationBuilder

createFeedback()

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

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

QuizFeedbackBuilder

createGridValidation()

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

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

GridValidationBuilder

createParagraphTextValidation()

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

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

ParagraphTextValidationBuilder

createTextValidation()

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

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

TextValidationBuilder

getActiveForm()

Возвращает форму, к которой привязан скрипт. Для взаимодействия с формами, к которым скрипт не привязан, используйте openById(id) или openByUrl(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

getUi()

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

// 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 — экземпляр пользовательского интерфейса данной формы.

openById(id)

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

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

Параметры

Имя Тип Описание
id String Идентификатор формы для открытия

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

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

Броски

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

Авторизация

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

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

openByUrl(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