Class Form

Форма

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

// Open a form by ID and create a new spreadsheet.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const ss = SpreadsheetApp.create('Spreadsheet Name');

// Update form properties via chaining.
form.setTitle('Form Name')
    .setDescription('Description of form')
    .setConfirmationMessage('Thanks for responding!')
    .setAllowResponseEdits(true)
    .setAcceptingResponses(false);

// Update the form's response destination.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

Методы

Метод Тип возврата Краткое описание
add Checkbox Grid Item() Checkbox Grid Item Добавляет новый элемент вопроса, представленный в виде сетки столбцов и строк, который позволяет респонденту выбирать несколько вариантов ответа в каждой строке из последовательности флажков.
add Checkbox Item() Checkbox Item Добавляет новый элемент вопроса, который позволяет респонденту выбрать один или несколько флажков, а также необязательное поле «Другое».
add Date Item() Date Item Добавляет новый элемент вопроса, который позволяет респонденту указать дату.
add Date Time Item() Date Time Item Добавляет новый элемент вопроса, который позволяет респонденту указать дату и время.
add Duration Item() Duration Item Добавляет новый элемент вопроса, который позволяет респонденту указать промежуток времени.
add Editor(emailAddress) Form Добавляет данного пользователя в список редакторов Form .
add Editor(user) Form Добавляет данного пользователя в список редакторов Form .
add Editors(emailAddresses) Form Добавляет заданный массив пользователей в список редакторов Form .
add Grid Item() Grid Item Добавляет новый элемент вопроса, представленный в виде сетки столбцов и строк, который позволяет респонденту выбрать один вариант ответа в каждой строке из последовательности переключателей.
add Image Item() Image Item Добавляет новый элемент макета, отображающий изображение.
add List Item() List Item Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из раскрывающегося списка.
add Multiple Choice Item() Multiple Choice Item Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из списка переключателей или необязательного поля «другое».
add Page Break Item() Page Break Item Добавляет новый элемент макета, который отмечает начало страницы.
add Paragraph Text Item() Paragraph Text Item Добавляет новый элемент вопроса, который позволяет респонденту ввести блок текста.
add Rating Item() Rating Item Добавляет новый элемент вопроса, который позволяет респонденту поставить оценку.
add Scale Item() Scale Item Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из пронумерованной последовательности переключателей.
add Section Header Item() Section Header Item Добавляет новый элемент макета, который визуально указывает начало раздела.
add Text Item() Text Item Добавляет новый элемент вопроса, который позволяет респонденту ввести одну строку текста.
add Time Item() Time Item Добавляет новый элемент вопроса, который позволяет респонденту указать время суток.
add Video Item() Video Item Добавляет новый элемент макета, отображающий видео.
can Edit Response() Boolean Определяет, отображает ли форма ссылку для редактирования ответа после его отправки.
collects Email() Boolean Определяет, собирает ли форма адреса электронной почты респондентов.
create Response() Form Response Создает новый ответ на форму.
delete All Responses() Form Удаляет все отправленные ответы из хранилища ответов формы.
delete Item(index) void Удаляет элемент по заданному индексу среди всех элементов формы.
delete Item(item) void Удаляет данный элемент.
delete Response(responseId) Form Удаляет один ответ из хранилища ответов формы.
get Confirmation Message() String Получает сообщение подтверждения формы.
get Custom Closed Form Message() String Получает настраиваемое сообщение, которое отображается, если форма не принимает ответы, или пустую строку, если настраиваемое сообщение не задано.
get Description() String Получает описание формы.
get Destination Id() String Получает идентификатор места назначения ответа формы.
get Destination Type() Destination Type Получает тип назначения ответа формы.
get Edit Url() String Получает URL-адрес, который можно использовать для доступа к режиму редактирования формы.
get Editors() User[] Получает список редакторов для этой Form .
get Id() String Получает идентификатор формы.
get Item By Id(id) Item Получает элемент с заданным идентификатором.
get Items() Item[] Получает массив всех элементов формы.
get Items(itemType) Item[] Получает массив всех элементов заданного типа.
get Published Url() String Получает URL-адрес, который можно использовать для ответа на форму.
get Response(responseId) Form Response Получает один ответ формы на основе его идентификатора ответа.
get Responses() Form Response[] Получает массив всех ответов формы.
get Responses(timestamp) Form Response[] Получает массив всех ответов формы после заданной даты и времени.
get Shuffle Questions() Boolean Определяет, является ли порядок вопросов на каждой странице формы случайным.
get Summary Url() String Получает URL-адрес, который можно использовать для просмотра сводки ответов формы.
get Title() String Получает заголовок формы.
has Limit One Response Per User() Boolean Определяет, допускает ли форма только один ответ для каждого респондента.
has Progress Bar() Boolean Определяет, отображает ли форма индикатор выполнения.
has Respond Again Link() Boolean Определяет, отображает ли форма ссылку для отправки другого ответа после того, как респондент заполнит форму.
is Accepting Responses() Boolean Определяет, принимает ли форма в данный момент ответы.
is Publishing Summary() Boolean Определяет, отображает ли форма ссылку для просмотра сводки ответов после того, как респондент заполнит форму.
is Quiz() Boolean Определяет, является ли форма тестом.
move Item(from, to) Item Перемещает элемент по заданному индексу среди всех элементов формы в другой заданный индекс.
move Item(item, toIndex) Item Перемещает заданный элемент в заданный индекс среди всех элементов формы.
remove Destination() Form Отключает форму от текущего места назначения ответа.
remove Editor(emailAddress) Form Удаляет данного пользователя из списка редакторов Form .
remove Editor(user) Form Удаляет данного пользователя из списка редакторов Form .
set Accepting Responses(enabled) Form Устанавливает, принимает ли форма в данный момент ответы.
set Allow Response Edits(enabled) Form Определяет, отображает ли форма ссылку для редактирования ответа после его отправки.
set Collect Email(collect) Form Определяет, собирает ли форма адреса электронной почты респондентов.
set Confirmation Message(message) Form Устанавливает сообщение подтверждения формы.
set Custom Closed Form Message(message) Form Устанавливает сообщение, которое будет отображаться, если форма не принимает ответы.
set Description(description) Form Устанавливает описание формы.
set Destination(type, id) Form Устанавливает место назначения, в котором сохраняются ответы формы.
set Is Quiz(enabled) Form Устанавливает, является ли форма тестом.
set Limit One Response Per User(enabled) Form Устанавливает, допускает ли форма только один ответ для каждого респондента.
set Progress Bar(enabled) Form Устанавливает, имеет ли форма индикатор выполнения.
set Publishing Summary(enabled) Form Определяет, отображает ли форма ссылку для просмотра сводки ответов после отправки формы респондентом.
set Show Link To Respond Again(enabled) Form Определяет, отображает ли форма ссылку для отправки другого ответа после того, как респондент заполнит форму.
set Shuffle Questions(shuffle) Form Определяет, является ли порядок вопросов на каждой странице формы случайным.
set Title(title) Form Устанавливает заголовок формы.
shorten Form Url(url) String Преобразует длинный URL-адрес формы в короткий URL-адрес.
submit Grades(responses) Form Отправляет оценки за заданные ответы FormResponse.

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

