Forms Service

透過集合功能整理內容 你可以依據偏好儲存及分類內容。
表單

這項服務可讓指令碼建立、存取及修改 Google 表單。

// Create a new form, then add a checkbox question, a multiple choice question,
// a page break, then a date question and a grid of questions.
var form = FormApp.create('New Form');
var item = form.addCheckboxItem();
item.setTitle('What condiments would you like on your hot dog?');
item.setChoices([
        item.createChoice('Ketchup'),
        item.createChoice('Mustard'),
        item.createChoice('Relish')
    ]);
form.addMultipleChoiceItem()
    .setTitle('Do you prefer cats or dogs?')
    .setChoiceValues(['Cats','Dogs'])
    .showOtherOption(true);
form.addPageBreakItem()
    .setTitle('Getting to know you');
form.addDateItem()
    .setTitle('When were you born?');
form.addGridItem()
    .setTitle('Rate your interests')
    .setRows(['Cars', 'Computers', 'Celebrities'])
    .setColumns(['Boring', 'So-so', 'Interesting']);
Logger.log('Published URL: ' + form.getPublishedUrl());
Logger.log('Editor URL: ' + form.getEditUrl());

類別

名稱簡短說明
Alignment列舉支援的圖片對齊類型列舉。
CheckboxGridItem以欄和列格線呈現的問題項目,可讓作答者從核取方塊序列中選取多個選項。
CheckboxGridValidation適用於 CheckboxGridItem 的 DataValidation。
CheckboxGridValidationBuilder適用於 CheckboxGridValidation 的 DataValidationBuilder。
CheckboxItem讓作答者選取一或多個核取方塊,以及選用的「其他」欄位的問題。
CheckboxValidation適用於 CheckboxItem 的 DataValidation。
CheckboxValidationBuilder適用於 CheckboxValidation 的 DataValidationBuilder。
Choice與支援 Item 類型的單一選項 (支援 CheckboxItemListItemMultipleChoiceItem) 等。
DateItem讓作答者指定日期的問題項目。
DateTimeItem讓作答者指定日期和時間的問題項目。
DestinationType列舉支援的表單回應目的地類型。
DurationItem讓作答者指定長度的問題項目。
FeedbackType列舉支援的意見回饋類型。
Form包含整體屬性和項目的表單。
FormApp允許指令碼開啟現有的 Form 或建立新的指令碼。
FormResponse整個表單的回應。
GridItem以項目和列格線呈現的問題項目,可讓作答者從一系列圓形按鈕選項中選取一個選項。
GridValidation適用於 GridItem 的 DataValidation。
GridValidationBuilder適用於 GridValidation 的 DataValidationBuilder。
ImageItem顯示圖片的版面配置項目。
Item一般表單項目,內含所有項目通用的屬性,例如標題和說明文字。
ItemResponse表單中的一個問題項目回覆。
ItemType列舉支援的表單項目類型列舉。
ListItem讓作答者從下拉式清單中選取一種選項。
MultipleChoiceItem一個問題項目,可讓作答者從圓形按鈕清單或選用的「其他」欄位中選取一個選項。
PageBreakItem標示網頁開始的版面配置項目。
PageNavigationType列舉支援的網頁導覽類型。
ParagraphTextItem讓作答者輸入一段文字的問題項目。
ParagraphTextValidation適用於 ParagraphTextItem 的 DataValidation。
ParagraphTextValidationBuilder適用於 ParagraphTextValidation 的 DataValidationBuilder。
QuizFeedback「意見回饋」的豆類實作,其中包含所有意見回饋通用的屬性,例如顯示文字或連結。
QuizFeedbackBuilder基本 FeedbackBuilder ,其中包含所有意見回饋通用的屬性 (例如顯示文字) 的 setter。
ScaleItem一個問題項目,可讓作答者從編號的圓形按鈕序列中選擇其中一個選項。
SectionHeaderItem版面配置項目,以視覺化方式呈現區塊的開頭。
TextItem讓作答者輸入一行文字的問題項目。
TextValidation適用於 TextItem 的 DataValidation。
TextValidationBuilder適用於 TextValidation 的 DataValidationBuilder。
TimeItem讓作答者指定時段的問題項目。
VideoItem顯示影片的版面配置項目。

Alignment

屬性

屬性類型說明
LEFTEnum將圖片對齊表單左側。
CENTEREnum將圖片對齊表單的中心。
RIGHTEnum將圖片對齊表單的右側。

CheckboxGridItem

方法

