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 – פריט רשת תיבות הסימון

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asCheckboxItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asDateItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asDateTimeItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asDurationItem()

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

חזרה

‫DurationItem — פריט משך

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asGridItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asImageItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

asListItem()

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

חזרה

‫ListItem — the list item

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asMultipleChoiceItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asPageBreakItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asParagraphTextItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

‫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 – פריט הסיווג.

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asScaleItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asSectionHeaderItem()

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

חזרה

‫SectionHeaderItem — the section-header item

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asTextItem()

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

חזרה

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

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asTimeItem()

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

חזרה

‫TimeItem – פריט הזמן

מקפיצה את הודעות השגיאה (Throws)

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

אישור

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

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

asVideoItem()

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

חזרה

‫VideoItem – פריט הווידאו

מקפיצה את הודעות השגיאה (Throws)

‫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