add Checkbox Grid Item()

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

// 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',
);

// Adds a checkbox grid item.
const item = form.addCheckboxGridItem();

item.setTitle('Where did you celebrate New Year\'s?');

// Sets the grid's rows and columns.
item.setRows(['New York', 'San Francisco', 'London']).setColumns([
  '2014', '2015', '2016', '2017'
]);

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

Checkbox Grid Item — вновь созданный элемент.

Авторизация

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

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

add Checkbox Item()

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

// 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',
);

// Adds a checkbox item.
const item = form.addCheckboxItem();

// Sets the title of the checkbox item to 'Do you prefer cats or dogs?'
item.setTitle('Do you prefer cats or dogs?');

// Sets the choices.
item.setChoiceValues(['Cats', 'Dogs']);

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

Checkbox Item — вновь созданный элемент.

Авторизация

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

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

add Date Item()

Добавляет новый элемент вопроса, который позволяет респонденту указать дату.

// 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',
);

// Adds a date item.
const item = form.addDateItem();

// Sets the title to 'When were you born?'
item.setTitle('When were you born?');

// Sets the description for the date item.
item.setHelpText('Some helper text.');

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

Date Item — вновь созданный элемент.

Авторизация

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

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

add Date Time Item()

Добавляет новый элемент вопроса, который позволяет респонденту указать дату и время.

// 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',
);

// Adds a question with date and time inputs.
const item = form.addDateTimeItem();

// Sets the title to 'When were you born?'
item.setTitle('When were you born?');

// Sets the question as required.
item.setRequired(true);

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

Date Time Item — вновь созданный элемент.

Авторизация

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

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

add Duration Item()

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

// 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',
);

// Adds a question with a duration input.
const item = form.addDurationItem();

// Sets the title to 'How long can you hold your breath?'
item.setTitle('How long can you hold your breath?');

