AddOns Response Service

新增外掛程式回覆服務

這項服務可讓指令碼設定及建構 Google Workspace 外掛程式，擴充 Google Workspace Studio。

類別

名稱	簡短說明
Action	Google Workspace 外掛程式可擴充 Google Workspace Studio，並使用這項動作來算繪新資訊卡。
AddOnsResponseService	AddOnsResponseService 可為擴充 Google Workspace Studio 的 Google Workspace 外掛程式建立回覆。
BasicDataType	列舉代表基本泛型資料型別。
Color	代表 RGBA 色域中顏色的 Color 物件。
DataType	DataType 用於設定變數的類型。
DynamicResourceDefinition	DynamicResourceDefinition 是 ResourceFieldsDefinitionRetrievedAction 的建構區塊，可包含一或多個 ResourceField，動態定義 Google Workspace Studio 中步驟提供的輸出變數數量。
ErrorActionability	列舉，代表錯誤的可操作性。
ErrorRetryability	這個列舉代表發生錯誤時，動作調用是否可重試。
FontWeight	列舉，表示樣式文字的字體粗細。
HostAppAction	HostAppAction 是由個別主機應用程式處理的 Action 類型。
Hyperlink	TextFormatElement 中使用的超連結元素。
InsertSection	InsertSection 物件的建構工具。
InsertWidget	InsertWidget 物件的建構工具。
Link	第三方資源中的連結物件，會轉換成主機應用程式中的智慧型方塊。
ListContainer	清單項目的容器，每個清單項目可以包含多個 TextFormatElement。
ListItem	清單項目，每個清單項目可包含多個 TextFormatElement。
ListType	表示清單類型的列舉。
ModifyCard	ModifyCard 物件的建構工具，可將 ModifyCard 物件傳遞至 Action，藉此變更及更新現有卡的介面。
Navigation	控制卡片導覽的輔助物件。
RemoveSection	RemoveSection 物件的建構工具。
RemoveWidget	RemoveWidget 物件的建構工具。
RenderAction	執行 Action 以回應使用者互動，進而算繪或更新資訊卡。
RenderActionBuilder	RenderAction 物件的建構工具。
ResourceData	代表應用程式專屬的資源資料，資源資料包含變數名稱和 VariableData 的鍵值組集合。
ResourceField	ResourceField 是 DynamicResourceDefinition 的基本建構區塊，每個資源欄位都對應目前步驟的輸出變數。
ResourceFieldsDefinitionRetrievedAction	ResourceFieldsDefinitionRetrievedAction 是 ResourceFieldsDefinitionRetrievedAction 的一種，用於透過資訊清單中指定的 dynamicResourceDefinitionProvider 函式，擷取資源欄位清單的定義。
ResourceRetrievedAction	ResourceRetrievedAction 用於在需要時擷取自訂資源內容，其中自訂資源欄位定義於 ResourceData 中。
ResourceType	應用程式專屬資源類型，資源類型的專屬 ID 應有對應的 WorkflowResourceDefinition。
ReturnElementErrorAction	ReturnElementErrorAction 表示元素叫用期間發生錯誤。
ReturnOutputVariablesAction	包含 Google Workspace Studio 中執行動作所產生的輸出變數。
SaveWorkflowAction	這項動作表示主機應用程式 (Google Workspace Studio) 應儲存代理程式。
StyledText	文字元素，可設定粗體、斜體和顏色等樣式。
TextFormatChip	文字格式的可點選動態磚。
TextFormatElement	文字格式元素，可以是 TextFormatChip、StyledText、Hyperlink 或 ListContainer。
TextFormatIcon	顯示在 TextFormatChip 中的圖示。
TextStyle	列舉，代表樣式化文字的樣式。
TimeStamp	代表可新增至 VariableData 的時間戳記物件。
UpdateWidget	UpdateWidget 物件的建構工具。
ValidationErrorSeverity	表示驗證錯誤嚴重程度的列舉。
ValueMetadata	ValueMetadata 包含變數的可能值相關資訊。
VariableData	代表可包含各種型別值集合的變數資料。
WorkflowAction	WorkflowAction 是 HostAppAction 的一種，用於在 Google Workspace Studio 中執行特定動作。
WorkflowTextFormat	一段文字，包含 RTF 格式選項，包括樣式、超連結和 TextFormatElement 中定義的互動式元素。
WorkflowValidationErrorAction	這項動作表示主機應用程式 (Google Workspace Studio) 應顯示驗證錯誤。

Action

方法

方法	傳回類型	簡短說明
addModifyCard(modifyCard)	Action	在動作中新增 ModifyCard 作業。
addNavigation(navigation)	Action	在動作中新增資訊卡導覽。

