Interface Item

รายการ

รายการแบบฟอร์มทั่วไปที่มีพร็อพเพอร์ตี้ที่ใช้ร่วมกันในทุกรายการ เช่น ชื่อและข้อความช่วยเหลือ คุณเข้าถึงหรือสร้างรายการจาก Form ได้

หากต้องการดำเนินการกับพร็อพเพอร์ตี้เฉพาะประเภท ให้ใช้ getType() เพื่อตรวจสอบ ItemType ของรายการ จากนั้นแคสต์รายการไปยัง คลาสที่เหมาะสมโดยใช้วิธีการ เช่น asCheckboxItem() 

// Create a new form and add a text item.
const form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
const items = form.getItems();
const item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() === 'TEXT') {
  const textItem = item.asTextItem();
  textItem.setRequired(false);
}

การใช้งานคลาส

ชื่อรายละเอียดแบบย่อ

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
asCheckboxGridItem()CheckboxGridItemแสดงผลรายการเป็นรายการตารางกริดแบบช่องทำเครื่องหมาย
asCheckboxItem()CheckboxItemแสดงผลรายการเป็นรายการแบบช่องทำเครื่องหมาย
asDateItem()DateItemแสดงผลรายการเป็นรายการวันที่
asDateTimeItem()DateTimeItemแสดงผลรายการเป็นรายการวันที่และเวลา
asDurationItem()DurationItemแสดงผลรายการเป็นรายการระยะเวลา
asGridItem()GridItemแสดงผลรายการเป็นรายการตารางกริด
asImageItem()ImageItemแสดงผลรายการเป็นรายการรูปภาพ
asListItem()ListItemแสดงผลรายการเป็นรายการในรายการ
asMultipleChoiceItem()MultipleChoiceItemแสดงผลรายการเป็นรายการที่มีหลายตัวเลือก
asPageBreakItem()PageBreakItemแสดงผลรายการเป็นรายการตัวแบ่งหน้า
asParagraphTextItem()ParagraphTextItemแสดงผลรายการเป็นรายการข้อความแบบย่อหน้า
asRatingItem()RatingItemแสดงผลรายการเป็นรายการการให้คะแนน
asScaleItem()ScaleItemแสดงผลรายการเป็นรายการมาตราส่วน
asSectionHeaderItem()SectionHeaderItemแสดงผลรายการเป็นรายการส่วนหัวของส่วน
asTextItem()TextItemแสดงผลรายการเป็นรายการข้อความ
asTimeItem()TimeItemแสดงผลรายการเป็นรายการเวลา
asVideoItem()VideoItemแสดงผลรายการเป็นวิดีโอ
duplicate()Itemสร้างสำเนาของรายการนี้และต่อท้ายแบบฟอร์ม
getHelpText()Stringรับข้อความช่วยเหลือของรายการ (บางครั้งเรียกว่าข้อความคำอธิบายสำหรับรายการเลย์เอาต์ เช่น ImageItems, PageBreakItems และ SectionHeaderItems)
getId()Integerรับตัวระบุที่ไม่ซ้ำกันของรายการ
getIndex()Integerรับดัชนีของรายการในบรรดารายการทั้งหมดในแบบฟอร์ม
getTitle()Stringรับชื่อของรายการ (บางครั้งเรียกว่าข้อความส่วนหัวในกรณีของ SectionHeaderItem)
getType()ItemTypeรับประเภทของรายการที่แสดงเป็น ItemType
setHelpText(text)Itemตั้งค่าข้อความช่วยเหลือของรายการ (บางครั้งเรียกว่าข้อความอธิบายสำหรับรายการเลย์เอาต์ เช่น ImageItems, PageBreakItems และ SectionHeaderItems)
setTitle(title)Itemตั้งชื่อรายการ (บางครั้งเรียกว่าข้อความส่วนหัวในกรณีของ SectionHeaderItem)

เอกสารโดยละเอียด

asCheckboxGridItem()

แสดงผลรายการเป็นรายการตารางกริดแบบช่องทำเครื่องหมาย ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ CHECKBOX_GRID

รีเทิร์น

CheckboxGridItem - รายการตารางกริดช่องทำเครื่องหมาย

การขว้าง

Error - หากรายการไม่ใช่รายการตารางช่องทำเครื่องหมาย

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

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

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

asCheckboxItem()

แสดงผลรายการเป็นรายการแบบช่องทำเครื่องหมาย ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ CHECKBOX

รีเทิร์น

CheckboxItem - รายการช่องทำเครื่องหมาย

การขว้าง

Error — หากรายการไม่ใช่รายการช่องทำเครื่องหมาย

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

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

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

asDateItem()

แสดงผลรายการเป็นรายการวันที่ ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ DATE

รีเทิร์น

DateItem — รายการวันที่

การขว้าง

Error — หากรายการไม่ใช่รายการวันที่

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

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

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

asDateTimeItem()

แสดงผลรายการเป็นรายการวันที่และเวลา ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ DATETIME

รีเทิร์น

DateTimeItem — รายการวันที่และเวลา

การขว้าง

Error — หากรายการไม่ใช่รายการวันที่และเวลา

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

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

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

asDurationItem()

แสดงผลรายการเป็นรายการระยะเวลา ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ DURATION

รีเทิร์น

DurationItem - รายการระยะเวลา

การขว้าง

Error - หากรายการไม่ใช่รายการระยะเวลา

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

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

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

asGridItem()

แสดงผลรายการเป็นรายการตารางกริด ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ GRID

รีเทิร์น

GridItem — รายการตารางกริด

การขว้าง

Error — หากรายการไม่ใช่รายการในตารางกริด

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

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

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

asImageItem()