// Sets the question as required.
item.setRequired(true);

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

Duration Item — вновь созданный элемент.

Авторизация

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

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

add Editor(emailAddress)

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

Параметры

Имя Тип Описание
email Address String Адрес электронной почты пользователя, которого необходимо добавить.

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

Form — Эта Form для связывания.

Авторизация

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

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

add Editor(user)

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

Параметры

Имя Тип Описание
user User Представление добавляемого пользователя.

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

Form — Эта Form для связывания.

Авторизация

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

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

add Editors(emailAddresses)

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

Параметры

Имя Тип Описание
email Addresses String[] Массив адресов электронной почты пользователей, которых нужно добавить.

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

Form — Эта Form для связывания.

Авторизация

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

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

add Grid Item()

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

// 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',
);

// Adds a multiple choice grid.
const item = form.addGridItem();

// Sets the title to 'Rate your interests.'
item.setTitle('Rate your interests');

// Sets the grid's rows and columns.
item.setRows(['Cars', 'Computers', 'Celebrities']).setColumns([
  'Boring', 'So-so', 'Interesting'
]);

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

Grid Item — вновь созданный элемент.

Авторизация

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

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

add Image Item()

Добавляет новый элемент макета, отображающий изображение.

// 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',
);

// Adds an image item.
const item = form.addImageItem();

// Gets the Google icon to use as the image.
const img = UrlFetchApp.fetch(
    'https://fonts.gstatic.com/s/i/productlogos/googleg/v6/web-24dp/logo_googleg_color_1x_web_24dp.png',
);

// Sets the image, title, and description for the item.
item.setTitle('Google icon').setHelpText('Google icon').setImage(img);

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

Image Item — вновь созданный элемент.

Авторизация

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

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

add List Item()

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

// 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',
);

// Adds a dropdown list to the form.
const item = form.addListItem();

// Sets the title to 'Do you prefer cats or dogs?'
item.setTitle('Do you prefer cats or dogs?');

// Sets the description to 'This is description text...'
item.setHelpText('This is description text...');

// Creates and adds choices to the dropdown list.
item.setChoices([item.createChoice('dog'), item.createChoice('cat')]);

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

List Item — вновь созданный элемент.

Авторизация

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

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

add Multiple Choice Item()

Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из списка переключателей или необязательного поля «другое».

// 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',
);

// Adds a multiple choice item to the form.
const item = form.addMultipleChoiceItem();

// Sets the title.
item.setTitle('What is your favorite ice cream flavor?');

// Creates some choice items.
const vanilla = item.createChoice('vanilla');
const chocolate = item.createChoice('chocolate');
const strawberry = item.createChoice('strawberry');

// Sets the choices.
item.setChoices([vanilla, chocolate, strawberry]);

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

Multiple Choice Item — вновь созданный элемент.

Авторизация

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

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

add Page Break Item()

Добавляет новый элемент макета, который отмечает начало страницы.

// 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',
);

// Adds page break items to create a second and third page for the form.
const pageTwo = form.addPageBreakItem();
const pageThree = form.addPageBreakItem();

// Sets the titles for the pages.
pageTwo.setTitle('Page two');
pageThree.setTitle('Page three');

// Upon completion of the first page, sets the form to navigate to the third
// page.
pageTwo.setGoToPage(pageThree);

// Upon completion of the second page, sets the form to navigate back to the
// first page.
pageThree.setGoToPage(FormApp.PageNavigationType.RESTART);

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

Page Break Item — вновь созданный элемент.

Авторизация

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

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

add Paragraph Text Item()

Добавляет новый элемент вопроса, который позволяет респонденту ввести блок текста.

// Opens the form 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',
);

// Adds the paragraph text item.
const item = form.addParagraphTextItem();

// Sets the title to 'What is your address?'
item.setTitle('What is your address?');

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

Paragraph Text Item — вновь созданный элемент.

Авторизация

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

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

add Rating Item()

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

// 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',
);

// Adds the rating item.
const item = form.addRatingItem();

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

Rating Item — вновь созданный элемент.

Авторизация

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

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

add Scale Item()

Добавляет новый элемент вопроса, который позволяет респонденту выбрать один вариант из пронумерованной последовательности переключателей.

// 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',
);

// Adds the scale item.
const item = form.addScaleItem();

// Sets the title of the scale item to 'Choose a number.'
item.setTitle('Choose a number');

// Sets the scale to 1-5.
item.setBounds(1, 5);

// Sets the label for the lower and upper bounds.
item.setLabels('Lowest', 'Highest');

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