AddOnsResponseService

方法

方法	傳回類型	簡短說明
newAction()	Action	建立新的 Action。
newNavigation()	Navigation	建立新的 Navigation。
newRenderActionBuilder()	RenderActionBuilder	建立新的 RenderActionBuilder。

BasicDataType

屬性

屬性	類型	說明
BASIC_TYPE_UNSPECIFIED	Enum	預設值。
STRING	Enum	字元字串。
INTEGER	Enum	整數值。
FLOAT	Enum	浮點數值。
TIMESTAMP	Enum	採用 ISO 8601 格式的時間戳記。
BOOLEAN	Enum	布林值。
EMAIL_ADDRESS	Enum	電子郵件地址格式的字串。
GOOGLE_USER	Enum	Google 服務的使用者，格式為「users/encoded_GAIA_ID」
FILE	Enum	檔案類型。
FORMATTED_TEXT	Enum	格式豐富的文字。

Color

方法

方法	傳回類型	簡短說明
setAlpha(alpha)	Color	設定色彩的 Alpha 版元件。
setBlue(blue)	Color	設定色彩的藍色元件。
setGreen(green)	Color	設定顏色的綠色元件。
setRed(red)	Color	設定顏色的紅色元件。

DataType

方法

方法	傳回類型	簡短說明
setBasicDataType(basicDataType)	DataType	將資料類型設為其中一個支援的 BasicDataType。
setResourceType(resourceType)	DataType	將資料類型設為自訂的 ResourceType。
setValueMetadata(valueMetadata)	DataType	設定 ValueMetadata，其中包含與變數相關的型別資訊。

DynamicResourceDefinition

方法

方法	傳回類型	簡短說明
addResourceField(resourceField)	DynamicResourceDefinition	在動態資源定義中新增資源欄位。
setResourceId(resourceId)	DynamicResourceDefinition	設定動態資源定義的 ID，這個 ID 對應至資訊清單中的 workflowResourceDefinitionId。

ErrorActionability

屬性

屬性	類型	說明
ERROR_ACTIONABILITY_UNSPECIFIED	Enum	未指明
NOT_ACTIONABLE	Enum	使用者無法透過設定資訊卡修正錯誤。
ACTIONABLE	Enum	使用者可以透過設定卡片修正錯誤。

ErrorRetryability

屬性

屬性	類型	說明
RETRYABILITY_UNSPECIFIED	Enum	未指明
NOT_RETRYABLE	Enum	這個錯誤無法重試，流程會在第一次嘗試後終止。
RETRYABLE	Enum	這個錯誤可以重試，工作流程最多會嘗試執行步驟 5 次。

FontWeight

屬性

屬性	類型	說明
FONT_WEIGHT_UNSPECIFIED	Enum	標準粗細的字體。
LIGHT	Enum	更輕薄的機身。
MEDIUM	Enum	介於細體和粗體之間的重量。
BOLD	Enum	重量較重，厚度較厚。

HostAppAction

方法

方法	傳回類型	簡短說明
setWorkflowAction(workflowAction)	HostAppAction	將主機應用程式動作設為工作流程動作。

Hyperlink

方法

方法	傳回類型	簡短說明
setLink(link)	Hyperlink	設定超連結的目的地網址。
setText(text)	Hyperlink	設定超連結的文字。

InsertSection

方法

方法	傳回類型	簡短說明
insertAtTop(onCardTop)	InsertSection	設定 onCardTop 旗標，指出是否應在資訊卡頂端插入新區段。
insertBelowSection(sectionId)	InsertSection	設定區段 ID，新區段會插入其下方。
setSection(section)	InsertSection	設定要插入的卡片區塊。

InsertWidget

方法

方法	傳回類型	簡短說明
insertAboveWidget(widgetId)	InsertWidget	設定小工具 ID，新小工具會插入指定 ID 的小工具上方。
insertBelowWidget(widgetId)	InsertWidget	設定小工具 ID，新小工具會插入指定 ID 的小工具下方。
setWidget(widget)	InsertWidget	設定要插入的 Widget。

Link

方法

方法	傳回類型	簡短說明
setTitle(title)	Link	設定連結的標題。
setUrl(url)	Link	設定連結的網址。

ListContainer

方法

方法	傳回類型	簡短說明
addListItem(listItem)	ListContainer	將清單項目新增至清單容器。
setListNestLevel(listLevel)	ListContainer	設定清單層級，頂層為 0，每增加一個巢狀清單，層級就加 1。
setListType(listType)	ListContainer	設定清單類型為排序或未排序。

ListItem

方法

方法	傳回類型	簡短說明
addTextFormatElement(textFormatElement)	ListItem	將 TextFormatElement 新增至清單項目。

