Forms Service

表單

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

// Create a new unpublished form, then add a checkbox question, a multiple choice question,
// a page break, then a date question and a grid of questions, then publish the form and share
// with responders.
var form = FormApp.create('New Form', /* isPublished= */ false);
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']);

form.setPublished(true);
form.addPublishedReaders(['user@example.com', 'group@example.com']);

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 或建立新的 Form
FormResponse表單的整體回覆。
GridItem以欄和列的方格形式呈現,作答者可從一連串的圓形按鈕中,為每一列選取一個選項。
GridValidationGridItem 的 DataValidation。
GridValidationBuilderGridValidation 的 DataValidationBuilder。
ImageItem顯示圖片的版面配置項目。
Item一般表單項目,包含所有項目通用的屬性,例如標題和說明文字。
ItemResponse表單中一個問題項目的回覆。
ItemType列舉,代表支援的表單項目類型。
ListItem問題項目,可讓受訪者從下拉式清單中選取一個選項。
MultipleChoiceItem問題項目,可讓受訪者從圓形按鈕清單中選取一個選項,或填寫選填的「其他」欄位。
PageBreakItem標示頁面開頭的版面配置項目。
PageNavigationType列舉代表支援的網頁導覽類型。
ParagraphTextItem問題項目,可讓受訪者輸入一段文字。
ParagraphTextValidationParagraphTextItem 的 DataValidation。
ParagraphTextValidationBuilderParagraphTextValidation 的 DataValidationBuilder。
QuizFeedbackFeedback 的 Bean 實作項目,其中包含所有意見回饋通用的屬性,例如顯示文字或連結。
QuizFeedbackBuilder基礎 FeedbackBuilder,內含所有意見回饋通用的屬性設定器,例如顯示文字。
RatingIconType列舉代表支援的評分圖示類型。
RatingItem可讓作答者評分的問題項目。
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|null傳回受訪者正確回答問題時顯示的回饋。
getFeedbackForIncorrect()QuizFeedback|null傳回作答者回答問題錯誤時顯示的意見回饋。
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|null傳回受訪者回答可評分問題時看到的意見回饋。
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|null傳回受訪者回答可評分問題時看到的意見回饋。
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|null傳回受訪者回答可評分問題時看到的意見回饋。
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新增問題項目,讓作答者輸入一段文字。
addPublishedReader(emailAddress)Form將指定使用者新增至 Form 的回覆者清單。
addPublishedReader(user)Form將指定使用者新增至 Form 的回覆者清單。
addPublishedReaders(emailAddresses)Form將指定的使用者陣列新增至 Form 的回覆者清單。
addRatingItem()RatingItem附加新問題項目,讓受訪者提供評分。
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[]取得指定類型所有項目的陣列。
getPublishedReaders()User[]取得這個 Form 的回覆者清單。
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判斷表單目前是否接受回覆。
isPublished()Boolean判斷表單是否已發布。
isPublishingSummary()Boolean決定表單是否要在作答者填寫完表單後,顯示查看回覆摘要的連結。
isQuiz()Boolean判斷表單是否為測驗。
moveItem(from, to)Item將表單中指定索引處的項目移至另一個指定索引。
moveItem(item, toIndex)Item將指定項目移至表單中所有項目的指定索引。
removeDestination()Form取消表單與目前回應目的地的連結。
removeEditor(emailAddress)FormForm 的編輯者清單中移除指定使用者。
removeEditor(user)FormForm 的編輯者清單中移除指定使用者。
removePublishedReader(emailAddress)FormForm 的回覆者清單中移除指定使用者。
removePublishedReader(user)FormForm 的回覆者清單中移除指定使用者。
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設定表單是否顯示進度列。
setPublished(enabled)Form設定表單是否已發布。
setPublishingSummary(enabled)Form設定表單是否要在受訪者提交表單後,顯示查看回覆摘要的連結。
setShowLinkToRespondAgain(enabled)Form設定表單是否要在受訪者填寫完表單後,顯示提交其他回覆的連結。
setShuffleQuestions(shuffle)Form設定表單每頁的問題順序是否隨機。
setTitle(title)Form設定表單標題。
shortenFormUrl(url)String將表單的長網址轉換為短網址。
submitGrades(responses)Form為指定的 FormResponses 提交成績。
supportsAdvancedResponderPermissions()Boolean判斷表單是否支援發布。

FormApp

屬性

屬性類型說明
AlignmentAlignment圖片對齊方式的列舉。
DestinationTypeDestinationType可儲存表單回覆內容的目的地類型列舉。
FeedbackTypeFeedbackType表單類型列舉 Feedbacks
ItemTypeItemType表單類型列舉 Items
PageNavigationTypePageNavigationType列舉可能的網頁瀏覽行為。
RatingIconTypeRatingIconType評分圖示類型列舉 RatingIcons

