Interface Item

פריט

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

כדי לבצע פעולות במאפיינים ספציפיים לסוג, משתמשים ב-getType() כדי לבדוק את ItemType של הפריט, ואז מבצעים הטמעה (cast) של הפריט לכיתה המתאימה באמצעות שיטה כמו 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 — הפריט ברשימה

זריקות

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 – הפריט paragraph-text

זריקות

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

אישור

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

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

asRatingItem()

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

// 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