ListType

屬性

屬性	類型	說明
LIST_TYPE_UNSPECIFIED	Enum	預設值。
ORDERED	Enum	已排序的清單。
UNORDERED	Enum	未排序的清單。

ModifyCard

方法

方法	傳回類型	簡短說明
setInsertSection(insertSection)	ModifyCard	設定這個修改資訊卡物件的 InsertSection。
setInsertWidget(insertWidget)	ModifyCard	設定這個修改資訊卡物件的 InsertWidget。
setRemoveSection(removeSection)	ModifyCard	設定這個修改資訊卡物件的 RemoveSection。
setRemoveWidget(removeWidget)	ModifyCard	設定這個修改資訊卡物件的 RemoveWidget。
setReplaceSection(replacementSection)	ModifyCard	為這個修改資訊卡物件設定替代 CardSection，替代區塊應與現有資訊卡區塊的 ID 相同。
setReplaceWidget(replacementWidget)	ModifyCard	為這個修改資訊卡物件設定替代小工具，替代小工具的 ID 應與現有小工具相同。
setUpdateWidget(updateWidget)	ModifyCard	設定這個修改資訊卡物件的 UpdateWidget。

Navigation

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。
pushCard(card)	Navigation	將指定卡片推送到堆疊。

RemoveSection

方法

方法	傳回類型	簡短說明
setSectionId(sectionId)	RemoveSection	設定要移除的區塊 ID。

RemoveWidget

方法

方法	傳回類型	簡短說明
setWidgetId(widgetId)	RemoveWidget	設定要移除的小工具 ID。

RenderAction

方法

方法	傳回類型	簡短說明
printJson()	String	列印這個物件的 JSON 表示法。

RenderActionBuilder

方法

方法	傳回類型	簡短說明
build()	RenderAction	建構目前的算繪動作並驗證。
setAction(action)	RenderActionBuilder	設定外掛程式可用來將 UI 更新為算繪動作的動作。
setHostAppAction(hostAppAction)	RenderActionBuilder	將個別主機應用程式處理的 HostAppAction 設定為轉譯動作。

ResourceData

方法

方法	傳回類型	簡短說明
addVariableData(key, value)	ResourceData	新增以變數名稱為鍵的 VariableData，如果鍵已存在，則會覆寫值。
setVariableDataMap(fields)	ResourceData	設定以變數名稱為鍵的變數資料對應。

ResourceField

方法

方法	傳回類型	簡短說明
setDataType(dataType)	ResourceField	設定欄位的資料類型，讓其他步驟在選取時依類型篩選變數。
setDisplayText(displayText)	ResourceField	設定欄位說明，供使用者在後續步驟中選取變數時查看。
setSelector(selector)	ResourceField	設定提供者函式的鍵，以便在步驟執行期間提供值。

ResourceFieldsDefinitionRetrievedAction

方法

方法	傳回類型	簡短說明
addDynamicResourceDefinition(dynamicResourceDefinition)	ResourceFieldsDefinitionRetrievedAction	在擷取的動作中，將 DynamicResourceDefinition 新增至資源欄位定義。

ResourceRetrievedAction

方法

方法	傳回類型	簡短說明
setResourceData(resourceData)	ResourceRetrievedAction	將 ResourceData 設為資源擷取動作，為動態資源欄位或自訂資源欄位提供值。

ResourceType

方法

方法	傳回類型	簡短說明
setWorkflowResourceDefinitionId(resourceType)	ResourceType	設定工作流程資源定義 ID。

ReturnElementErrorAction

方法

方法	傳回類型	簡短說明
setErrorActionability(errorActionability)	ReturnElementErrorAction	設定錯誤可採取行動性，如果重新設定步驟即可解決錯誤，則錯誤應可採取行動。
setErrorLog(log)	ReturnElementErrorAction	在工作流程的活動動態消息中，設定要向使用者顯示的錯誤記錄。
setErrorRetryability(errorRetryability)	ReturnElementErrorAction	設定錯誤重試功能，如果錯誤無法重試，流程會在第一次嘗試後終止。

ReturnOutputVariablesAction

方法

方法	傳回類型	簡短說明
addVariableData(key, value)	ReturnOutputVariablesAction	新增以變數名稱做為鍵的變數資料，如果鍵已存在，系統會覆寫值。
setLog(log)	ReturnOutputVariablesAction	將已執行的工作流程動作記錄，設定為工作流程活動動態消息中的使用者。
setVariableDataMap(variables)	ReturnOutputVariablesAction	設定以變數名稱做為索引鍵的變數資料對應，如果索引鍵已存在，則會覆寫值。

SaveWorkflowAction

StyledText

方法

