Interface Item

פריט

פריט גנרי שמכיל מאפיינים המשותפים לכל הפריטים, כמו כותרת וטקסט עזרה. אפשר לגשת לפריטים או ליצור אותם דרך Form.

כדי לבצע פעולה במאפיינים ספציפיים מסוג מסוים, כדאי להשתמש ב-getType() כדי לבדוק את ה-ItemType של הפריט, ואז להעביר את הפריט למחלקה המתאימה באמצעות שיטה כמו asCheckboxItem().

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

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

// Cast the generic item to the text-item class.
if (item.getType() == 'TEXT') {
  var 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מחזירה את הפריט כפריט טקסט של פסקה.
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 – הפריט ברשימה

קליעות

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

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טקסט העזרה החדש

החזרות

ItemItem, לשרשור

הרשאות

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

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

setTitle(title)

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

פרמטרים

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

החזרות

ItemItem, לשרשור

הרשאות

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

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