AddOns Response Service

AddOns Response Service

このサービスを使用すると、Google Workspace Studio を拡張する Google Workspace アドオンをスクリプトで構成して構築できます。

クラス

名前	概要
Action	Google Workspace Studio を拡張する Google Workspace アドオンが新しいカードのレンダリングに使用できるアクション。
AddOnsResponseService	AddOnsResponseService を使用すると、Google Workspace Studio を拡張する Google Workspace アドオンのレスポンスを作成できます。
BasicDataType	基本的な汎用データ型を表す列挙型。
Color	RGBA カラースペースのカラーを表す Color オブジェクト。
DataType	DataType は、変数の型を設定するために使用されます。
DynamicResourceDefinition	DynamicResourceDefinition は ResourceFieldsDefinitionRetrievedAction の構成要素です。1 つ以上の ResourceField を含み、Google Workspace Studio のステップで提供される出力変数の数を動的に定義できます。
ErrorActionability	エラーの対応可能性を表す列挙型。
ErrorRetryability	エラーが発生した場合のアクション呼び出しの再試行可能性を表す列挙型。
FontWeight	スタイル付きテキストのフォントの太さを表す列挙型。
HostAppAction	HostAppAction は、個々のホストアプリによって処理される Action の一種です。
Hyperlink	TextFormatElement で使用される Hyperlink 要素。
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 の key-value ペアのコレクションが含まれます。
ResourceField	ResourceField は DynamicResourceDefinition の基本的な構成要素です。各リソース フィールドは、現在のステップの出力変数に対応しています。
ResourceFieldsDefinitionRetrievedAction	ResourceFieldsDefinitionRetrievedAction は ResourceFieldsDefinitionRetrievedAction の一種で、マニフェストで指定された dynamicResourceDefinitionProvider 関数を介して、リソース フィールドのリストの定義を取得するために使用されます。
ResourceRetrievedAction	ResourceRetrievedAction は、必要に応じてカスタム リソース コンテンツを取得するために使用されます。カスタム リソース フィールドは ResourceData で定義されます。
ResourceType	アプリケーション固有のリソースタイプ。リソースタイプの固有識別子には、対応する 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 は、Google Workspace Studio で特定のアクションを実行するために使用される HostAppAction の一種です。
WorkflowTextFormat	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	色のアルファ要素を設定します。
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	エラーは再試行可能です。Workflow は Step の実行を最大 5 回試行します。

FontWeight

プロパティ

プロパティ	タイプ	説明
FONT_WEIGHT_UNSPECIFIED	Enum	標準の太さの標準の重み。
LIGHT	Enum	軽量化と薄型化を実現。
MEDIUM	Enum	ライトとボールドの中間の太さ。
BOLD	Enum	厚みが増し、重量が増加。

HostAppAction

メソッド

メソッド	戻り値の型	概要
setWorkflowAction(workflowAction)	HostAppAction	ホストアプリのアクションをワークフロー アクションに設定します。

Hyperlink

メソッド

メソッド	戻り値の型	概要
setLink(link)	Hyperlink	ハイパーリンクのリンク先 URL を設定します。
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	リンクの URL を設定します。

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	スタイル付きテキストのスタイルを設定します。1 つのスタイル付きテキストに複数のスタイルを適用できます。
setColor(color)	StyledText	スタイル付きテキストの色を設定します。
setFontWeight(fontWeight)	StyledText	スタイル設定されたテキストのフォントの太さを設定します。
setText(text)	StyledText	スタイル付きテキストのメイン コンテンツを設定します。

TextFormatChip

メソッド

メソッド	戻り値の型	概要
setLabel(label)	TextFormatChip	チップに表示されるテキストを設定します。
setTextFormatIcon(icon)	TextFormatChip	チップに表示されるアイコンを設定します。
setUrl(url)	TextFormatChip	チップがクリックされたときに移動する URL を設定します。

TextFormatElement

メソッド

メソッド	戻り値の型	概要
setHyperlink(hyperlink)	TextFormatElement	テキスト形式要素を Hyperlink として設定します。
setListContainer(listContainer)	TextFormatElement	テキスト形式要素を ListContainer として設定します。
setStyledText(styledText)	TextFormatElement	テキスト形式要素を StyledText として設定します。
setText(text)	TextFormatElement	テキスト形式要素をテキスト文字列として設定します。
setTextFormatChip(chip)	TextFormatElement	テキスト形式要素を TextFormatChip として設定します。

TextFormatIcon

メソッド

メソッド	戻り値の型	概要
setIconUrl(iconUrl)	TextFormatIcon	アイコンの URL を設定します。
setMaterialIconName(materialIconName)	TextFormatIcon	Google マテリアル アイコンで定義されたマテリアル アイコン名を設定します。

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 が String 型に設定されている場合にのみ設定できます。
setDefaultValue(defaultValue)	ValueMetadata	変数のオプションのデフォルト値を設定します。たとえば、変数の型がブール値の場合、defaultValue は「true」または「false」に設定できます。

VariableData

メソッド

メソッド	戻り値の型	概要
addBooleanValue(value)	VariableData	変数データにブール値を追加します。
addEmailAddress(emailAddress)	VariableData	変数データにメールアドレスを追加します。
addFloatValue(value)	VariableData	変数データに float 値を追加します。
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	検証エラーの重大度を設定します。