Class FormApp

양식앱

스크립트가 기존 Form를 열거나 새 Form를 만들 수 있도록 허용합니다. 

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

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

속성

속성유형설명
AlignmentAlignment이미지 정렬 유형의 열거형입니다.
DestinationTypeDestinationType양식 응답을 저장할 수 있는 대상 유형의 열거형입니다.
FeedbackTypeFeedbackTypeFeedbacks 형식의 유형을 열거합니다.
ItemTypeItemTypeItems 형식의 유형을 열거합니다.
PageNavigationTypePageNavigationType페이지 탐색에 가능한 동작을 열거합니다.
RatingIconTypeRatingIconType평점 아이콘 유형 RatingIcons의 열거형

메서드

메서드반환 유형간략한 설명
create(title)Form새 Form를 만들고 반환합니다.
create(title, isPublished)Form요청된 게시 상태에서 새 Form를 만들고 반환합니다.
createCheckboxGridValidation()CheckboxGridValidationBuilderCheckboxGridItem에서 유효성 검사를 설정하는 데 사용할 수 있는 CheckboxGridValidationBuilder 인스턴스를 반환합니다.
createCheckboxValidation()CheckboxValidationBuilderCheckboxItem에서 유효성 검사를 설정하는 데 사용할 수 있는 CheckboxValidationBuilder의 인스턴스를 반환합니다.
createFeedback()QuizFeedbackBuilder채점 가능한 Item에 대한 의견을 설정하는 데 사용할 수 있는 QuizFeedbackBuilder 인스턴스를 반환합니다.
createGridValidation()GridValidationBuilderGridItem에서 유효성 검사를 설정하는 데 사용할 수 있는 GridValidationBuilder 인스턴스를 반환합니다.
createParagraphTextValidation()ParagraphTextValidationBuilderParagraphTextItem에서 유효성 검사를 설정하는 데 사용할 수 있는 ParagraphTextValidationBuilder 인스턴스를 반환합니다.
createTextValidation()TextValidationBuilderTextItem에서 유효성 검사를 설정하는 데 사용할 수 있는 TextValidationBuilder의 인스턴스를 반환합니다.
getActiveForm()Form스크립트가 컨테이너에 연결된 양식을 반환합니다.
getUi()Ui스크립트가 메뉴, 대화상자, 사이드바와 같은 기능을 추가할 수 있는 양식 편집기의 사용자 인터페이스 환경 인스턴스를 반환합니다.
openById(id)Form지정된 ID가 있는 Form를 반환합니다.
openByUrl(url)Form지정된 URL이 포함된 Form를 반환합니다.

자세한 문서

create(title)

새 Form를 만들고 반환합니다. 지정된 제목이 null이거나 비어 있으면 예외가 발생합니다. 

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

매개변수

이름유형설명
titleString새 양식의 이름입니다.

리턴

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);

매개변수

이름유형설명
titleString새 양식의 이름입니다.
isPublishedBoolean양식을 게시해야 하는지 여부입니다.

리턴

Form: 새 양식입니다.

생성 값

Error: 지정된 제목이 null이거나 비어 있는 경우

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

createCheckboxGridValidation()

CheckboxGridItem에서 유효성 검사를 설정하는 데 사용할 수 있는 CheckboxGridValidationBuilder 인스턴스를 반환합니다.

리턴

CheckboxGridValidationBuilder

createCheckboxValidation()

CheckboxItem에서 유효성 검사를 설정하는 데 사용할 수 있는 CheckboxValidationBuilder의 인스턴스를 반환합니다.

리턴

CheckboxValidationBuilder

createFeedback()

채점 가능한 Item에 대한 의견을 설정하는 데 사용할 수 있는 QuizFeedbackBuilder 인스턴스를 반환합니다.

리턴

QuizFeedbackBuilder

createGridValidation()

GridItem에서 유효성 검사를 설정하는 데 사용할 수 있는 GridValidationBuilder 인스턴스를 반환합니다.

리턴

GridValidationBuilder

createParagraphTextValidation()

ParagraphTextItem에서 유효성 검사를 설정하는 데 사용할 수 있는 ParagraphTextValidationBuilder 인스턴스를 반환합니다.

리턴

ParagraphTextValidationBuilder

createTextValidation()

TextItem에서 유효성 검사를 설정하는 데 사용할 수 있는 TextValidationBuilder의 인스턴스를 반환합니다.

리턴

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

스크립트가 메뉴, 대화상자, 사이드바와 같은 기능을 추가할 수 있는 양식 편집기의 사용자 인터페이스 환경 인스턴스를 반환합니다. 스크립트는 양식에 바인딩된 경우에만, 그리고 답변자가 보는 뷰가 아닌 열려 있는 양식 편집기의 현재 인스턴스에 대한 UI와만 상호작용할 수 있습니다. 자세한 내용은 메뉴 및 대화상자 및 사이드바 가이드를 참고하세요. 

// 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)

지정된 ID가 있는 Form를 반환합니다. ID가 유효하지 않거나 사용자에게 양식을 열 권한이 없는 경우 예외를 발생시킵니다. 

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

매개변수

이름유형설명
idString열려는 양식의 ID

리턴

Form: 지정된 ID가 있는 양식

생성 값

Error: 지정된 ID가 유효하지 않거나 사용자에게 충분한 권한이 없는 경우

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

openByUrl(url)

지정된 URL이 포함된 Form를 반환합니다. URL이 잘못되었거나 사용자에게 양식을 열 권한이 없는 경우 예외가 발생합니다. 

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

매개변수

이름유형설명
urlString열려는 양식의 URL

리턴

Form: 지정된 URL이 포함된 양식

생성 값

Error: 지정된 URL이 잘못되었거나 사용자에게 충분한 권한이 없는 경우

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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