Scale Item — вновь созданный элемент.

Авторизация

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

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

add Section Header Item()

Добавляет новый элемент макета, который визуально указывает начало раздела.

// 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',
);

// Adds the section heading item.
const item = form.addSectionHeaderItem();

// Sets the title to 'Title of new section.'
item.setTitle('Title of new section');

// Sets the description.
item.setHelpText('Description of new section');

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

Section Header Item — вновь созданный элемент.

Авторизация

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

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

add Text Item()

Добавляет новый элемент вопроса, который позволяет респонденту ввести одну строку текста.

// 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',
);

// Adds a single-line text item.
const item = form.addTextItem();

// Sets the title to 'What is your name?'
item.setTitle('What is your name?');

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

Text Item — вновь созданный элемент.

Авторизация

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

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

add Time Item()

Добавляет новый элемент вопроса, который позволяет респонденту указать время суток.

// 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',
);

// Adds a question with a time input.
const item = form.addTimeItem();

// Sets the title to 'What time do you usually wake up in the morning?'
item.setTitle('What time do you usually wake up in the morning?');

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

Time Item — вновь созданный элемент.

Авторизация

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

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

add Video Item()

Добавляет новый элемент макета, отображающий видео.

// 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',
);

// Adds a video item.
const item = form.addVideoItem();

// Sets the title, description, and video.
item.setTitle('YouTube video')
    .setHelpText('Send content automatically via Google Sheets and Apps Script')
    .setVideoUrl('https://youtu.be/xxgQr-jSu9o');

// Sets the alignment to the center.
item.setAlignment(FormApp.Alignment.CENTER);

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

Video Item — вновь созданный элемент.

Авторизация

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

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

can Edit Response()

Определяет, отображает ли форма ссылку для редактирования ответа после его отправки.

Независимо от этого параметра, метод Form Response.getEditResponseUrl() позволяет автору сценария, имеющему доступ к редактированию формы, создать URL-адрес, который можно использовать для редактирования ответа.

// 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',
);

// Checks if the form displays a link to edit a response after submitting it.
// The default is false. To let people edit their responses, use
// form.setAllowResponseEdits(true).
const edit = form.canEditResponse();

// If the form doesn't let people edit responses, logs false to the console.
console.log(edit);

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

Booleantrue , если в форме отображается ссылка «Изменить ответ»; false если это не так.

Авторизация

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

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

collects Email()

Определяет, собирает ли форма адреса электронной почты респондентов.

// 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',
);

// Sets the form to not collect respondents' email addresses.
form.setCollectEmail(false);

// Checks whether the form collects respondents' email addresses and logs it to
// the console.
const bool = form.collectsEmail();

console.log(bool);

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

Booleantrue , если форма собирает адреса электронной почты; false если это не так.

Авторизация

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

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

create Response()

Создает новый ответ на форму. Чтобы ответить на элемент вопроса, создайте Item Response из элемента, а затем прикрепите его к этому ответу формы, вызвав Form Response.withItemResponse(response) . Чтобы сохранить собранный ответ, вызовите Form Response.submit() .

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

Form Response — вновь созданный ответ формы.

Авторизация

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

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

delete All Responses()

Удаляет все отправленные ответы из хранилища ответов формы. Этот метод не удаляет копии ответов, хранящиеся во внешнем месте назначения ответов (например, в электронной таблице), но очищает сводное представление формы.

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

Form — Эта Form для связывания.

Авторизация

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

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

delete Item(index)

Удаляет элемент по заданному индексу среди всех элементов формы. Выдает исключение сценария, если по данному индексу не существует элемента.

// 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',
);

// Gets all the items from the form.
const items = form.getItems();

// Finds the index of a paragraph text item and deletes it by the item's index.
const index = items.findIndex(
    (item) => item.getType() === FormApp.ItemType.PARAGRAPH_TEXT,
);
if (index !== -1) {
  form.deleteItem(index);
}

Параметры

Имя Тип Описание
index Integer Индекс элемента среди всех элементов формы.

Броски

Error — если по данному индексу не существует элемента

Авторизация

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

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

delete Item(item)

Удаляет данный элемент. Выдает исключение сценария, если элемент уже был удален.

// 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',
);

// Gets all of the items from the form.
const items = form.getItems();

// Finds a paragraph text item and deletes it.
const item = items.find(
    (item) => item.getType() === FormApp.ItemType.PARAGRAPH_TEXT,
);
if (item) {
  form.deleteItem(item);
}

Параметры

Имя Тип Описание
item Item Элемент, который необходимо удалить.

