Эта страница переведена с помощью Cloud Translation API.

Class FormApp

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

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

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

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

Свойство	Тип	Описание
`Alignment`	`Alignment`	Перечень типов выравнивания изображения.
`DestinationType`	`DestinationType`	Перечисление типов мест назначения, которые могут хранить ответы на формы.
`FeedbackType`	`FeedbackType`	Перечисление типов формы `Feedbacks` .
`ItemType`	`ItemType`	Перечисление типов формы `Items` .
`PageNavigationType`	`PageNavigationType`	Перечень возможных вариантов поведения при навигации по страницам.

Методы

Метод	Тип возврата	Краткое описание
`create(title)`	`Form`	Создает и возвращает новую `Form` .
`createCheckboxGridValidation()`	`CheckboxGridValidationBuilder`	Возвращает экземпляр CheckboxGridValidationBuilder, который можно использовать для установки проверки `CheckboxGridItem` .
`createCheckboxValidation()`	`CheckboxValidationBuilder`	Возвращает экземпляр CheckboxValidationBuilder, который можно использовать для установки проверки `CheckboxItem` .
`createFeedback()`	`QuizFeedbackBuilder`	Возвращает экземпляр QuizFeedbackBuilder, который можно использовать для установки отзыва об оцениваемом `Item` .
`createGridValidation()`	`GridValidationBuilder`	Возвращает экземпляр GridValidationBuilder, который можно использовать для установки проверки `GridItem` .
`createParagraphTextValidation()`	`ParagraphTextValidationBuilder`	Возвращает экземпляр ParagraphTextValidationBuilder, который можно использовать для установки проверки `ParagraphTextItem` .
`createTextValidation()`	`TextValidationBuilder`	Возвращает экземпляр TextValidationBuilder, который можно использовать для установки проверки `TextItem` .
`getActiveForm()`	`Form`	Возвращает форму, к которой скрипт привязан к контейнеру .
`getUi()`	`Ui`	Возвращает экземпляр среды пользовательского интерфейса редактора форм, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели.
`openById(id)`	`Form`	Возвращает `Form` с указанным идентификатором.
`openByUrl(url)`	`Form`	Возвращает `Form` с указанным URL-адресом.

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

`create(title)`

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

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

Параметры

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

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

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.
var 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 с указанным идентификатором. Выдает исключение, если идентификатор недействителен или у пользователя нет разрешения на открытие формы.

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

Параметры

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

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

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

Броски

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

Авторизация

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

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

`openByUrl(url)`

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

// Open a form by URL.
var 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