方法傳回類型簡短說明
clearValidation()CheckboxGridItem移除這個格線項目的所有資料驗證。
createResponse(responses)ItemResponse這會為這個核取方塊格線項目建立新的 ItemResponse
duplicate()CheckboxGridItem建立這個項目的副本,然後附加到表單結尾。
getColumns()String[]取得格線中每個資料欄的值。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getRows()String[]取得格線中每一列的值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
isRequired()Boolean判斷作答者是否需要回答問題。
setColumns(columns)CheckboxGridItem根據值陣列設定格線欄。
setHelpText(text)CheckboxGridItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setRequired(enabled)CheckboxGridItem設定作答者是否需要回答問題。
setRows(rows)CheckboxGridItem根據值陣列設定格線列。
setTitle(title)CheckboxGridItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。
setValidation(validation)CheckboxGridItem設定這個核取方塊格線項目的資料驗證。

CheckboxGridValidation

CheckboxGridValidationBuilder

方法

方法傳回類型簡短說明
requireLimitOneResponsePerColumn()CheckboxGridValidationBuilder格線項目每一欄最多需要一個回應。

CheckboxItem

方法

方法傳回類型簡短說明
clearValidation()CheckboxItem移除這個核取方塊項目的任何資料驗證。
createChoice(value)Choice建立新的選項。
createChoice(value, isCorrect)Choice建立新的選項。
createResponse(responses)ItemResponse為這個核取方塊項目建立新的 ItemResponse
duplicate()CheckboxItem建立這個項目的副本,然後附加到表單結尾。
getChoices()Choice[]取得特定項目的所有選項。
getFeedbackForCorrect()QuizFeedback傳回作答者在正確回答問題時看到的意見回饋。
getFeedbackForIncorrect()QuizFeedback傳回作答者在未正確回答問題時提供的意見回饋。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
hasOtherOption()Boolean判斷該項目是否設有「other」選項。
isRequired()Boolean判斷作答者是否需要回答問題。
setChoiceValues(values)CheckboxItem從字串陣列設定項目的選項。
setChoices(choices)CheckboxItem設定項目的選項陣列。
setFeedbackForCorrect(feedback)CheckboxItem設定當作答者正確回答問題時,應顯示意見回饋。
setFeedbackForIncorrect(feedback)CheckboxItem設定當作答者未正確回答問題時,是否要顯示意見回饋。
setHelpText(text)CheckboxItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setPoints(points)CheckboxItem設定可評分項目的數值。
setRequired(enabled)CheckboxItem設定作答者是否需要回答問題。
setTitle(title)CheckboxItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。
setValidation(validation)CheckboxItem設定這個核取方塊項目的資料驗證。
showOtherOption(enabled)CheckboxItem設定該項目是否提供「other」選項。

CheckboxValidation

CheckboxValidationBuilder

方法

方法傳回類型簡短說明
requireSelectAtLeast(number)CheckboxValidationBuilder至少要選取這個項目。
requireSelectAtMost(number)CheckboxValidationBuilder最多只能選取一個選項。
requireSelectExactly(number)CheckboxValidationBuilder必須選取這麼多選項,才能選取。

Choice

方法

方法傳回類型簡短說明
getGotoPage()PageBreakItem如果作答者選取這個選項,並將 PageBreakItem 設為 GO_TO_PAGE 目的地,並完成目前頁面即可。
getPageNavigationType()PageNavigationType如果作答者選取這個選項,系統就會完成 PageNavigationType,則會完成目前的頁面。
getValue()String取得選擇值,作答者在查看表單時會看到一個標籤。
isCorrectAnswer()Boolean判斷問題是否是該問題的正確答案。

DateItem

方法

方法傳回類型簡短說明
createResponse(response)ItemResponse為這個日期項目建立新的 ItemResponse
duplicate()DateItem建立這個項目的副本,然後附加到表單結尾。
getGeneralFeedback()QuizFeedback傳回作答者在可評分成績時看到的回應。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
includesYear()Boolean決定日期項目是否包含年份選項。
isRequired()Boolean判斷作答者是否需要回答問題。
setGeneralFeedback(feedback)DateItem讓作答者在沒有正確答案或正確答案 (例如需要手動評分的問題) 的情況下,針對作答者顯示意見回饋。
setHelpText(text)DateItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setIncludesYear(enableYear)DateItem設定日期項目是否包含年份設定。
setPoints(points)DateItem設定可評分項目的數值。
setRequired(enabled)DateItem設定作答者是否需要回答問題。
setTitle(title)DateItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

DateTimeItem

方法

