Class ListItem

آیتم لیست

یک آیتم سوالی که به پاسخ‌دهنده اجازه می‌دهد از یک لیست کشویی یک گزینه را انتخاب کند. آیتم‌ها را می‌توان از طریق یک Form دسترسی پیدا کرد یا ایجاد کرد.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?').setChoices([
  item.createChoice('Cats'), item.createChoice('Dogs')
]);

روش‌ها

روش نوع بازگشتی شرح مختصر
create Choice(value) Choice انتخابی جدید ایجاد می‌کند.
create Choice(value, isCorrect) Choice انتخابی جدید ایجاد می‌کند.
create Choice(value, navigationItem) Choice یک انتخاب جدید با گزینه پیمایش صفحه ایجاد می‌کند که به یک آیتم پرش صفحه‌ای مشخص پرش می‌کند.
create Choice(value, navigationType) Choice یک انتخاب جدید با گزینه پیمایش صفحه ایجاد می‌کند.
create Response(response) Item Response یک Item Response جدید برای این آیتم لیست ایجاد می‌کند.
duplicate() List Item یک کپی از این آیتم ایجاد می‌کند و آن را به انتهای فرم اضافه می‌کند.
get Choices() Choice[] تمام گزینه‌های مربوط به یک آیتم را دریافت می‌کند.
get Feedback For Correct() Quiz Feedback |null بازخوردی را که به پاسخ‌دهندگان هنگام پاسخ صحیح به یک سوال نشان داده می‌شود، برمی‌گرداند.
get Feedback For Incorrect() Quiz Feedback |null بازخوردی را که به پاسخ‌دهندگان هنگام پاسخ نادرست به یک سوال نشان داده می‌شود، برمی‌گرداند.
get Help Text() String متن راهنمای آیتم (که گاهی اوقات برای آیتم‌های طرح‌بندی مانند Image Items ، Page Break Items و Section Header Items متن توضیحات نامیده می‌شود) را دریافت می‌کند.
get Id() Integer شناسه منحصر به فرد کالا را دریافت می‌کند.
get Index() Integer اندیس آیتم را از بین تمام آیتم‌های موجود در فرم دریافت می‌کند.
get Points() Integer مقدار امتیاز یک آیتم قابل درجه‌بندی را برمی‌گرداند.
get Title() String عنوان آیتم (که گاهی اوقات در مورد Section Header Item ، متن سربرگ نامیده می‌شود) را برمی‌گرداند.
get Type() Item Type نوع آیتم را که به صورت Item Type نمایش داده می‌شود، دریافت می‌کند.
is Required() Boolean مشخص می‌کند که آیا پاسخ‌دهنده باید به سوال پاسخ دهد یا خیر.
set Choice Values(values) List Item انتخاب‌های یک آیتم را از آرایه‌ای از رشته‌ها تنظیم می‌کند.
set Choices(choices) List Item آرایه‌ای از گزینه‌ها را برای یک آیتم تنظیم می‌کند.
set Feedback For Correct(feedback) List Item تنظیم می‌کند که وقتی پاسخ صحیح به یک سوال داده می‌شود، بازخورد به پاسخ‌دهندگان نشان داده شود.
set Feedback For Incorrect(feedback) List Item تنظیم می‌کند که در صورت پاسخ نادرست پاسخ‌دهندگان به یک سوال، بازخوردی به آنها نشان داده شود.
set Help Text(text) List Item متن راهنمای آیتم را تنظیم می‌کند (گاهی اوقات برای آیتم‌های طرح‌بندی مانند Image Items ، Page Break Items و Section Header Items متن توضیحات نامیده می‌شود).
set Points(points) List Item تعداد امتیازاتی را که یک آیتم قابل رتبه‌بندی دارد، تعیین می‌کند.
set Required(enabled) List Item مشخص می‌کند که آیا پاسخ‌دهنده باید به سوال پاسخ دهد یا خیر.
set Title(title) List Item عنوان آیتم را تنظیم می‌کند (که گاهی اوقات در مورد Section Header Item ، متن سربرگ نامیده می‌شود).

مستندات دقیق

createChoice(value)

انتخابی جدید ایجاد می‌کند.

پارامترها

نام نوع توضیحات
value String ارزش انتخاب، که پاسخ‌دهندگان هنگام مشاهده فرم به عنوان یک برچسب می‌بینند

بازگشت

Choice - انتخاب جدید

مجوز

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

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

createChoice(value, isCorrect)

