Class FormApp

FormApp

Umożliwia skryptowi otwieranie istniejącego Form lub tworzenie 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, w których można przechowywać odpowiedzi na pytania z formularza.
FeedbackTypeFeedbackTypeWyliczenie typów formularzy Feedbacks.
ItemTypeItemTypeWyliczenie typów formularzy Items.
PageNavigationTypePageNavigationTypeWyliczenie możliwych zachowań podczas poruszania się po stronach.
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 nowy obiekt Form w żądanym stanie publikacji.
createCheckboxGridValidation()CheckboxGridValidationBuilderZwraca instancję klasy CheckboxGridValidationBuilder, której można użyć do ustawienia weryfikacji w CheckboxGridItem.
createCheckboxValidation()CheckboxValidationBuilderZwraca instancję klasy CheckboxValidationBuilder, której można użyć do ustawienia weryfikacji w przypadku elementu CheckboxItem.
createFeedback()QuizFeedbackBuilderZwraca instancję klasy QuizFeedbackBuilder, której można użyć do ustawienia opinii na temat elementu podlegającego ocenieItem.
createGridValidation()GridValidationBuilderZwraca instancję klasy GridValidationBuilder, której można użyć do ustawienia weryfikacji w obiekcie GridItem.
createParagraphTextValidation()ParagraphTextValidationBuilderZwraca instancję klasy ParagraphTextValidationBuilder, której można użyć do ustawienia weryfikacji w przypadku elementu ParagraphTextItem.
createTextValidation()TextValidationBuilderZwraca instancję klasy TextValidationBuilder, której można użyć do ustawienia weryfikacji w przypadku elementu TextItem.
getActiveForm()FormZwraca formularz, z którym skrypt jest powiązany.
getUi()UiZwraca instancję środowiska interfejsu użytkownika edytora formularzy, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna i paski boczne.
openById(id)FormZwraca Form o określonym identyfikatorze.
openByUrl(url)FormZwraca obiekt Form o określonym adresie URL.

Szczegółowa dokumentacja

create(title)

Tworzy i zwraca nowy obiekt Form. Zwraca wyjątek, jeśli podany tytuł jest null lub pusty. 

// 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

create(title, isPublished)

Tworzy i zwraca nowy obiekt Form w żądanym stanie publikacji. Zwraca wyjątek, jeśli podany tytuł to null lub jest pusty. 

// 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

createCheckboxGridValidation()

Zwraca instancję klasy CheckboxGridValidationBuilder, której można użyć do ustawienia weryfikacji w CheckboxGridItem.

Powrót

CheckboxGridValidationBuilder

createCheckboxValidation()

Zwraca instancję klasy CheckboxValidationBuilder, której można użyć do ustawienia weryfikacji w przypadku elementu CheckboxItem.

Powrót

CheckboxValidationBuilder

createFeedback()

Zwraca instancję klasy QuizFeedbackBuilder, której można użyć do ustawienia opinii na temat elementu podlegającego ocenieItem.

Powrót

QuizFeedbackBuilder

createGridValidation()

Zwraca instancję klasy GridValidationBuilder, której można użyć do ustawienia weryfikacji w obiekcie GridItem.

Powrót

GridValidationBuilder

createParagraphTextValidation()

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

Powrót

ParagraphTextValidationBuilder

createTextValidation()

Zwraca instancję klasy TextValidationBuilder, której można użyć do ustawienia weryfikacji w przypadku elementu TextItem.

Powrót

TextValidationBuilder

getActiveForm()

Zwraca formularz, z którym skrypt jest powiązany. Aby korzystać z formularzy, z którymi skrypt nie jest powiązany, użyj openById(id) lub openByUrl(url). 

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 i paski boczne. Skrypt może wchodzić w interakcję z interfejsem tylko w przypadku bieżącej instancji otwartego edytora formularzy (nie w przypadku widoku, który widzi osoba odpowiadająca) i tylko wtedy, gdy jest powiązany z formularzem. Więcej informacji znajdziesz w przewodnikach po menu oraz oknach dialogowych i paskach 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 tego formularza.

openById(id)

Zwraca Form o określonym identyfikatorze. Zgłasza wyjątek, 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 do otwarcia;

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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

openByUrl(url)

Zwraca obiekt Form o określonym adresie URL. Zgłasza wyjątek, 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 o podanym adresie URL.

Rzuty

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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