Броски

Error — если элемент не существует в форме

Авторизация

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

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

delete Response(responseId)

Удаляет один ответ из хранилища ответов формы. Этот метод не удаляет копии ответов, хранящиеся во внешнем месте назначения ответов (например, в электронной таблице), но удаляет ответ из сводного представления формы. Идентификатор ответа можно получить с помощью Form Response.getId() .

Параметры

Имя Тип Описание
response Id String Идентификатор ответа формы, который необходимо удалить.

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

Form — Эта Form для связывания.

Авторизация

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

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

get Confirmation Message()

Получает сообщение подтверждения формы.

// 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',
);

// Sets the confirmation message to display after someone submits the form.
form.setConfirmationMessage('You successfully submitted the form.');

// Gets the confirmation message and logs it to the console.
const message = form.getConfirmationMessage();

console.log(message);

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

String — сообщение подтверждения формы.

Авторизация

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

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

get Custom Closed Form Message()

Получает настраиваемое сообщение, которое отображается, если форма не принимает ответы, или пустую строку, если настраиваемое сообщение не задано.

// 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',
);

// Sets a custom closed form message to display to the user when the form
// no longer accepts responses.
form.setCustomClosedFormMessage('The form is no longer accepting responses.');

// Gets the custom message set for the form and logs it to the console.
const message = form.getCustomClosedFormMessage();

console.log(message);

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

String — настраиваемое сообщение, отображаемое, если форма не принимает ответы, или пустая строка, если настраиваемое сообщение не задано.

Авторизация

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

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

get Description()

Получает описание формы.

// 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',
);

// Sets the form description.
form.setDescription('This is the form description.');

// Gets the form description and logs it to the console.
const description = form.getDescription();

console.log(description);

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

String — описание формы.

Авторизация

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

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

get Destination Id()

Получает идентификатор места назначения ответа формы.

// 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',
);

// Creates a spreadsheet to use as the response destination.
const ss = SpreadsheetApp.create('Test_Spreadsheet');

// Updates the form's response destination.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

// Gets the ID of the form's response destination and logs it to the console.
const destinationId = form.getDestinationId();

console.log(destinationId);

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

String — идентификатор места назначения ответа формы.

Авторизация

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

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

get Destination Type()

Получает тип назначения ответа формы.

// 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/abc1234556/edit',
);

// Gets the type of the form's response destination and logs it to the console.
const destinationType = form.getDestinationType().name();

console.log(destinationType);

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

Destination Type — тип назначения ответа формы.

Авторизация

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

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

get Edit Url()

Получает URL-адрес, который можно использовать для доступа к режиму редактирования формы.

// Opens the form 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',
);

// Gets the URL that accesses the form's edit mode and logs it to the console.
const url = form.getEditUrl();

console.log(url);

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

String — URL-адрес для редактирования формы.

Авторизация

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

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

get Editors()

Получает список редакторов для этой Form .

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

User[] — Массив пользователей с разрешением на редактирование.

Авторизация

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

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

get Id()

Получает идентификатор формы.

// Opens the form 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',
);

// Gets the ID of the form and logs it to the console.
const id = form.getId();

console.log(id);

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

String — идентификатор формы.

Авторизация

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

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

get Item By Id(id)

Получает элемент с заданным идентификатором. Возвращает значение null , если идентификатор не соответствует элементу в форме.

// 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',
);

// Gets the ID of the first item on the form.
const itemId = form.getItems()[0].getId();

// Gets the item from the ID.
const item = form.getItemById(itemId);

// Gets the name of the item type and logs it to the console.
const type = item.getType().name();

console.log(type);

Параметры

Имя Тип Описание
id Integer Идентификатор предмета.

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

Item — элемент с заданным идентификатором или null , если элемент не существует в форме.

Авторизация

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

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

get Items()

Получает массив всех элементов формы.

// 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',
);

// Gets the list of items in the form.
const items = form.getItems();

// Gets the type for each item and logs them to the console.
const types = items.map((item) => item.getType().name());

console.log(types);

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

Item[] — Массив всех элементов формы.

Авторизация

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

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

get Items(itemType)

Получает массив всех элементов заданного типа.

// 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',
);

// Gets a list of all checkbox items on the form.
const items = form.getItems(FormApp.ItemType.CHECKBOX);

// Gets the title of each checkbox item and logs them to the console.
const checkboxItemsTitle = items.map(
    (item) => item.asCheckboxItem().getTitle(),
);
console.log(checkboxItemsTitle);

Параметры