方法傳回類型簡短說明
createResponse(response)ItemResponse為這個日期時間項目建立新的ItemResponse
duplicate()DateTimeItem建立這個項目的副本,然後附加到表單結尾。
getGeneralFeedback()QuizFeedback傳回作答者在可評分成績時看到的回應。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
includesYear()Boolean決定日期項目是否包含年份選項。
isRequired()Boolean判斷作答者是否需要回答問題。
setGeneralFeedback(feedback)DateTimeItem讓作答者在沒有正確答案或正確答案 (例如需要手動評分的問題) 的情況下,針對作答者顯示意見回饋。
setHelpText(text)DateTimeItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setIncludesYear(enableYear)DateTimeItem設定日期項目是否包含年份設定。
setPoints(points)DateTimeItem設定可評分項目的數值。
setRequired(enabled)DateTimeItem設定作答者是否需要回答問題。
setTitle(title)DateTimeItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

DestinationType

屬性

屬性類型說明
SPREADSHEETEnumGoogle 試算表做為表單回應目的地。

DurationItem

方法

方法傳回類型簡短說明
createResponse(hours, minutes, seconds)ItemResponse為這個日期項目建立新的 ItemResponse
duplicate()DurationItem建立這個項目的副本,然後附加到表單結尾。
getGeneralFeedback()QuizFeedback傳回作答者在可評分成績時看到的回應。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
isRequired()Boolean判斷作答者是否需要回答問題。
setGeneralFeedback(feedback)DurationItem讓作答者在沒有正確答案或正確答案 (例如需要手動評分的問題) 的情況下,針對作答者顯示意見回饋。
setHelpText(text)DurationItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setPoints(points)DurationItem設定可評分項目的數值。
setRequired(enabled)DurationItem設定作答者是否需要回答問題。
setTitle(title)DurationItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

FeedbackType

屬性

屬性類型說明
CORRECTEnum自動為作答者顯示問題的正確答案。
INCORRECTEnum自動為作答者提供正確答案的意見回饋。
GENERALEnum作答者會在提交回應時自動顯示意見回饋。

Form

方法