方法	傳回類型	簡短說明
addStyle(style)	StyledText	設定樣式文字的樣式，可將多種樣式套用至單一的樣式文字。
setColor(color)	StyledText	設定樣式文字的顏色。
setFontWeight(fontWeight)	StyledText	設定樣式文字的字型粗細。
setText(text)	StyledText	設定樣式文字的主要內容。

TextFormatChip

方法

方法	傳回類型	簡短說明
setLabel(label)	TextFormatChip	設定要在方塊中顯示的文字。
setTextFormatIcon(icon)	TextFormatChip	設定要在方塊中顯示的圖示。
setUrl(url)	TextFormatChip	設定使用者點按智慧型方塊時前往的網址。

TextFormatElement

方法

方法	傳回類型	簡短說明
setHyperlink(hyperlink)	TextFormatElement	將文字格式元素設為 Hyperlink。
setListContainer(listContainer)	TextFormatElement	將文字格式元素設為 ListContainer。
setStyledText(styledText)	TextFormatElement	將文字格式元素設為 StyledText。
setText(text)	TextFormatElement	將文字格式元素設為文字字串。
setTextFormatChip(chip)	TextFormatElement	將文字格式元素設為 TextFormatChip。

TextFormatIcon

方法

方法	傳回類型	簡短說明
setIconUrl(iconUrl)	TextFormatIcon	設定圖示網址。
setMaterialIconName(materialIconName)	TextFormatIcon	設定 Google Material Icons 中定義的材質圖示名稱。

TextStyle

屬性

屬性	類型	說明
STYLE_UNSPECIFIED	Enum	未套用任何樣式。
ITALIC	Enum	斜體樣式。
UNDERLINE	Enum	底線樣式。
STRIKETHROUGH	Enum	刪除線樣式。
LINE_BREAK	Enum	換行。
UPPERCASE	Enum	大寫樣式。
CODE	Enum	程式碼樣式。
CODE_BLOCK	Enum	程式碼區塊樣式。

TimeStamp

方法

方法	傳回類型	簡短說明
setNanos(nanos)	TimeStamp	設定時間戳記的奈秒，代表目前秒數內的奈秒數。
setSeconds(seconds)	TimeStamp	設定時間戳記的秒數，代表自 Unix 紀元(1970 年 1 月 1 日 00:00:00 UTC) 起算的秒數。

UpdateWidget

方法

方法	傳回類型	簡短說明
addSuggestion(text, value, selected, startIconUri, bottomText)	UpdateWidget	為可選取多個項目的選單新增可選取的項目。

ValidationErrorSeverity

屬性

屬性	類型	說明
SEVERITY_UNSPECIFIED	Enum	未指明
CRITICAL	Enum	重大：錯誤嚴重，必須先修正才能發布。
WARNING	Enum	警告：錯誤不重要，不會阻礙發布。

ValueMetadata

方法

方法	傳回類型	簡短說明
addCastableType(dataType)	ValueMetadata	將可為變數資料動態轉換的選用允許型別，新增至這個值中繼資料。
addEnumValue(enumValue)	ValueMetadata	為變數的允許列舉值新增選用字串值，只有在 DataType 設為字串類型時，才能設定這個欄位。
setDefaultValue(defaultValue)	ValueMetadata	設定變數的選用預設值，例如，如果變數類型為布林值，defaultValue 可能會設為「true」或「false」。

VariableData

方法

方法	傳回類型	簡短說明
addBooleanValue(value)	VariableData	在變數資料中新增布林值。
addEmailAddress(emailAddress)	VariableData	將電子郵件地址新增至變數資料。
addFloatValue(value)	VariableData	將浮點值新增至變數資料。
addGoogleUser(googleUser)	VariableData	將 Google 使用者新增至變數資料。
addIntegerValue(value)	VariableData	將整數值新增至變數資料。
addResourceData(resourceData)	VariableData	將 ResourceData 值新增至變數資料。
addResourceReference(resourceReference)	VariableData	將資源參照 ID 新增至變數資料。
addStringValue(value)	VariableData	將字串值新增至變數資料。
addTimestampValue(value)	VariableData	將 TimeStamp 值新增至變數資料。
addWorkflowTextFormat(workflowTextFormat)	VariableData	將 WorkflowTextFormat 值新增至變數資料。

WorkflowAction

WorkflowTextFormat

方法

方法	傳回類型	簡短說明
addTextFormatElement(textFormatElement)	WorkflowTextFormat	在工作流程文字格式中新增 TextFormatElement。

WorkflowValidationErrorAction

方法

方法	傳回類型	簡短說明
setSeverity(severity)	WorkflowValidationErrorAction	設定驗證錯誤的嚴重程度。