Interface Item

مورد

یک آیتم فرم عمومی که شامل ویژگی‌های مشترک بین همه آیتم‌ها، مانند عنوان و متن راهنما، است. آیتم‌ها را می‌توان از طریق یک Form دسترسی یا ایجاد کرد.

برای کار با ویژگی‌های نوع-ویژگی، از getType() برای بررسی ItemType آیتم استفاده کنید، سپس آیتم را با استفاده از متدی مانند asCheckboxItem() به کلاس مناسب تبدیل (cast) کنید.

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

پیاده‌سازی کلاس‌ها

نام شرح مختصر

روش‌ها

روش نوع بازگشتی شرح مختصر
as Checkbox Grid Item() Checkbox Grid Item آیتم را به عنوان یک آیتم شبکه‌ایِ چک‌باکس برمی‌گرداند.
as Checkbox Item() Checkbox Item آیتم را به عنوان یک آیتم چک‌باکس برمی‌گرداند.
as Date Item() Date Item آیتم را به عنوان یک آیتم تاریخ‌دار برمی‌گرداند.
as Date Time Item() Date Time Item آیتم را به عنوان یک آیتم تاریخ-زمان برمی‌گرداند.
as Duration Item() Duration Item آیتم را به عنوان یک آیتم مدت زمان برمی‌گرداند.
as Grid Item() Grid Item آیتم را به عنوان یک آیتم شبکه‌ای برمی‌گرداند.
as Image Item() Image Item آیتم را به عنوان یک آیتم تصویر برمی‌گرداند.
as List Item() List Item آیتم را به عنوان یک آیتم لیست برمی‌گرداند.
as Multiple Choice Item() Multiple Choice Item آیتم را به عنوان یک آیتم چند گزینه‌ای برمی‌گرداند.
as Page Break Item() Page Break Item آیتم را به عنوان یک آیتم page-break برمی‌گرداند.
as Paragraph Text Item() Paragraph Text Item آیتم را به عنوان یک آیتم متنی پاراگرافی برمی‌گرداند.
as Rating Item() Rating Item آیتم را به عنوان یک آیتم رتبه‌بندی برمی‌گرداند.
as Scale Item() Scale Item آیتم را به عنوان یک آیتم مقیاس‌پذیر برمی‌گرداند.
as Section Header Item() Section Header Item آیتم را به عنوان یک آیتم سربرگ بخش برمی‌گرداند.
as Text Item() Text Item آیتم را به عنوان یک آیتم متنی برمی‌گرداند.
as Time Item() Time Item آیتم را به عنوان یک آیتم زمانی برمی‌گرداند.
as Video Item() Video Item آیتم را به عنوان یک آیتم ویدیویی برمی‌گرداند.
duplicate() Item یک کپی از این آیتم ایجاد می‌کند و آن را به انتهای فرم اضافه می‌کند.
get Help Text() String متن راهنمای آیتم (که گاهی اوقات برای آیتم‌های طرح‌بندی مانند Image Items ، Page Break Items و Section Header Items متن توضیحات نامیده می‌شود) را دریافت می‌کند.
get Id() Integer شناسه منحصر به فرد کالا را دریافت می‌کند.
get Index() Integer اندیس آیتم را از بین تمام آیتم‌های موجود در فرم دریافت می‌کند.
get Title() String عنوان آیتم (که گاهی اوقات در مورد Section Header Item ، متن سربرگ نامیده می‌شود) را برمی‌گرداند.
get Type() Item Type نوع آیتم را که به صورت Item Type نمایش داده می‌شود، دریافت می‌کند.
set Help Text(text) Item متن راهنمای آیتم را تنظیم می‌کند (گاهی اوقات برای آیتم‌های طرح‌بندی مانند Image Items ، Page Break Items و Section Header Items متن توضیحات نامیده می‌شود).
set Title(title) Item عنوان آیتم را تنظیم می‌کند (که گاهی اوقات در مورد Section Header Item ، متن سربرگ نامیده می‌شود).

مستندات دقیق

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()

آیتم را به عنوان یک آیتم page-break برمی‌گرداند. اگر 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()

آیتم را به عنوان یک آیتم دارای امتیاز برمی‌گرداند. اگر 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 ، متن توضیحات نامیده می‌شود).

پارامترها

نام نوع توضیحات
text String متن کمک جدید

بازگشت

Item — این Item ، برای زنجیره‌سازی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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

setTitle(title)

عنوان آیتم را تنظیم می‌کند (که گاهی اوقات در مورد SectionHeaderItem ، متن سربرگ نامیده می‌شود).

پارامترها

نام نوع توضیحات
title String عنوان یا متن سربرگ جدید

بازگشت

Item — این Item ، برای زنجیره‌سازی

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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