انتخابی جدید ایجاد می‌کند.

پارامترها

نام نوع توضیحات
value String ارزش انتخاب، که پاسخ‌دهندگان هنگام مشاهده فرم به عنوان یک برچسب می‌بینند
is Correct Boolean آیا گزینه انتخاب شده، پاسخ صحیح است یا خیر

بازگشت

Choice - انتخاب جدید

مجوز

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

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

createChoice(value, navigationItem)

یک انتخاب جدید با گزینه پیمایش صفحه ایجاد می‌کند که به یک آیتم پرش صفحه‌ای مشخص پرش می‌کند. این معادل createChoice(value, navigationType) با تنظیم navigationType روی FormApp.PageNavigationType.GO_TO_PAGE است. انتخاب‌هایی که از پیمایش صفحه استفاده می‌کنند را نمی‌توان در یک آیتم با انتخاب‌هایی که از پیمایش صفحه استفاده نمی‌کنند، ترکیب کرد.

پیمایش صفحه پس از اینکه پاسخ‌دهنده صفحه‌ای را که حاوی گزینه مورد نظر است، تکمیل کند، و تنها در صورتی که پاسخ‌دهنده آن گزینه را انتخاب کرده باشد، رخ می‌دهد. اگر پاسخ‌دهنده چندین گزینه را با دستورالعمل‌های پیمایش صفحه در یک صفحه انتخاب کرده باشد، فقط آخرین گزینه پیمایش تأثیر دارد. پیمایش صفحه همچنین هیچ تأثیری بر آخرین صفحه فرم ندارد.

توجه داشته باشید که استفاده از پیمایش صفحه روی یک آیتم، مسیریابی را به صورت hardcodes در می‌آورد، به این معنی که showOtherOption(true) نباید همزمان استفاده شود.

پارامترها

نام نوع توضیحات
value String ارزش انتخاب، که پاسخ‌دهندگان هنگام مشاهده فرم به عنوان یک برچسب می‌بینند
navigation Item Page Break Item موردی که باید به آن بروید

بازگشت

Choice - انتخاب جدید

مجوز

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

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

createChoice(value, navigationType)

یک انتخاب جدید با گزینه پیمایش صفحه ایجاد می‌کند. انتخاب‌هایی که از پیمایش صفحه استفاده می‌کنند را نمی‌توان در یک آیتم با انتخاب‌هایی که از پیمایش صفحه استفاده نمی‌کنند ترکیب کرد.

پیمایش صفحه پس از اینکه پاسخ‌دهنده صفحه‌ای را که حاوی گزینه مورد نظر است، تکمیل کند، و تنها در صورتی که پاسخ‌دهنده آن گزینه را انتخاب کرده باشد، رخ می‌دهد. اگر پاسخ‌دهنده چندین گزینه را با دستورالعمل‌های پیمایش صفحه در یک صفحه انتخاب کرده باشد، فقط آخرین گزینه پیمایش تأثیر دارد. پیمایش صفحه همچنین هیچ تأثیری بر آخرین صفحه فرم ندارد.

توجه داشته باشید که استفاده از پیمایش صفحه روی یک آیتم، مسیریابی را به صورت hardcodes در می‌آورد، به این معنی که showOtherOption(true) نباید همزمان استفاده شود.

پارامترها

نام نوع توضیحات
value String ارزش انتخاب، که پاسخ‌دهندگان هنگام مشاهده فرم به عنوان یک برچسب می‌بینند
navigation Type Page Navigation Type نوع ناوبری انتخاب شده

بازگشت

Choice - انتخاب جدید

مجوز

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

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

createResponse(response)

یک ItemResponse جدید برای این آیتم لیست ایجاد می‌کند. اگر آرگومان response با یک انتخاب معتبر برای این آیتم مطابقت نداشته باشد، یک استثنا ایجاد می‌کند.

پارامترها

نام نوع توضیحات
response String یک پاسخ معتبر برای این مورد از لیست

بازگشت

ItemResponse — پاسخ آیتم

مجوز

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

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

duplicate()

یک کپی از این آیتم ایجاد می‌کند و آن را به انتهای فرم اضافه می‌کند.

بازگشت

ListItem - یک کپی از این ListItem ، برای زنجیره‌سازی

مجوز

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

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

getChoices()

تمام گزینه‌های مربوط به یک آیتم را دریافت می‌کند.

بازگشت

Choice[] — مجموعه‌ای از انتخاب‌ها

مجوز

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

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

