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以欄和列格線形式呈現的問題項目,可讓作答者從一系列核取方塊中選取每個資料列中的多個選項。
CheckboxGridValidationCheckboxGridItem 的 DataValidation。
CheckboxGridValidationBuilderCheckboxGridValidation 的 DataValidationBuilder。
CheckboxItem問題項目,允許作答者選取一或多個核取方塊,以及選填的「其他」欄位。
CheckboxValidationCheckboxItem 的 DataValidation。
CheckboxValidationBuilderCheckboxValidation 的 DataValidationBuilder。
Choice與支援選項的 Item 類型相關聯的單一選項,例如 CheckboxItemListItemMultipleChoiceItem
DateItem能讓作答者指明日期的問題項目。
DateTimeItem可讓作答者指明日期和時間的問題項目。
DestinationType列舉代表支援的表單回應目的地類型。
DurationItem能讓作答者指定時間長度的問題項目。
FeedbackType列舉代表支援的意見回饋類型。
Form內含整體屬性和項目的表單。
FormApp允許指令碼開啟現有指令碼Form或建立新指令碼。
FormResponse對整個表單的回應。
GridItem以欄和列格線形式呈現的問題項目,可讓作答者從一系列圓形按鈕中選取每個資料列一個選項。
GridValidationGridItem 的 DataValidation。
GridValidationBuilderGridValidation 的 DataValidationBuilder。
ImageItem顯示圖片的版面配置項目。
Item一般表單項目,內含所有項目的通用屬性,例如標題和說明文字。
ItemResponse回應表單中的一個問題。
ItemType列舉代表支援的表單項目類型。
ListItem問題項目,可讓作答者從下拉式清單中選取一個選項。
MultipleChoiceItem問題項目,可讓作答者從圓形按鈕清單或選用的「其他」欄位選取一個選項。
PageBreakItem標記網頁開始的版面配置項目。
PageNavigationType列舉代表支援的網頁瀏覽類型。
ParagraphTextItem問題項目,可讓作答者輸入一段文字。
ParagraphTextValidationParagraphTextItem 的 DataValidation。
ParagraphTextValidationBuilderParagraphTextValidation 的 DataValidationBuilder。
QuizFeedback「意見回饋」的實作方式,其中包含所有意見回饋的通用屬性,例如顯示文字或連結。
QuizFeedbackBuilder基本 FeedbackBuilder 包含所有意見回饋通用的屬性 (例如顯示文字) 的 setter。
ScaleItem問題項目,可讓作答者從一系列圓形按鈕序列中選擇一個選項。
SectionHeaderItem以視覺化方式表示區段開頭的版面配置項目。
TextItem問題項目,可讓作答者輸入單行文字。
TextValidationTextItem 的 DataValidation。
TextValidationBuilderTextValidation 的 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決定項目是否提供「其他」選項。
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設定項目是否提供「其他」選項。

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

屬性

屬性類型說明
SPREADSHEETEnum將 Google 試算表設為表單回應目的地。

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)Form將指定使用者從 Form 的編輯者清單中移除。
removeEditor(user)Form將指定使用者從 Form 的編輯者清單中移除。
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列舉可儲存表單回應的目的地類型。
FeedbackTypeFeedbackTypeFeedbacks 形式的類型列舉。
ItemTypeItemTypeItems 形式的類型列舉。
PageNavigationTypePageNavigationType列舉瀏覽網頁的可能行為。

方法

方法傳回類型簡短說明
create(title)Form建立並傳回新的 Form
createCheckboxGridValidation()CheckboxGridValidationBuilder傳回 CheckboxGridValidationBuilder 的執行個體,可用於在 CheckboxGridItem 上設定驗證。
createCheckboxValidation()CheckboxValidationBuilder傳回 CheckboxValidationBuilder 的執行個體,可用於在 CheckboxItem 上設定驗證。
createFeedback()QuizFeedbackBuilder傳回 QuizFeedbackBuilder 的執行個體,可用於針對可評分的 Item 設定意見回饋。
createGridValidation()GridValidationBuilder傳回 GridValidationBuilder 的執行個體,可用於設定 GridItem 的驗證。
createParagraphTextValidation()ParagraphTextValidationBuilder傳回 ParagraphTextValidationBuilder 的執行個體,可用於設定 ParagraphTextItem 的驗證。
createTextValidation()TextValidationBuilder傳回 TextValidationBuilder 的執行個體,可用於設定 TextItem 的驗證。
getActiveForm()Form傳回指令碼 container-bound 的表單。
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決定項目是否提供「其他」選項。
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設定項目是否提供「其他」選項。

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設定影片的寬度 (以像素為單位)。