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

הטמעה של כיתות

שםתיאור קצר

Methods

שיטהסוג הערך שמוחזרתיאור קצר
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 – אם הפריט הוא לא פריט של רשת עם תיבות סימון

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asCheckboxItem()

הפונקציה מחזירה את הפריט כפריט של תיבת סימון. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה CHECKBOX.

חזרה

‫CheckboxItem – פריט תיבת הסימון

זריקות

‫Error — אם הפריט הוא לא פריט של תיבת סימון

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asDateItem()

הפונקציה מחזירה את הפריט כפריט תאריך. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה DATE.

חזרה

‫DateItem — פריט התאריך

זריקות

‫Error – אם הפריט הוא לא פריט תאריך

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asDateTimeItem()

הפונקציה מחזירה את הפריט כפריט של תאריך ושעה. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה DATETIME.

חזרה

‫DateTimeItem — פריט התאריך והשעה

זריקות

‫Error – אם הפריט הוא לא פריט של תאריך ושעה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asDurationItem()

הפונקציה מחזירה את הפריט כפריט משך. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה DURATION.

חזרה

‫DurationItem – פריט משך

זריקות

‫Error – אם הפריט לא מוגבל בזמן

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asGridItem()

מחזירה את הפריט כפריט ברשת. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה GRID.

חזרה

‫GridItem — הפריט ברשת

זריקות

‫Error – אם הפריט הוא לא פריט ברשת

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asImageItem()

הפונקציה מחזירה את הפריט כפריט תמונה. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה IMAGE.

חזרה

‫ImageItem — פריט התמונה

זריקות

‫Error – אם הפריט הוא לא פריט תמונה

asListItem()

מחזירה את הפריט כפריט ברשימה. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה LIST.

חזרה

‫ListItem — the list item

זריקות

‫Error – אם הפריט הוא לא פריט ברשימה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asMultipleChoiceItem()

מחזירה את הפריט כפריט של בחירה מרובה. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה MULTIPLE_CHOICE.

חזרה

‫MultipleChoiceItem — פריט של בחירה מרובה

זריקות

‫Error – אם הפריט הוא לא פריט של בחירה מרובה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asPageBreakItem()

הפונקציה מחזירה את הפריט כפריט של מעבר עמוד. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה PAGE_BREAK.

חזרה

‫PageBreakItem — הפריט של מעבר הדף

זריקות

‫Error – אם הפריט הוא לא פריט של מעבר בין דפים

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asParagraphTextItem()

הפונקציה מחזירה את הפריט כפריט טקסט של פסקה. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה PARAGRAPH_TEXT.

חזרה

‫ParagraphTextItem — פריט טקסט הפסקה

זריקות

‫Error – אם הפריט הוא לא פריט טקסט של פסקה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

  • 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 – אם הפריט לא ניתן לדירוג

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asScaleItem()

הפונקציה מחזירה את הפריט כפריט בסולם. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה SCALE.

חזרה

‫ScaleItem – פריט הסולם

זריקות

‫Error – אם הפריט לא מוגדר כפריט שניתן לשנות את קנה המידה שלו

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asSectionHeaderItem()

מחזירה את הפריט כפריט של כותרת קטע. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה SECTION_HEADER.

חזרה

‫SectionHeaderItem — פריט כותרת הקטע

זריקות

‫Error – אם הפריט הוא לא כותרת של קטע

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asTextItem()

הפונקציה מחזירה את הפריט כפריט טקסט. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה TEXT.

חזרה

‫TextItem – פריט הטקסט

זריקות

‫Error – אם הפריט הוא לא פריט טקסט

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asTimeItem()

הפונקציה מחזירה את הפריט כפריט של שעה. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה TIME.

חזרה

‫TimeItem – פריט הזמן

זריקות

‫Error – אם הפריט הוא לא פריט של זמן

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

asVideoItem()

הפונקציה מחזירה את הפריט כפריט וידאו. מופעלת חריגה בסקריפט אם הערך של ItemType לא היה VIDEO.

חזרה

‫VideoItem – פריט הסרטון

זריקות

‫Error — אם הפריט הוא לא סרטון

duplicate()

יוצר עותק של הפריט ומצרף אותו לסוף הטופס.

חזרה

‫Item — עותק משוכפל של Item, לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getHelpText()

מקבל את טקסט העזרה של הפריט (לפעמים נקרא טקסט התיאור של פריטים בפריסה כמו ImageItems, PageBreakItems ו-SectionHeaderItems).

חזרה

‫String — טקסט העזרה או טקסט התיאור של הפריט

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getId()

מחזירה את המזהה הייחודי של הפריט.

חזרה

‫Integer — המזהה של הפריט

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getIndex()

הפונקציה מחזירה את האינדקס של הפריט מבין כל הפריטים בטופס.

חזרה

‫Integer – האינדקס של הפריט

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getTitle()

מחזירה את שם הפריט (לפעמים נקרא טקסט הכותרת, במקרה של SectionHeaderItem).

חזרה

‫String – שם הפריט או טקסט הכותרת

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

getType()

מחזירה את סוג הפריט, שמיוצג כ-ItemType.

חזרה

‫ItemType – סוג הפריט

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

setHelpText(text)

המאפיין מגדיר את טקסט העזרה של הפריט (לפעמים נקרא טקסט התיאור של פריטי פריסה כמו ImageItems, PageBreakItems ו-SectionHeaderItems).

פרמטרים

שםסוגתיאור
textStringטקסט העזרה החדש

חזרה

‫Item — Item הזה, לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

setTitle(title)

מגדיר את שם הפריט (לפעמים נקרא טקסט הכותרת, במקרה של SectionHeaderItem).

פרמטרים

שםסוגתיאור
titleStringהטקסט החדש של הכותרת או הכותרת הראשית

חזרה

‫Item — Item הזה, לשרשור

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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