Class FormApp

FormApp

อนุญาตให้สคริปต์เปิด Form ที่มีอยู่หรือสร้างใหม่ 

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

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

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
AlignmentAlignmentการแจงนับประเภทการจัดแนวรูปภาพ
DestinationTypeDestinationTypeการแจงนับประเภทปลายทางที่จัดเก็บคำตอบของแบบฟอร์มได้
FeedbackTypeFeedbackTypeการแจงนับประเภทของแบบฟอร์ม Feedbacks
ItemTypeItemTypeการแจงนับประเภทของแบบฟอร์ม Items
PageNavigationTypePageNavigationTypeการแจงนับลักษณะการทำงานที่เป็นไปได้สำหรับการไปยังหน้าต่างๆ
RatingIconTypeRatingIconTypeการแจงนับประเภทไอคอนการให้คะแนน RatingIcons

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
create(title)Formสร้างและแสดงผล Form ใหม่
create(title, isPublished)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.
const form = FormApp.create('Form Name');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringชื่อของแบบฟอร์มใหม่

รีเทิร์น

Form — แบบฟอร์มใหม่

ส่ง

Error — หากชื่อที่ระบุคือ null หรือว่างเปล่า

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • 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 หรือว่างเปล่า

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • 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.
const form = FormApp.getActiveForm();

รีเทิร์น

Form - ฟอร์มที่สคริปต์เชื่อมโยงอยู่ หรือ null หากสคริปต์ไม่ได้เชื่อมโยงกับฟอร์ม

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

แสดงผล Form ที่มีรหัสที่ระบุ โยนข้อยกเว้นหากรหัสไม่ถูกต้องหรือผู้ใช้ไม่มีสิทธิ์เปิดแบบฟอร์ม 

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสของแบบฟอร์มที่จะเปิด

รีเทิร์น

Form — แบบฟอร์มที่มีรหัสที่ระบุ

ส่ง

Error — หากรหัสที่ระบุไม่ถูกต้องหรือผู้ใช้ไม่มีสิทธิ์เพียงพอ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

openByUrl(url)

แสดงผล Form ที่มี URL ที่ระบุ ส่งข้อยกเว้นหาก URL ไม่ถูกต้องหรือ ผู้ใช้ไม่มีสิทธิ์เปิดแบบฟอร์ม 

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
urlStringURL ของแบบฟอร์มที่จะเปิด

รีเทิร์น

Form - แบบฟอร์มที่มี URL ที่ระบุ

ส่ง

Error — หาก URL ที่ระบุไม่ถูกต้องหรือผู้ใช้ไม่มีสิทธิ์เพียงพอ

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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