方法傳回類型簡短說明
addCheckboxGridItem()CheckboxGridItem附加新的問題項目,以欄和列的格線呈現,讓要求者從核取方塊序列中選取多個選項。
addCheckboxItem()CheckboxItem附加新的問題項目,讓作答者選取一或多個核取方塊,以及選用的「其他」欄位。
addDateItem()DateItem附加新的問題項目,允許作答者指定日期。
addDateTimeItem()DateTimeItem附加新的問題項目,讓作答者指定日期和時間。
addDurationItem()DurationItem附加新的問題項目,讓作答者指定的時間長度。
addEditor(emailAddress)Form將指定使用者新增至 Form 的編輯者清單。
addEditor(user)Form將指定使用者新增至 Form 的編輯者清單。
addEditors(emailAddresses)Form將指定使用者陣列新增至 Form 的編輯者清單。
addGridItem()GridItem附加一個新的問題項目,以欄和列的格線呈現,讓要求者從一系列圓形按鈕組合中選取一個選項。
addImageItem()ImageItem附加顯示圖片的新版面配置項目。
addListItem()ListItem附加新的問題項目,讓作答者從下拉式清單中選取一個選項。
addMultipleChoiceItem()MultipleChoiceItem附加新的問題項目,讓作答者可從圓形按鈕選項或「其他」欄位中選取一個選項。
addPageBreakItem()PageBreakItem附加標示為頁面開始的新版面配置項目。
addParagraphTextItem()ParagraphTextItem附加新的問題項目,讓作答者輸入一段文字。
addScaleItem()ScaleItem附加新的問題項目,讓作答者從有編號的圓形按鈕選項中選取一個選項。
addSectionHeaderItem()SectionHeaderItem附加視覺元素,以視覺元素表示區塊的起點。
addTextItem()TextItem附加新的問題項目,讓作答者輸入一行文字。
addTimeItem()TimeItem附加新問題,讓作答者指定時段。
addVideoItem()VideoItem附加顯示影片的新版面配置項目。
canEditResponse()Boolean決定表單是否要在提交回覆後顯示修改回覆的連結。
collectsEmail()Boolean決定表單是否收集作答者'電子郵件地址。
createResponse()FormResponse建立新的表單回應。
deleteAllResponses()Form從表單回覆庫中刪除所有已提交的回應。
deleteItem(index)void刪除表單中所有項目的指定索引項目。
deleteItem(item)void刪除指定項目。
deleteResponse(responseId)Form從表單的回應位置刪除單一回應。
getConfirmationMessage()String取得表單的確認訊息。
getCustomClosedFormMessage()String取得表單在表單不接受回應時顯示的自訂訊息,如未設定自訂訊息,則會顯示空白字串。
getDescription()String取得表單說明。
getDestinationId()String取得表單回應目的地的 ID。
getDestinationType()DestinationType取得表單回應目的地的類型。
getEditUrl()String取得可用來存取表單編輯模式的網址。
getEditors()User[]取得這個Form的編輯者清單。
getId()String取得表單的 ID。
getItemById(id)Item取得具有指定 ID 的項目。
getItems()Item[]取得表單中所有項目的陣列。
getItems(itemType)Item[]取得指定類型所有項目的陣列。
getPublishedUrl()String取得可用來回應表單的網址。
getResponse(responseId)FormResponse根據回應 ID 取得單一表單回應。
getResponses()FormResponse[]取得所有表單回應的陣列。
getResponses(timestamp)FormResponse[]取得特定日期和時間之後所有表單回應的陣列。
getShuffleQuestions()Boolean決定表單上各個頁面的問題順序是否隨機。
getSummaryUrl()String取得用於查看表單回應摘要的網址。
getTitle()String取得表單標題。
hasLimitOneResponsePerUser()Boolean決定表單是否允許每個作答者只回覆一次。
hasProgressBar()Boolean決定表單是否顯示進度列。
hasRespondAgainLink()Boolean決定表單是否要在作答者填寫表單後提交其他回應。
isAcceptingResponses()Boolean判斷表單目前是否接受回應。
isPublishingSummary()Boolean決定表單是否要在作答者填妥表單後查看回覆摘要。
isQuiz()Boolean判定表單是否為測驗。
moveItem(from, to)Item將表單中任一項目的項目移至另一個指定的索引。
moveItem(item, toIndex)Item將指定項目移至表單中的所有項目中的特定索引。
removeDestination()Form取消表單與目前的回覆目的地之間的連結。
removeEditor(emailAddress)FormForm 的編輯者清單中移除指定使用者。
removeEditor(user)FormForm 的編輯者清單中移除指定使用者。
requiresLogin()Boolean決定表單是否需要回應才能登入相同網域或子網域的帳戶。
setAcceptingResponses(enabled)Form設定表單目前是否接受回應。
setAllowResponseEdits(enabled)Form設定表單是否在提交表單後顯示編輯連結。
setCollectEmail(collect)Form設定表單是否收集作答者'電子郵件地址。
setConfirmationMessage(message)Form設定表單的確認訊息。
setCustomClosedFormMessage(message)Form設定表單在表單不接受回應時顯示的訊息。
setDescription(description)Form設定表單的說明。
setDestination(type, id)Form設定儲存表單回覆的目的地。
setIsQuiz(enabled)Form設定表單是否為測驗。
setLimitOneResponsePerUser(enabled)Form設定表單是否允許每個作答者只能回覆一次。
setProgressBar(enabled)Form設定表單是否有進度列。
setPublishingSummary(enabled)Form設定表單是否要在作答者提交表單後顯示回覆摘要連結。
setRequireLogin(requireLogin)Form設定表單是否需要作答者登入相同網域或子網域的帳戶,然後再回應。
setShowLinkToRespondAgain(enabled)Form設定表單是否要在作答者填寫表單後顯示提交其他回應的連結。
setShuffleQuestions(shuffle)Form設定表單中每個頁面的問題順序是否隨機。
setTitle(title)Form設定表單的標題。
shortenFormUrl(url)String將表單的長網址轉換成短網址。
submitGrades(responses)Form提交特定表單回應的成績。

FormApp

屬性

屬性類型說明
AlignmentAlignment列舉圖片類型。
DestinationTypeDestinationType可儲存表單回應的目的地類型列舉。
FeedbackTypeFeedbackType列舉 Feedbacks 類型的類型。
ItemTypeItemType列舉 Items 類型的類型。
PageNavigationTypePageNavigationType列舉可能瀏覽網頁行為的行為。

方法