แสดงผลรายการเป็นรายการรูปภาพ ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ IMAGE

รีเทิร์น

ImageItem - รายการรูปภาพ

การขว้าง

Error — หากสินค้าไม่ใช่สินค้าที่เป็นรูปภาพ

asListItem()

แสดงผลรายการเป็นรายการในรายการ ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ LIST

รีเทิร์น

ListItem — รายการ

การขว้าง

Error — หากรายการไม่ใช่รายการ

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

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

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

asMultipleChoiceItem()

แสดงผลรายการเป็นรายการที่มีหลายตัวเลือก ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ MULTIPLE_CHOICE

รีเทิร์น

MultipleChoiceItem - รายการที่มีหลายตัวเลือก

การขว้าง

Error — หากรายการไม่ใช่รายการที่มีหลายตัวเลือก

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

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

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

asPageBreakItem()

แสดงผลรายการเป็นรายการตัวแบ่งหน้า ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ PAGE_BREAK

รีเทิร์น

PageBreakItem - รายการตัวแบ่งหน้า

การขว้าง

Error — หากรายการไม่ใช่รายการตัวแบ่งหน้า

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

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

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

asParagraphTextItem()

แสดงผลรายการเป็นรายการข้อความแบบย่อหน้า ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ PARAGRAPH_TEXT

รีเทิร์น

ParagraphTextItem - รายการข้อความย่อหน้า

การขว้าง

Error — หากรายการไม่ใช่รายการข้อความแบบย่อหน้า

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

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

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

asRatingItem()

แสดงผลรายการเป็นรายการการให้คะแนน ส่ง ScriptingException หาก ItemType ไม่ได้เป็น RATING อยู่แล้ว 

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

// Fetch any item which is of type rating.
const item = form.getItems(FormApp.ItemType.RATING)[0];

// Convert the item to a rating item.
const ratingItem = item.asRatingItem();

รีเทิร์น

RatingItem — รายการการจัดประเภท

การขว้าง

Error — หากรายการไม่ใช่รายการให้คะแนน

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

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

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

asScaleItem()

แสดงผลรายการเป็นรายการมาตราส่วน ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ SCALE

รีเทิร์น

ScaleItem - รายการที่ปรับขนาด

การขว้าง

Error — หากสินค้าไม่ใช่สินค้าที่ต้องชั่งน้ำหนัก

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

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

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

asSectionHeaderItem()

แสดงผลรายการเป็นรายการส่วนหัวของส่วน ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ SECTION_HEADER

รีเทิร์น

SectionHeaderItem — รายการส่วนหัวของส่วน

การขว้าง

Error — หากรายการไม่ใช่รายการส่วนหัวของส่วน

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

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

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

asTextItem()

แสดงผลรายการเป็นรายการข้อความ ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ TEXT

รีเทิร์น

TextItem - รายการข้อความ

การขว้าง

Error — หากรายการไม่ใช่รายการข้อความ

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

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

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

asTimeItem()

แสดงผลรายการเป็นรายการเวลา ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ TIME

รีเทิร์น

TimeItem - รายการเวลา

การขว้าง

Error — หากรายการไม่ใช่รายการเวลา

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

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

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

asVideoItem()

แสดงผลรายการเป็นวิดีโอ ส่งข้อยกเว้นการเขียนสคริปต์หาก ItemType ยังไม่ได้ VIDEO

รีเทิร์น

VideoItem — รายการวิดีโอ

การขว้าง

Error — หากรายการไม่ใช่รายการวิดีโอ

duplicate()

สร้างสำเนาของรายการนี้และต่อท้ายแบบฟอร์ม

รีเทิร์น

Item - สำเนาของ Item นี้สำหรับการเชื่อมโยง

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

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

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

getHelpText()

รับข้อความช่วยเหลือของรายการ (บางครั้งเรียกว่าข้อความคำอธิบายสำหรับรายการเลย์เอาต์ เช่น ImageItems, PageBreakItems และ SectionHeaderItems)

รีเทิร์น

String - ข้อความช่วยเหลือหรือข้อความคำอธิบายของรายการ

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

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

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

getId()

รับตัวระบุที่ไม่ซ้ำกันของรายการ

รีเทิร์น

Integer — รหัสของสินค้า

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

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

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

getIndex()

รับดัชนีของรายการในบรรดารายการทั้งหมดในแบบฟอร์ม

รีเทิร์น

Integer — ดัชนีของรายการ

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

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

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

getTitle()

รับชื่อของรายการ (บางครั้งเรียกว่าข้อความส่วนหัวในกรณีของ SectionHeaderItem)

รีเทิร์น

String - ชื่อหรือข้อความส่วนหัวของรายการ

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

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

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

getType()

รับประเภทของรายการที่แสดงเป็น ItemType

รีเทิร์น

ItemType — ประเภทของรายการ

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

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

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

setHelpText(text)

ตั้งค่าข้อความช่วยเหลือของรายการ (บางครั้งเรียกว่าข้อความอธิบายสำหรับรายการเลย์เอาต์ เช่น ImageItems, PageBreakItems และ SectionHeaderItems)

พารามิเตอร์

ชื่อประเภทคำอธิบาย
textStringข้อความช่วยเหลือใหม่

รีเทิร์น

Item — Item นี้สำหรับการเชื่อมโยง

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

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

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

setTitle(title)

ตั้งชื่อรายการ (บางครั้งเรียกว่าข้อความส่วนหัวในกรณีของ SectionHeaderItem)

พารามิเตอร์

ชื่อประเภทคำอธิบาย
titleStringข้อความชื่อหรือข้อความส่วนหัวใหม่

รีเทิร์น

Item — Item นี้สำหรับการเชื่อมโยง

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

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

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