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