方法傳回類型簡短說明
create(title)Form建立並傳回新的 Form
createCheckboxGridValidation()CheckboxGridValidationBuilder傳回 CheckboxGridValidationBuilder 的執行個體,可用於設定 CheckboxGridItem 上的驗證程序。
createCheckboxValidation()CheckboxValidationBuilder傳回 CheckboxAuthenticationBuilder 的執行個體,可用於設定 CheckboxItem 上的驗證程序。
createFeedback()QuizFeedbackBuilder傳回 QuizFeedbackBuilder 的執行個體,可用於在可評分的 Item 上設定意見回饋。
createGridValidation()GridValidationBuilder傳回 GridValidationBuilder 的執行個體,可用於設定 GridItem 上的驗證程序。
createParagraphTextValidation()ParagraphTextValidationBuilder傳回 ParagraphTextVerificationBuilder 的執行個體,可用於設定 ParagraphTextItem 的驗證。
createTextValidation()TextValidationBuilder傳回 TextVerificationBuilder 的執行個體,可用於設定 TextItem 的驗證程序。
getActiveForm()Form傳回指令碼容器繫結的形式。
getUi()Ui傳回表單編輯器使用者介面的執行個體,允許指令碼新增選單、對話方塊和側欄等功能。
openById(id)Form傳回含有指定 ID 的 Form
openByUrl(url)Form傳回含有指定網址的 Form

FormResponse

方法

方法傳回類型簡短說明
getEditResponseUrl()String產生網址,用於編輯已提交的回應。
getGradableItemResponses()ItemResponse[]取得表單回應中的所有項目回應,其順序與表單中顯示的項目相同。
getGradableResponseForItem(item)ItemResponse取得特定商品表單回應中的商品回應。
getId()String取得表單回應的 ID。
getItemResponses()ItemResponse[]取得表單回應中的所有項目回應,其順序與表單中顯示的項目相同。
getRespondentEmail()String如果啟用 Form.setCollectEmail(collect) 設定,則取得提交者的電子郵件地址。
getResponseForItem(item)ItemResponse針對特定項目取得這份表單回應中的項目回應。
getTimestamp()Date取得表單回應的時間戳記。
submit()FormResponse提交回應。
toPrefilledUrl()String根據這個表單回應中的答案,為表單預先填入答案網址。
withItemGrade(gradedResponse)FormResponse將指定項目回應新增至表單回應。
withItemResponse(response)FormResponse將特定項目回應新增至表單回應。

GridItem

方法

方法傳回類型簡短說明
clearValidation()GridItem移除這個格線項目的所有資料驗證。
createResponse(responses)ItemResponse為這個格線項目建立新的 ItemResponse
duplicate()GridItem建立這個項目的副本,然後附加到表單結尾。
getColumns()String[]取得格線中每個資料欄的值。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getRows()String[]取得格線中每一列的值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
isRequired()Boolean判斷作答者是否需要回答問題。
setColumns(columns)GridItem根據值陣列設定格線欄。
setHelpText(text)GridItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setRequired(enabled)GridItem設定作答者是否需要回答問題。
setRows(rows)GridItem根據值陣列設定格線列。
setTitle(title)GridItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。
setValidation(validation)GridItem設定這個格狀項目的資料驗證。

GridValidation

GridValidationBuilder

方法

方法傳回類型簡短說明
requireLimitOneResponsePerColumn()GridValidationBuilder格線項目每一欄最多需要一個回應。

ImageItem

方法

方法傳回類型簡短說明
duplicate()ImageItem建立這個項目的副本,然後附加到表單結尾。
getAlignment()Alignment取得圖片的水平對齊方式。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getImage()Blob取得目前指派給該項目的圖片。
getIndex()Integer取得表單中所有商品的索引。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
getWidth()Integer取得圖片的寬度 (以像素為單位)
setAlignment(alignment)ImageItem設定圖片的水平對齊方式。
setHelpText(text)ImageItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setImage(image)ImageItem設定圖片本身。
setTitle(title)ImageItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。
setWidth(width)ImageItem設定圖片的寬度 (以像素為單位)。

Item

方法

方法傳回類型簡短說明
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取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
setHelpText(text)Item設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setTitle(title)Item設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

ItemResponse

方法

方法傳回類型簡短說明
getFeedback()Object取得作答者根據答案提交的意見回饋。
getItem()Item取得這則回應所回答的問題,
getResponse()Object取得作答者提交的答案。
getScore()Object取得作答者提交答案的分數。
setFeedback(feedback)ItemResponse設定要針對作答者的答案顯示哪些意見回饋。
setScore(score)ItemResponse設定已提交答案的分數。

ItemType

屬性

