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與支援 CheckboxItemListItemMultipleChoiceItem 等選項的 Item 類型相關聯的單一選項。
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判斷該項目是否含有「other」如果有需要 SQL 指令的分析工作負載 則 BigQuery 可能是最佳選擇
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」如果有需要 SQL 指令的分析工作負載 則 BigQuery 可能是最佳選擇

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附加新的問題項目,讓作答者勾選一或多個核取方塊,例如 還有選擇性的 [other]] 欄位。
addDateItem()DateItem附加新的問題項目,可讓作答者指定日期。
addDateTimeItem()DateTimeItem加入新的問題項目,方便作答者選擇日期和時間。
addDurationItem()DurationItem加入新的問題項目,讓作答者指定時間長度。
addEditor(emailAddress)Form將特定使用者新增至 Form 的編輯者清單。
addEditor(user)Form將特定使用者新增至 Form 的編輯者清單。
addEditors(emailAddresses)Form將指定的使用者陣列新增至 Form 的編輯者清單。
addGridItem()GridItem附加新的問題項目 (以欄和列格線的形式呈現),讓 作答者需要從一系列圓形按鈕中,為每列選取一個選項。
addImageItem()ImageItem附加會顯示圖片的新版面配置項目。
addListItem()ListItem加入新的問題項目,讓作答者可從下拉式選單中選取一個選項 請參考閱讀清單,進一步瞭解 如何選擇 Kubeflow Pipelines SDK 或 TFX
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提交特定 FormResponse 的成績。

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判斷該項目是否含有「other」如果有需要 SQL 指令的分析工作負載 則 BigQuery 可能是最佳選擇
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」如果有需要 SQL 指令的分析工作負載 則 BigQuery 可能是最佳選擇

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