getFeedbackForCorrect()

بازخوردی را که به پاسخ‌دهندگان هنگام پاسخ صحیح به یک سوال نشان داده می‌شود، برمی‌گرداند.

بازگشت

QuizFeedback |null — بازخورد، در صورت وجود.

مجوز

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

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

getFeedbackForIncorrect()

بازخوردی را که به پاسخ‌دهندگان هنگام پاسخ نادرست به یک سوال نشان داده می‌شود، برمی‌گرداند.

بازگشت

QuizFeedback |null — بازخورد، در صورت وجود.

مجوز

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

  • 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

getPoints()

مقدار امتیاز یک آیتم قابل درجه‌بندی را برمی‌گرداند.

بازگشت

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

isRequired()

مشخص می‌کند که آیا پاسخ‌دهنده باید به سوال پاسخ دهد یا خیر.

بازگشت

Boolean - اینکه آیا پاسخ‌دهنده باید به سوال پاسخ دهد یا خیر

مجوز

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

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

setChoiceValues(values)

گزینه‌های مربوط به یک آیتم از آرایه‌ای از رشته‌ها را تنظیم می‌کند. اگر آرایه داده شده خالی باشد، استثنا ایجاد می‌کند.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoiceValues(['Dogs', 'Cats']);

پارامترها

نام نوع توضیحات
values String[] آرایه‌ای از مقادیر انتخابی، که پاسخ‌دهندگان هنگام مشاهده فرم به عنوان برچسب می‌بینند

بازگشت

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

مجوز

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

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

setChoices(choices)

آرایه‌ای از گزینه‌ها را برای یک آیتم تنظیم می‌کند. اگر آرایه داده شده خالی باشد یا شامل عنصر null باشد، استثنا ایجاد می‌کند.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
item.setChoices([item.createChoice('Cats'), item.createChoice('Dogs')]);

پارامترها

نام نوع توضیحات
choices Choice[] مجموعه‌ای از انتخاب‌ها

بازگشت

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

پرتاب‌ها

Error - اگر آرایه داده شده null ، خالی یا حاوی عنصر null باشد

مجوز

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

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

setFeedbackForCorrect(feedback)

تنظیم می‌کند که وقتی پاسخ صحیح به یک سوال داده می‌شود، بازخورد به پاسخ‌دهندگان نشان داده شود.

// Open a form by ID and add a new list item.
const form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
const item = form.addListItem();
item.setTitle('Do you prefer cats or dogs?');
// Set "Dogs" as the correct answer to this question.
item.setChoices([
  item.createChoice('Dogs', true),
  item.createChoice('Cats', false),
]);
// Add feedback which will be shown for correct responses; ie "Dogs".
item.setFeedbackForCorrect(
    FormApp.createFeedback().setText('Dogs rule, cats drool.').build(),
);

پارامترها

نام نوع توضیحات
feedback Quiz Feedback بازخورد جدید. مقدار تهی، بازخورد را پاک می‌کند.

بازگشت

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

مجوز

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

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

setFeedbackForIncorrect(feedback)

تنظیم می‌کند که در صورت پاسخ نادرست پاسخ‌دهندگان به یک سوال، بازخوردی به آنها نشان داده شود.

پارامترها

نام نوع توضیحات
feedback Quiz Feedback بازخورد جدید

بازگشت

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

مجوز

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

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

setHelpText(text)

متن راهنمای آیتم را تنظیم می‌کند (گاهی اوقات برای آیتم‌های طرح‌بندی مانند ImageItems ، PageBreakItems و SectionHeaderItems ، متن توضیحات نامیده می‌شود).

پارامترها

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

بازگشت

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

مجوز

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

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

setPoints(points)

تعداد امتیازی که یک آیتم قابل رتبه‌بندی دارد را تعیین می‌کند. مقدار پیش‌فرض برای آیتم‌های جدید 0 است.

پارامترها

نام نوع توضیحات
points Integer تعداد امتیازی که یک سوال دارد

بازگشت

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

مجوز

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

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

setRequired(enabled)

مشخص می‌کند که آیا پاسخ‌دهنده باید به سوال پاسخ دهد یا خیر.

پارامترها

نام نوع توضیحات
enabled Boolean آیا پاسخگو باید به سوال پاسخ دهد یا خیر

بازگشت

ListItem — آیتم فعلی (برای زنجیره‌سازی)

مجوز

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

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

setTitle(title)

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

پارامترها

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

بازگشت

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

مجوز

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

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