Class FormApp

FormularzAplikacja

Umożliwia skryptowi otwarcie istniejącego Form lub utworzenie nowego. 

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

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

Właściwości

WłaściwośćTypOpis
AlignmentAlignmentWyliczenie typów wyrównania obrazu.
DestinationTypeDestinationTypeWyliczenie typów miejsc docelowych, które mogą przechowywać odpowiedzi na formularz.
FeedbackTypeFeedbackTypeWyliczenie typów formularza Feedbacks.
ItemTypeItemTypeWyliczenie typów formularza Items.
PageNavigationTypePageNavigationTypeWyliczenie możliwych zachowań podczas przechodzenia między stronami.
RatingIconTypeRatingIconTypeWyliczenie typów ikon ocen RatingIcons

Metody

MetodaZwracany typKrótki opis
create(title)FormTworzy i zwraca nowy obiekt Form.
create(title, isPublished)FormTworzy i zwraca nową Form w żądanym stanie publikacji.
createCheckboxGridValidation()CheckboxGridValidationBuilderZwraca instancję klasy CheckboxGridValidationBuilder, która może służyć do ustawiania walidacji w przypadku elementu CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderZwraca instancję klasy CheckboxValidationBuilder, która może służyć do ustawiania weryfikacji w komponencie CheckboxItem.
createFeedback()QuizFeedbackBuilderZwraca instancję klasy QuizFeedbackBuilder, która może służyć do ustawiania informacji zwrotnych dotyczących oceniania.Item
createGridValidation()GridValidationBuilderZwraca instancję klasy GridValidationBuilder, która może służyć do ustawiania walidacji w elementach GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderZwraca instancję klasy ParagraphTextValidationBuilder, której można użyć do ustawienia walidacji w przypadku ParagraphTextItem.
createTextValidation()TextValidationBuilderZwraca instancję klasy TextValidationBuilder, która może służyć do ustawiania walidacji w przypadku TextItem.
getActiveForm()FormZwraca formularz, do którego skrypt jest powiązany z kontenerem.
getUi()UiZwraca instancję środowiska interfejsu użytkownika edytora formularzy, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna dialogowe i paski boczne.
openById(id)FormZwraca Form o określonym identyfikatorze.
openByUrl(url)FormZwraca Form o określonym adresie URL.

Szczegółowa dokumentacja

create(title)

Tworzy i zwraca nowy obiekt Form. Wyjątek jest zgłaszany, jeśli podany tytuł jest pusty lub ma wartość null. 

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

Parametry

NazwaTypOpis
titleStringNazwa nowego formularza.

Powrót

Form – nowy formularz.

Rzuty

Error – jeśli podany tytuł to null lub jest pusty,

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

create(title, isPublished)

Tworzy i zwraca nową Form w żądanym stanie publikacji. Wyjątek jest zgłaszany, jeśli podany tytuł jest pusty lub ma wartość null. 

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

Parametry

NazwaTypOpis
titleStringNazwa nowego formularza.
isPublishedBooleanOkreśla, czy formularz ma być opublikowany.

Powrót

Form – nowy formularz.

Rzuty

Error – jeśli podany tytuł to null lub jest pusty,

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

createCheckboxGridValidation()

Zwraca instancję klasy CheckboxGridValidationBuilder, która może służyć do ustawiania walidacji w przypadku elementu CheckboxGridItem.

Powrót

CheckboxGridValidationBuilder

createCheckboxValidation()

Zwraca instancję klasy CheckboxValidationBuilder, która może służyć do ustawiania weryfikacji w komponencie CheckboxItem.

Powrót

CheckboxValidationBuilder

createFeedback()

Zwraca instancję klasy QuizFeedbackBuilder, która może służyć do ustawiania informacji zwrotnych dotyczących oceniania.Item

Powrót

QuizFeedbackBuilder

createGridValidation()

Zwraca instancję klasy GridValidationBuilder, która może służyć do ustawiania walidacji w elementach GridItem.

Powrót

GridValidationBuilder

createParagraphTextValidation()

Zwraca instancję klasy ParagraphTextValidationBuilder, której można użyć do ustawienia walidacji w przypadku ParagraphTextItem.

Powrót

ParagraphTextValidationBuilder

createTextValidation()

Zwraca instancję klasy TextValidationBuilder, która może służyć do ustawiania walidacji w przypadku TextItem.

Powrót

TextValidationBuilder

getActiveForm()

Zwraca formularz, do którego skrypt jest powiązany z kontenerem. Aby korzystać z formularzy, do których skrypt nie jest powiązany z kontenerem, użyj tagu openById(id) lub openByUrl(url). 

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

Powrót

Form – formularz, do którego jest powiązany skrypt, lub null, jeśli skrypt nie jest powiązany z formularzem.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getUi()

Zwraca instancję środowiska interfejsu użytkownika edytora formularzy, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna dialogowe i paski boczne. Skrypt może wchodzić w interakcję z interfejsem tylko w przypadku bieżącego wystąpienia otwartego edytora formularza (nie widoku, który widzi respondent), i tylko wtedy, gdy skrypt jest powiązany z formularzem. Więcej informacji znajdziesz w przewodnikach dotyczących menu oraz okienek dialogowych i pasków bocznych. 

// 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();
}

Powrót

Ui – instancja środowiska interfejsu użytkownika formularza.

openById(id)

Zwraca Form o określonym identyfikatorze. Wyjątek jest zgłaszany, jeśli identyfikator jest nieprawidłowy lub użytkownik nie ma uprawnień do otwarcia formularza. 

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

Parametry

NazwaTypOpis
idStringidentyfikator formularza, który chcesz otworzyć.

Powrót

Form – formularz o podanym identyfikatorze

Rzuty

Error – jeśli podany identyfikator jest nieprawidłowy lub użytkownik nie ma wystarczających uprawnień

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

openByUrl(url)

Zwraca Form o określonym adresie URL. Wyjątek jest zgłaszany, jeśli adres URL jest nieprawidłowy lub użytkownik nie ma uprawnień do otwarcia formularza. 

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

Parametry

NazwaTypOpis
urlStringadres URL formularza do otwarcia.

Powrót

Form – formularz z danym adresem URL

Rzuty

Error – jeśli podany adres URL jest nieprawidłowy lub użytkownik nie ma wystarczających uprawnień

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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