Имя Тип Описание
item Type Item Type Тип элементов, которые необходимо получить.

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

Item[] — Массив всех элементов этого типа.

Авторизация

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

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

get Published Url()

Получает URL-адрес, который можно использовать для ответа на форму.

// 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',
);

// Gets the URL to respond to the form and logs it to the console.
const url = form.getPublishedUrl();
console.log(url);

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

String — URL-адрес для ответа на форму.

Авторизация

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

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

get Response(responseId)

Получает один ответ формы на основе его идентификатора ответа. Идентификаторы ответов можно получить из Form Response.getId() .

Параметры

Имя Тип Описание
response Id String Идентификатор ответа формы.

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

Form Response — ответ формы.

Броски

Error — если ответа не существует

Авторизация

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

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

get Responses()

Получает массив всех ответов формы.

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

Form Response[] — Массив всех ответов формы.

Авторизация

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

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

get Responses(timestamp)

Получает массив всех ответов формы после заданной даты и времени.

Параметры

Имя Тип Описание
timestamp Date Самая ранняя дата и время, для которых должны быть возвращены ответы формы.

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

Form Response[] — Список ответов формы.

Авторизация

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

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

get Shuffle Questions()

Определяет, является ли порядок вопросов на каждой странице формы случайным.

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

Booleantrue , если порядок вопросов на каждой странице формы рандомизирован; false если нет.

Авторизация

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

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

get Summary Url()

Получает URL-адрес, который можно использовать для просмотра сводки ответов формы. Если для set Publishing Summary(enabled) не установлено значение true , только пользователи с разрешением на редактирование формы смогут получить доступ к URL-адресу.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// Opens the form by its URL.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Gets the URL to view a summary of the form's responses and logs it to the
// console.
const url = form.getSummaryUrl();
console.log(url);

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

String — URL-адрес для просмотра сводки ответов.

Авторизация

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

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

get Title()

Получает заголовок формы.

// 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',
);

// Sets the title of the form to 'For_Testing.'
form.setTitle('For_Testing');

// Gets the title of the form and logs it to the console.
const title = form.getTitle();
console.log(title);

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

String — заголовок формы.

Авторизация

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

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

has Limit One Response Per User()

Определяет, допускает ли форма только один ответ для каждого респондента. Если значение равно true , сценарий вообще не может отправлять ответы формы.

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

Booleantrue , если форма допускает только один ответ для каждого респондента; false если нет.

Авторизация

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

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

has Progress Bar()

Определяет, отображает ли форма индикатор выполнения.

// Opens the Forms file by its URL. If you created your script from within
// a Google Forms file, you can use FormApp.getActiveForm() instead.
// Opens the form by its URL.
// TODO(developer): Replace the URL with your own.
const form = FormApp.openByUrl(
    'https://docs.google.com/forms/d/abc123456/edit',
);

// Displays the progress bar on the form.
form.setProgressBar(true);

// Checks if the form displays a progress bar and logs it to the console.
console.log(form.hasProgressBar());

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

Booleantrue , если в форме отображается индикатор выполнения; false если это не так.

Авторизация

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

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

Определяет, отображает ли форма ссылку для отправки другого ответа после того, как респондент заполнит форму.

// 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',
);

// Sets the form to display a link to submit another
// response after someone submits the form.
form.setShowLinkToRespondAgain(true);

// Checks if the form displays a 'Submit another response' link and logs it to
// the console.
console.log(form.hasRespondAgainLink());

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

Booleantrue , если в форме отображается ссылка «Отправить еще один ответ»; false если это не так.

Авторизация

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

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

is Accepting Responses()

Определяет, принимает ли форма в данный момент ответы.

// 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',
);

// Sets the form to accept responses.
form.setAcceptingResponses(true);

// Checks if the form is accepting responses or not and logs it to the console.
const accepting = form.isAcceptingResponses();
console.log(accepting);

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

Booleantrue , если форма принимает ответы; false если это не так.

Авторизация

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

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

is Publishing Summary()

Определяет, отображает ли форма ссылку для просмотра сводки ответов после того, как респондент заполнит форму.

// 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',
);

// Sets the form to display a link to a summary of
// the responses after someone submits the form.
form.setPublishingSummary(true);

// Checks if the form displays a "See previous responses" link and logs it to
// the console.
const publishingLink = form.isPublishingSummary();
console.log(publishingLink);

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

Booleantrue , если в форме отображается ссылка «Просмотреть предыдущие ответы»; false если это не так.

Авторизация

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

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

is Quiz()

Определяет, является ли форма тестом.

// 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',
);