屬性類型說明
CHECKBOXEnum讓作答者選取一或多個核取方塊,以及選用的「其他」欄位的問題。
CHECKBOX_GRIDEnum以欄和列格線呈現的問題項目,可讓作答者從核取方塊序列中選取多個選項。
DATEEnum讓作答者指定日期的問題項目。
DATETIMEEnum讓作答者指定日期和時間的問題項目。
DURATIONEnum讓作答者指定長度的問題項目。
GRIDEnum以項目和列格線呈現的問題項目,可讓作答者從一系列圓形按鈕選項中選取一個選項。
IMAGEEnum顯示圖片的版面配置項目。
LISTEnum讓作答者從下拉式清單中選取一種選項。
MULTIPLE_CHOICEEnum一個問題項目,可讓作答者從圓形按鈕清單或選用的「其他」欄位中選取一個選項。
PAGE_BREAKEnum標示網頁開始的版面配置項目。
PARAGRAPH_TEXTEnum讓作答者輸入一段文字的問題項目。
SCALEEnum一個問題項目,可讓作答者從編號的圓形按鈕序列中選擇其中一個選項。
SECTION_HEADEREnum版面配置項目,以視覺化方式呈現區塊的開頭。
TEXTEnum讓作答者輸入一行文字的問題項目。
TIMEEnum讓作答者指定時段的問題項目。
VIDEOEnum顯示 YouTube 影片的版面配置項目。
FILE_UPLOADEnum讓作答者上傳檔案的問題問題。

ListItem

方法

方法傳回類型簡短說明
createChoice(value)Choice建立新的選項。
createChoice(value, isCorrect)Choice建立新的選項。
createChoice(value, navigationItem)Choice建立新頁面,並搭配前往特定網頁符號的項目瀏覽頁面選項。
createChoice(value, navigationType)Choice使用頁面瀏覽選項建立新選項。
createResponse(response)ItemResponse為這個清單項目建立新的 ItemResponse
duplicate()ListItem建立這個項目的副本,然後附加到表單結尾。
getChoices()Choice[]取得特定項目的所有選項。
getFeedbackForCorrect()QuizFeedback傳回作答者在正確回答問題時看到的意見回饋。
getFeedbackForIncorrect()QuizFeedback傳回作答者在未正確回答問題時提供的意見回饋。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
isRequired()Boolean判斷作答者是否需要回答問題。
setChoiceValues(values)ListItem從字串陣列設定項目的選項。
setChoices(choices)ListItem設定項目的選項陣列。
setFeedbackForCorrect(feedback)ListItem設定當作答者正確回答問題時,應顯示意見回饋。
setFeedbackForIncorrect(feedback)ListItem設定當作答者未正確回答問題時,是否要顯示意見回饋。
setHelpText(text)ListItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setPoints(points)ListItem設定可評分項目的數值。
setRequired(enabled)ListItem設定作答者是否需要回答問題。
setTitle(title)ListItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

MultipleChoiceItem

方法

方法傳回類型簡短說明
createChoice(value)Choice建立新的選項。
createChoice(value, isCorrect)Choice建立新的選項。
createChoice(value, navigationItem)Choice建立新頁面,並搭配前往特定網頁符號的項目瀏覽頁面選項。
createChoice(value, navigationType)Choice使用頁面瀏覽選項建立新選項。
createResponse(response)ItemResponse為這個選擇題建立新的 ItemResponse
duplicate()MultipleChoiceItem建立這個項目的副本,然後附加到表單結尾。
getChoices()Choice[]取得特定項目的所有選項。
getFeedbackForCorrect()QuizFeedback傳回作答者在正確回答問題時看到的意見回饋。
getFeedbackForIncorrect()QuizFeedback傳回作答者在未正確回答問題時提供的意見回饋。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
hasOtherOption()Boolean判斷該項目是否設有「other」選項。
isRequired()Boolean判斷作答者是否需要回答問題。
setChoiceValues(values)MultipleChoiceItem從字串陣列設定項目的選項。
setChoices(choices)MultipleChoiceItem設定項目的選項陣列。
setFeedbackForCorrect(feedback)MultipleChoiceItem設定當作答者正確回答問題時,應顯示意見回饋。
setFeedbackForIncorrect(feedback)MultipleChoiceItem設定當作答者未正確回答問題時,是否要顯示意見回饋。
setHelpText(text)MultipleChoiceItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setPoints(points)MultipleChoiceItem設定可評分項目的數值。
setRequired(enabled)MultipleChoiceItem設定作答者是否需要回答問題。
setTitle(title)MultipleChoiceItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。
showOtherOption(enabled)MultipleChoiceItem設定該項目是否提供「other」選項。

PageBreakItem

方法