方法

方法傳回類型簡短說明
create(title)Form建立並傳回新的 Form
create(title, isPublished)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傳回指令碼繫結的表單。
getUi()Ui傳回表單編輯器使用者介面環境的執行個體,允許指令碼新增選單、對話方塊和側欄等功能。
openById(id)Form傳回具有指定 ID 的 Form
openByUrl(url)Form傳回具有指定網址的 Form

FormResponse

方法

方法傳回類型簡短說明
getEditResponseUrl()String產生可用於編輯已提交回覆的網址。
getGradableItemResponses()ItemResponse[]以表單中項目的顯示順序,取得表單回覆中包含的所有項目回覆。
getGradableResponseForItem(item)ItemResponse取得指定項目表單回覆中包含的項目回覆。
getId()String|null取得表單回覆的 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以段落文字項目形式傳回項目。
asRatingItem()RatingItem將項目傳回為評分項目。
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問題項目,可讓受訪者輸入一段文字。
RATINGEnum可讓作答者評分的問題項目。
SCALEEnum問題項目,可讓作答者從編號的圓形按鈕序列中選擇一個選項。
SECTION_HEADEREnum以視覺化方式指出區段開頭的版面配置項目。
TEXTEnum問題項目,可讓受訪者輸入單行文字。
TIMEEnum問題項目,可讓受訪者指出一天中的時間。
VIDEOEnum顯示 YouTube 影片的版面配置項目。
FILE_UPLOADEnum可讓受訪者上傳檔案的問題項目。
UNSUPPORTEDEnum目前無法透過 API 支援的項目。

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|null傳回受訪者正確回答問題時顯示的回饋。
getFeedbackForIncorrect()QuizFeedback|null傳回作答者回答問題錯誤時顯示的意見回饋。
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|null傳回受訪者正確回答問題時顯示的回饋。
getFeedbackForIncorrect()QuizFeedback|null傳回作答者回答問題錯誤時顯示的意見回饋。
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|null傳回受訪者回答可評分問題時看到的意見回饋。
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設定意見回饋文字。

RatingIconType

屬性

屬性類型說明
STAREnum星號圖示。
HEARTEnum愛心圖示。
THUMB_UPEnum拇指向上圖示。

RatingItem

方法

方法傳回類型簡短說明
createResponse(response)ItemResponse為這個評分項目建立新的 ItemResponse
duplicate()RatingItem建立這個項目的副本,並附加到表單結尾。
getGeneralFeedback()QuizFeedback|null傳回受訪者回答可評分問題時看到的意見回饋。
getHelpText()String取得項目的說明文字 (有時稱為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
getId()Integer取得項目的專屬 ID。
getIndex()Integer取得表單中所有項目中的項目索引。
getPoints()Integer傳回可評分項目的點數值。
getRatingIcon()RatingIconType取得所選評分的圖示。
getRatingScaleLevel()Integer取得評等的等級。
getTitle()String取得項目的標題 (如果是 SectionHeaderItem,有時稱為標頭文字)。
getType()ItemType取得項目的類型,以 ItemType 表示。
isRequired()Boolean決定受訪者是否必須回答問題。
setGeneralFeedback(feedback)RatingItem設定作答者回答沒有正確或錯誤答案的評分問題時,系統顯示的意見回饋 (即需要手動評分的問題)。
setHelpText(text)RatingItem設定項目的說明文字 (有時稱為版面配置項目的說明文字,例如 ImageItemsPageBreakItemsSectionHeaderItems)。
setPoints(points)RatingItem設定可評分項目的分數。
setRatingIcon(ratingIcon)RatingItem設定分級圖示。
setRatingScaleLevel(ratingScaleLevel)RatingItem設定評分的最高等級。
setRequired(enabled)RatingItem設定受訪者是否必須回答問題。
setTitle(title)RatingItem設定項目的標題 (如果是 SectionHeaderItem,有時也稱為標題文字)。

ScaleItem

方法

方法傳回類型簡短說明
createResponse(response)ItemResponse為這個比例項目建立新的 ItemResponse
duplicate()ScaleItem建立這個項目的副本,並附加到表單結尾。
getGeneralFeedback()QuizFeedback|null傳回受訪者回答可評分問題時看到的意見回饋。
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|null傳回受訪者回答可評分問題時看到的意見回饋。
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|null傳回受訪者回答可評分問題時看到的意見回饋。
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以像素為單位設定影片寬度。