// Sets the form as a quiz.
form.setIsQuiz(true);

// Checks if the form is a quiz or not and logs it to the console.
console.log(form.isQuiz());

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

Booleantrue , если форма принимает ответы; false если это не так.

Авторизация

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

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

move Item(from, to)

Перемещает элемент по заданному индексу среди всех элементов формы в другой заданный индекс. Выдает исключение сценария, если to выходит за пределы.

// 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',
);

// Moves the first item to be the last item.
form.moveItem(0, form.getItems().length - 1);

Параметры

Имя Тип Описание
from Integer Текущий индекс элемента среди всех элементов формы.
to Integer Новый индекс элемента среди всех элементов формы.

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

Item — элемент, который был перемещен.

Броски

Error — если любой индекс выходит за пределы.

Авторизация

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

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

move Item(item, toIndex)

Перемещает заданный элемент в заданный индекс среди всех элементов формы. Выдает исключение сценария, если данный индекс выходит за пределы.

// 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',
);

// Gets the first item.
const item = form.getItems()[0];

// Moves the item to be the last item.
form.moveItem(item, form.getItems().length - 1);

Параметры

Имя Тип Описание
item Item Предмет для перемещения.
to Index Integer Новый индекс элемента среди всех элементов формы.

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

Item — элемент, который был перемещен.

Броски

Error — если индекс выходит за пределы.

Авторизация

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

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

remove Destination()

Отключает форму от текущего места назначения ответа. В несвязанном бывшем пункте назначения по-прежнему сохраняются копии всех предыдущих ответов. Все формы, включая те, у которых явно не указан пункт назначения, сохраняют копии ответов в хранилище ответов формы . Если форма в настоящее время не имеет места назначения ответа, этот метод не имеет никакого эффекта.

// 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',
);

// Opens a spreadsheet to use for the response destination.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Updates the form's response destination to the spreadsheet.
form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());

// Unlinks the form from the spreadsheet.
form.removeDestination();

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

Form — Эта Form для связывания.

Авторизация

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

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

remove Editor(emailAddress)

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

Для файлов на Диске это также удаляет пользователя из списка зрителей.

Параметры

Имя Тип Описание
email Address String Адрес электронной почты пользователя, которого необходимо удалить.

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

Form — Эта Form для связывания.

Авторизация

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

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

remove Editor(user)

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

Для файлов на Диске это также удаляет пользователя из списка зрителей.

Параметры

Имя Тип Описание
user User Представление пользователя, которого нужно удалить.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Accepting Responses(enabled)

Устанавливает, принимает ли форма в данный момент ответы. По умолчанию для новых форм установлено true .

// 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',
);

// Sets the form to accept responses.
form.setAcceptingResponses(true);

// Checks whether the form is accepting responses or not and logs it to the
// console.
console.log(form.isAcceptingResponses());

Параметры

Имя Тип Описание
enabled Boolean true если форма должна принимать ответы; false если этого не должно быть.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Allow Response Edits(enabled)

Определяет, отображает ли форма ссылку для редактирования ответа после его отправки. По умолчанию для новых форм установлено значение false .

Независимо от этого параметра, метод Form Response.getEditResponseUrl() позволяет автору сценария, имеющему разрешение на редактирование формы, генерировать URL-адрес, который можно использовать для редактирования ответа.

// 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',
);

// Shows "Edit your response" link after someone submits the form.
form.setAllowResponseEdits(true);

// Checks whether the option to edit the form after a user submits it is set to
// true or not and logs it to the console.
console.log(form.canEditResponse());

Параметры

Имя Тип Описание
enabled Boolean true , если в форме должна отображаться ссылка «Изменить ответ»; false если нет.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Collect Email(collect)

Определяет, собирает ли форма адреса электронной почты респондентов. По умолчанию для новых форм установлено значение false .

// 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',
);

// Sets the form to collect respondents' email addresses.
form.setCollectEmail(true);

// Checks whether the value is set to true or false and logs it to the console.
const collect = form.collectsEmail();
console.log(collect);

Параметры

Имя Тип Описание
collect Boolean true , если форма должна собирать адреса электронной почты; false если это не так.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Confirmation Message(message)

Устанавливает сообщение подтверждения формы.

// 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',
);

// Sets a custom confirmation message to display after someone submits the form.
form.setConfirmationMessage('Your form has been successfully submitted.');

// Gets the confirmation message set for the form and logs it to the console.
const message = form.getConfirmationMessage();
console.log(message);

Параметры

Имя Тип Описание
message String Новое подтверждающее сообщение формы.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Custom Closed Form Message(message)