方法傳回類型簡短說明
duplicate()PageBreakItem建立這個項目的副本,然後附加到表單結尾。
getGoToPage()PageBreakItem取得在完成分頁符號之後,表單從該頁面跳至的 PageBreakItem (意即透過表單取得一般線性進度為止)。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPageNavigationType()PageNavigationType取得在完成分頁符號之後 (意即透過表單正常進行線性分頁抵達該分頁後) 發生的頁面導覽類型。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
setGoToPage(goToPageItem)PageBreakItem將頁面設為在完成分頁符號前 (例如透過表單以一般線性進度到達頁面符號) 後跳到的頁面。
setGoToPage(navigationType)PageBreakItem設定在完成頁面符號之前 (意即透過表單以一般線性進度到達該網頁分頁時) 發生的頁面瀏覽類型。
setHelpText(text)PageBreakItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setTitle(title)PageBreakItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

屬性

屬性類型說明
CONTINUEEnum請在完成目前的頁面後前往表單的下一頁。
GO_TO_PAGEEnum完成目前頁面後,直接前往表單的指定頁面。
RESTARTEnum從頭重新開始表單,但清除目前頁面後已清除的答案。
SUBMITEnum填寫目前的頁面後,必須提交表單。

ParagraphTextItem

方法

方法傳回類型簡短說明
clearValidation()ParagraphTextItem為這個段落文字項目移除資料驗證。
createResponse(response)ItemResponse為這個段落文字項目建立新的 ItemResponse
duplicate()ParagraphTextItem建立這個項目的副本,然後附加到表單結尾。
getGeneralFeedback()QuizFeedback傳回作答者在可評分成績時看到的回應。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
isRequired()Boolean判斷作答者是否需要回答問題。
setGeneralFeedback(feedback)ParagraphTextItem讓作答者在沒有正確答案或正確答案 (例如需要手動評分的問題) 的情況下,針對作答者顯示意見回饋。
setHelpText(text)ParagraphTextItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setPoints(points)ParagraphTextItem設定可評分項目的數值。
setRequired(enabled)ParagraphTextItem設定作答者是否需要回答問題。
setTitle(title)ParagraphTextItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。
setValidation(validation)ParagraphTextItem設定這個段落文字項目的資料驗證。

ParagraphTextValidation

ParagraphTextValidationBuilder

QuizFeedback

方法

方法傳回類型簡短說明
getLinkUrls()String[]取得與「意見回饋」相關聯的網址清單。
getText()String取得「意見回饋」的顯示文字。

QuizFeedbackBuilder

方法

方法傳回類型簡短說明
addLink(url)QuizFeedbackBuilder新增意見回饋補充連結。
addLink(url, displayText)QuizFeedbackBuilder新增意見回饋補充連結。
build()QuizFeedback為這個建構工具建構相應類型的意見回饋。
copy()QuizFeedbackBuilder傳回此建構工具的副本。
setText(text)QuizFeedbackBuilder設定意見回饋文字。

ScaleItem

方法

方法傳回類型簡短說明
createResponse(response)ItemResponse針對這個擴充項目建立新的 ItemResponse
duplicate()ScaleItem建立這個項目的副本,然後附加到表單結尾。
getGeneralFeedback()QuizFeedback傳回作答者在可評分成績時看到的回應。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getLeftLabel()String取得比例下限標籤 (如果有的話)。
getLowerBound()Integer取得比例範圍的下限。
getPoints()Integer傳回可評分項目的分數值。
getRightLabel()String取得縮放比例上限標籤 (如果有的話)。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
getUpperBound()Integer取得體重計的上限。
isRequired()Boolean判斷作答者是否需要回答問題。
setBounds(lower, upper)ScaleItem設定縮放比例的上下限。
setGeneralFeedback(feedback)ScaleItem讓作答者在沒有正確答案或正確答案 (例如需要手動評分的問題) 的情況下,針對作答者顯示意見回饋。
setHelpText(text)ScaleItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setLabels(lower, upper)ScaleItem設定縮放比例上限和上限。
setPoints(points)ScaleItem設定可評分項目的數值。
setRequired(enabled)ScaleItem設定作答者是否需要回答問題。
setTitle(title)ScaleItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

SectionHeaderItem

方法

方法傳回類型簡短說明
duplicate()SectionHeaderItem建立這個項目的副本,然後附加到表單結尾。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
setHelpText(text)SectionHeaderItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setTitle(title)SectionHeaderItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

TextItem

方法

