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

חזרה

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