Устанавливает сообщение, которое будет отображаться, если форма не принимает ответы. Если сообщение не задано, в форме используется сообщение по умолчанию.

// 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',
);

// Sets the form to not accept responses.
form.setAcceptingResponses(false);

// Sets a custom closed form message to display to the user.
form.setCustomClosedFormMessage('The form is no longer accepting responses.');

// Gets the custom message set for the form and logs it to the console.
const message = form.getCustomClosedFormMessage();
console.log(message);

Параметры

Имя Тип Описание
message String Сообщение, отображаемое, если форма не принимает ответы.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Description(description)

Устанавливает описание формы.

Параметры

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

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

Form — Эта Form для связывания.

Авторизация

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

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

set Destination(type, id)

Устанавливает место назначения, в котором сохраняются ответы формы. Все формы, включая те, у которых явно не указан пункт назначения, сохраняют копии ответов в хранилище ответов формы .

Параметры

Имя Тип Описание
type Destination Type Тип назначения ответа формы.
id String Идентификатор места назначения ответа формы.

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

Form — Эта Form для связывания.

Броски

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

Авторизация

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

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

set Is Quiz(enabled)

Устанавливает, является ли форма тестом. По умолчанию для новых форм установлено значение false .

Оцениваемые вопросы разрешены только в тестах, поэтому установка значения false приведет к удалению всех параметров оценки из всех вопросов.

Настройки теста доступны только в новом пользовательском интерфейсе Forms; создание формы викторины позволяет форме использовать новый пользовательский интерфейс.

// 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',
);

// Makes the form a quiz.
form.setIsQuiz(true);

// Checks whether the form is a quiz or not and logs it to the console.
console.log(form.isQuiz());

Параметры

Имя Тип Описание
enabled Boolean true если для формы должны быть включены функции теста; false если нет.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Limit One Response Per User(enabled)

Устанавливает, допускает ли форма только один ответ для каждого респондента. По умолчанию для новых форм установлено значение false . Если для параметра установлено значение true , сценарий вообще не сможет отправлять ответы формы.

Параметры

Имя Тип Описание
enabled Boolean true если форма должна разрешать только один ответ от каждого респондента; false если нет.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Progress Bar(enabled)

Устанавливает, имеет ли форма индикатор выполнения. По умолчанию для новых форм установлено значение false .

// 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',
);

// Displays the progress bar on the form.
form.setProgressBar(true);

// Checks whether the form has a progress bar and logs it to the console.
console.log(form.hasProgressBar());

Параметры

Имя Тип Описание
enabled Boolean true если в форме отображается индикатор выполнения; false если это не так.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Publishing Summary(enabled)

Определяет, отображает ли форма ссылку для просмотра сводки ответов после отправки формы респондентом. По умолчанию для новых форм установлено значение false .

Параметры

Имя Тип Описание
enabled Boolean true , если в форме должна отображаться ссылка «Просмотреть предыдущие ответы»; false если нет.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Show Link To Respond Again(enabled)

Определяет, отображает ли форма ссылку для отправки другого ответа после того, как респондент заполнит форму. По умолчанию для новых форм установлено true .

Параметры

Имя Тип Описание
enabled Boolean true если в форме должна отображаться ссылка «Отправить другой ответ»; false если нет.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Shuffle Questions(shuffle)

Определяет, является ли порядок вопросов на каждой странице формы случайным.

Параметры

Имя Тип Описание
shuffle Boolean true , если порядок вопросов на каждой странице формы должен быть рандомизирован; false если нет.

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

Form — Эта Form для связывания.

Авторизация

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

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

set Title(title)

Устанавливает заголовок формы.

Параметры

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

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

Form — Эта Form для связывания.

Авторизация

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

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

shorten Form Url(url)

Преобразует длинный URL-адрес формы в короткий URL-адрес. Выдает исключение, если длинный URL-адрес не принадлежит Google Forms.

Параметры

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

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

String — URL-адрес в формате http://goo.gl/forms/1234 .

Авторизация

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

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

submit Grades(responses)

Отправляет оценки за заданные ответы FormResponse.

Если ваш код включает триггер on Form Submit , вызов submit Grades() запускает условие on Form Submit и вызывает бесконечный цикл. Чтобы предотвратить бесконечный цикл, добавьте код, который проверяет, существуют ли оценки, перед вызовом submit Grades() .

Параметры

Имя Тип Описание
responses Form Response[] Массив всех ответов формы.

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

Form — Эта Form для связывания.

Авторизация

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

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

Устаревшие методы