方法傳回類型簡短說明
clearValidation()TextItem移除這個文字項目的任何資料驗證。
createResponse(response)ItemResponse對此文字項目建立新的 ItemResponse
duplicate()TextItem建立這個項目的副本,然後附加到表單結尾。
getGeneralFeedback()QuizFeedback傳回作答者在可評分成績時看到的回應。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
isRequired()Boolean判斷作答者是否需要回答問題。
setGeneralFeedback(feedback)TextItem讓作答者在沒有正確答案或正確答案 (例如需要手動評分的問題) 的情況下,針對作答者顯示意見回饋。
setHelpText(text)TextItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setPoints(points)TextItem設定可評分項目的數值。
setRequired(enabled)TextItem設定作答者是否需要回答問題。
setTitle(title)TextItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。
setValidation(validation)TextItem設定這個文字項目的資料驗證。

TextValidation

TextValidationBuilder

方法

方法傳回類型簡短說明
requireNumber()TextValidationBuilder文字項目必須是數字。
requireNumberBetween(start, end)TextValidationBuilder文字項目必須是介於開始到結束之間的數字 (含首尾)。
requireNumberEqualTo(number)TextValidationBuilder文字項目必須是等於指定數值的數字。
requireNumberGreaterThan(number)TextValidationBuilder文字項目必須是大於指定值的數字。
requireNumberGreaterThanOrEqualTo(number)TextValidationBuilder文字項目必須是大於或等於指定值的數字。
requireNumberLessThan(number)TextValidationBuilder文字項目的值必須是小於指定值的數字。
requireNumberLessThanOrEqualTo(number)TextValidationBuilder文字項目必須是小於或等於指定值的數字。
requireNumberNotBetween(start, end)TextValidationBuilder文字項目必須是介於開始與結束之間的數字 (含首尾)。
requireNumberNotEqualTo(number)TextValidationBuilder文字項目必須是小於指定值的數字。
requireTextContainsPattern(pattern)TextValidationBuilder需要回應以包含模式。
requireTextDoesNotContainPattern(pattern)TextValidationBuilder需要回應以包含模式。
requireTextDoesNotMatchPattern(pattern)TextValidationBuilder回應不符合格式。
requireTextIsEmail()TextValidationBuilder文字項目必須是電子郵件地址。
requireTextIsUrl()TextValidationBuilder文字項目必須是網址。
requireTextLengthGreaterThanOrEqualTo(number)TextValidationBuilder回應長度必須大於或等於值。
requireTextLengthLessThanOrEqualTo(number)TextValidationBuilder回應長度必須小於值。
requireTextMatchesPattern(pattern)TextValidationBuilder需要回應才能比對模式。
requireWholeNumber()TextValidationBuilder文字項目必須是整數。

TimeItem

方法

方法傳回類型簡短說明
createResponse(hour, minute)ItemResponse為這個時間項目建立新的 ItemResponse
duplicate()TimeItem建立這個項目的副本,然後附加到表單結尾。
getGeneralFeedback()QuizFeedback傳回作答者在可評分成績時看到的回應。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getPoints()Integer傳回可評分項目的分數值。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
isRequired()Boolean判斷作答者是否需要回答問題。
setGeneralFeedback(feedback)TimeItem讓作答者在沒有正確答案或正確答案 (例如需要手動評分的問題) 的情況下,針對作答者顯示意見回饋。
setHelpText(text)TimeItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setPoints(points)TimeItem設定可評分項目的數值。
setRequired(enabled)TimeItem設定作答者是否需要回答問題。
setTitle(title)TimeItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。

VideoItem

方法

方法傳回類型簡短說明
duplicate()VideoItem建立這個項目的副本,然後附加到表單結尾。
getAlignment()Alignment取得影片的水平對齊。
getHelpText()String取得商品的說明文字 (有時為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得商品的專屬 ID。
getIndex()Integer取得表單中所有商品的索引。
getTitle()String取得商品標題 (有時為 SectionHeaderItem 標頭)。
getType()ItemType取得項目類型,以 ItemType 表示。
getWidth()Integer取得影片的寬度 (以像素為單位)。
setAlignment(alignment)VideoItem設定影片的水平對齊方式。
setHelpText(text)VideoItem設定項目的說明文字 (有時是指 ImageItemsPageBreakItemsSectionHeaderItems 等版面配置項目的說明文字)。
setTitle(title)VideoItem設定項目標題 (有時在 SectionHeaderItem 中稱為標題文字)。
setVideoUrl(youtubeUrl)VideoItem設定指定 YouTube 網址或 YouTube 影片 ID 的影片。
setWidth(width)VideoItem設定影片的寬度 (以像素為單位)。