AddOns Response Service

AddOns Response Service

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

クラス

名前概要
AccessoryWidget
ActionGoogle Workspace Studio を拡張する Google Workspace アドオンが新しいカードのレンダリングに使用できるアクション。
ActionResponse
ActionResponseBuilder
AddOnsResponseServiceAddOnsResponseService は、Google Workspace アドオンのレスポンスを作成する機能を提供します。
AddonComposeUiActionResponse
AddonComposeUiActionResponseBuilder
AddonComposeUiActionType
Attachment
BasicDataType基本的な汎用データ型を表す列挙型。
CalendarEventActionResponse
CalendarEventActionResponseBuilder
ChatDataActionsResponseBuilder
ChatMessage
ColorRGBA カラースペースのカラーを表す Color オブジェクト。
ComposeActionResponse
ComposeActionResponseBuilder
ComposedEmailType
ContentType
CreateMessageAction
DataActionsResponse
DataTypeDataType は、変数の型を設定するために使用されます。
DriveItemsSelectedActionResponse
DriveItemsSelectedActionResponseBuilder
DynamicResourceDefinitionDynamicResourceDefinition は ResourceFieldsDefinitionRetrievedAction の構成要素です。1 つ以上の ResourceField を含み、Google Workspace Studio のステップで提供される出力変数の数を動的に定義できます。
EditorFileScopeActionResponse
EditorFileScopeActionResponseBuilder
EndNavigation
ErrorActionabilityエラーの対応可能性を表す列挙型。
ErrorRetryabilityエラーが発生した場合のアクション呼び出しの再試行可能性を表す列挙型。
FontWeightスタイル付きテキストのフォントの太さを表す列挙型。
HostAppActionHostAppAction は、個々のホストアプリによって処理される Action の一種です。
HyperlinkTextFormatElement で使用される Hyperlink 要素。
InsertSectionInsertSection オブジェクトのビルダー。
InsertWidgetInsertWidget オブジェクトのビルダー。
Linkサードパーティ リソースのリンク オブジェクト。ホスト アプリケーションでスマートチップに変換されます。
LinkPreview
ListContainerリスト項目のコンテナ。各リスト項目には複数の TextFormatElement を含めることができます。
ListItemリスト項目。各リスト項目には複数の TextFormatElement を含めることができます。
ListTypeリストのタイプを表す列挙型。
ModifyCardModifyCard オブジェクトのビルダー。ModifyCard オブジェクトを Action に渡すことで、既存のカードのインターフェースを変更して更新します。
Navigationカード ナビゲーションを制御するヘルパー オブジェクト。
Notification
OnClose
OpenAs
OpenLink
RemoveSectionRemoveSection オブジェクトのビルダー。
RemoveWidgetRemoveWidget オブジェクトのビルダー。
RenderActionユーザー操作に応じて Action を実行して、カードをレンダリングまたは更新します。
RenderActionBuilderRenderAction オブジェクトのビルダー。
ResourceDataアプリケーション固有のリソースデータを表します。リソースデータには、変数名と VariableData の key-value ペアのコレクションが含まれます。
ResourceFieldResourceField は DynamicResourceDefinition の基本的な構成要素です。各リソース フィールドは、現在のステップの出力変数に対応しています。
ResourceFieldsDefinitionRetrievedActionResourceFieldsDefinitionRetrievedActionResourceFieldsDefinitionRetrievedAction の一種で、マニフェストで指定された dynamicResourceDefinitionProvider 関数を介して、リソース フィールドのリストの定義を取得するために使用されます。
ResourceRetrievedActionResourceRetrievedAction は、必要に応じてカスタム リソース コンテンツを取得するために使用されます。カスタム リソース フィールドは ResourceData で定義されます。
ResourceTypeアプリケーション固有のリソースタイプ。リソースタイプの固有識別子には、対応する WorkflowResourceDefinition が必要です。
ReturnElementErrorActionReturnElementErrorAction は、要素の呼び出し中にエラーが発生したことを示します。
ReturnOutputVariablesActionGoogle Workspace Studio で実行されたアクションによって生成された出力変数を含みます。
SaveWorkflowActionこのアクションは、ホストアプリ(Google Workspace Studio)がエージェントを保存する必要があることを示します。
SendStatus
StyledText太字、斜体、色などのスタイルを含むテキスト要素。
TextFormatChipテキスト形式のクリック可能なチップ。
TextFormatElementテキスト形式要素(TextFormatChipStyledTextHyperlinkListContainer のいずれか)。
TextFormatIconTextFormatChip に表示されるアイコン。
TextStyleスタイル付きテキストのスタイルを表す列挙型。
TimeStampVariableData に追加できるタイムスタンプ オブジェクトを表します。
UniversalActionResponse
UniversalActionResponseBuilder
UpdateDraftActionResponse
UpdateDraftActionResponseBuilder
UpdateDraftBccRecipientsAction
UpdateDraftBodyAction
UpdateDraftBodyType
UpdateDraftCcRecipientsAction
UpdateDraftSubjectAction
UpdateDraftToRecipientsAction
UpdateInlinePreviewAction
UpdateMessageAction
UpdateWidgetUpdateWidget オブジェクトのビルダー。
ValidationErrorSeverity検証エラーの重大度を表す列挙型。
ValueMetadatavalueMetadata には、変数の潜在的な値に関する情報が含まれます。
VariableDataさまざまな型の値のコレクションを含むことができる変数データを表します。
WorkflowActionWorkflowAction は、Google Workspace Studio で特定のアクションを実行するために使用される HostAppAction の一種です。
WorkflowTextFormatTextFormatElement で定義されたスタイル、ハイパーリンク、インタラクティブ要素などのリッチ フォーマット オプションを含むテキスト ブロック。
WorkflowValidationErrorActionこのアクションは、ホストアプリ(Google Workspace Studio)が検証エラーを表示する必要があることを示します。

AccessoryWidget

メソッド

メソッド戻り値の型概要
addWidget(widget)AccessoryWidgetこのアクションのウィジェットを設定します。

Action

メソッド

メソッド戻り値の型概要
addModifyCard(modifyCard)Actionアクションに ModifyCard オペレーションを追加します。
addNavigation(navigation)Actionアクションにカード ナビゲーションを追加します。

ActionResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

ActionResponseBuilder

メソッド

メソッド戻り値の型概要
addModifyCard(modifyCard)ActionResponseBuilderカード変更オペレーションをアクションに設定します。
build()ActionResponse現在のアクション レスポンスをビルドして検証します。
setLinkPreview(linkPreview)ActionResponseBuilderLinkPreview をアクションに設定します。
setNavigation(navigation)ActionResponseBuilderNavigation アクションに対するレスポンスを設定します。
setNotification(notification)ActionResponseBuilderアクションが有効になったときに表示する通知を設定します。
setOpenLink(openLink)ActionResponseBuilderアクションが有効になったときに移動する URL を設定します。
setStateChanged(stateChanged)ActionResponseBuilderこのアクションが既存のデータ状態を変更したことを示すフラグを設定します。

AddOnsResponseService

プロパティ

プロパティタイプ説明
AddonComposeUiActionTypeAddonComposeUiActionTypeAddonComposeUiActionType 列挙型。
ComposedEmailTypeComposedEmailTypeComposedEmailType 列挙型。
ContentTypeContentTypeContentType 列挙型。
EndNavigationEndNavigationEndNavigation 列挙型。
OnCloseOnCloseOnClose 列挙型。
OpenAsOpenAsOpenAs 列挙型。
SendStatusSendStatusSendStatus 列挙型。
UpdateDraftBodyTypeUpdateDraftBodyTypeUpdateDraftBodyType 列挙型。

メソッド

メソッド戻り値の型概要
newAccessoryWidget()AccessoryWidget新しい AccessoryWidget を作成します。
newAction()Action新しい Action を作成します。
newActionResponseBuilder()ActionResponseBuilderActionResponseBuilder を作成します。
newAddonComposeUiActionResponseBuilder()AddonComposeUiActionResponseBuilderAddonComposeUiActionResponseBuilder を作成します。
newAttachment()AttachmentAttachment を作成します。
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilderCalendarEventActionResponseBuilder を作成します。
newChatDataActionBuilder()ChatDataActionsResponseBuilderChatDataActionsResponseBuilder を作成します。
newChatMessage()ChatMessageChatMessage を作成します。
newComposeActionResponseBuilder()ComposeActionResponseBuilderComposeActionResponseBuilder を作成します。
newCreateMessageAction()CreateMessageActionCreateMessageAction を作成します。
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilderDriveItemsSelectedActionResponseBuilder を作成します。
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilderEditorFileScopeActionResponseBuilder を作成します。
newLinkPreview()LinkPreviewLinkPreview を作成します。
newNavigation()NavigationNavigation を作成します。
newNotification()NotificationNotification を作成します。
newOpenLink()OpenLinkOpenLink を作成します。
newRenderActionBuilder()RenderActionBuilder新しい RenderActionBuilder を作成します。
newUniversalActionResponseBuilder()UniversalActionResponseBuilderUniversalActionResponseBuilder を作成します。
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilderUpdateDraftActionResponseBuilder を作成します。
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsActionUpdateDraftBccRecipientsAction を作成します。
newUpdateDraftBodyAction()UpdateDraftBodyActionUpdateDraftBodyAction を作成します。
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsActionUpdateDraftCcRecipientsAction を作成します。
newUpdateDraftSubjectAction()UpdateDraftSubjectActionUpdateDraftSubjectAction を作成します。
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsActionUpdateDraftToRecipientsAction を作成します。
newUpdateInlinePreviewAction()UpdateInlinePreviewActionUpdateInlinePreviewAction を作成します。
newUpdateMessageAction()UpdateMessageActionUpdateMessageAction を作成します。

AddonComposeUiActionResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

AddonComposeUiActionResponseBuilder

メソッド

メソッド戻り値の型概要
build()AddonComposeUiActionResponse現在のアドオンのコンポーズ UI アクション レスポンスをビルドして検証します。
setType(type)AddonComposeUiActionResponseBuilderアドオンのコンポーズ UI アクションを決定する列挙型フィールドを設定します。

AddonComposeUiActionType

プロパティ

プロパティタイプ説明
DISMISSEnumデフォルト。

Attachment

メソッド

メソッド戻り値の型概要
setIconUrl(iconUrl)Attachment添付ファイルのアイコン URL を設定します。
setMimeType(mimeType)Attachment添付ファイルの MIME タイプを設定します。
setResourceUrl(resourceUrl)Attachment添付ファイルのリソース URL を設定します。
setTitle(title)Attachment添付ファイルのタイトルを設定します。

BasicDataType

プロパティ

プロパティタイプ説明
BASIC_TYPE_UNSPECIFIEDEnumデフォルト値。
STRINGEnum文字列。
INTEGEREnum整数値。
FLOATEnum浮動小数点数。
TIMESTAMPEnumISO 8601 形式のタイムスタンプ。
BOOLEANEnumブール値。
EMAIL_ADDRESSEnumメールアドレス形式の文字列。
GOOGLE_USEREnumGoogle サービスのユーザー(「users/encoded_GAIA_ID」の形式)
FILEEnumファイル形式。
FORMATTED_TEXTEnumリッチテキスト形式のテキスト。

CalendarEventActionResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

CalendarEventActionResponseBuilder

メソッド

メソッド戻り値の型概要
addAttachments(attachments)CalendarEventActionResponseBuilder関連する UI アクションが実行されたときに、レスポンスで添付ファイルをカレンダーの予定に追加することを指定します。
addAttendees(emails)CalendarEventActionResponseBuilder関連する UI アクションが実行されたときに、レスポンスで指定された出席者をカレンダーの予定に追加することを指定します。
build()CalendarEventActionResponse現在のカレンダーの予定のアクション レスポンスをビルドして検証します。
setConferenceData(conferenceData)CalendarEventActionResponseBuilder関連する UI アクションが実行されたときに、レスポンスで指定された会議データをカレンダーの予定に設定する必要があることを指定します。

ChatDataActionsResponseBuilder

メソッド

メソッド戻り値の型概要
build()DataActionsResponse現在のアクション レスポンスをビルドします。
setCreateChatMessageAction(createMessageAction)ChatDataActionsResponseBuilderこの DataActionsResponseCreateMessageAction を設定します。
setUpdateChatMessageAction(updateMessageAction)ChatDataActionsResponseBuilderこの DataActionsResponseUpdateMessageAction を設定します。
setUpdateInlinePreviewAction(updateInlinePreviewAction)ChatDataActionsResponseBuilderこの DataActionsResponseUpdateInlinePreviewAction を設定します。

ChatMessage

メソッド

メソッド戻り値の型概要
addCardWithId(cardWithId)ChatMessageメッセージのカードを設定します。
setText(text)ChatMessageメッセージのテキストを設定します。

Color

メソッド

メソッド戻り値の型概要
setAlpha(alpha)Color色のアルファ要素を設定します。
setBlue(blue)Color色の青要素を設定します。
setGreen(green)Color色の緑の要素を設定します。
setRed(red)Color色の赤色成分を設定します。

ComposeActionResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

ComposeActionResponseBuilder

メソッド

メソッド戻り値の型概要
build()ComposeActionResponse現在のコンポーズ アクション レスポンスを構築して検証します。
setGmailDraft(draft)ComposeActionResponseBuilderGmailMessage.createDraftReply(body) などの関数を使用して作成された下書き GmailMessage を設定します。

ComposedEmailType

プロパティ

プロパティタイプ説明
REPLY_AS_DRAFTEnum別のメッセージへの返信の下書き。
STANDALONE_DRAFTEnumスタンドアロン メッセージの下書き。

ContentType

プロパティ

プロパティタイプ説明
TEXTEnum生成されたコンテンツがプレーン テキストであることを示します。
MUTABLE_HTMLEnum生成されたコンテンツが HTML 形式であることを示します。
IMMUTABLE_HTMLEnum生成されたコンテンツが HTML 形式であることを示します。このコンテンツは生成後に編集できません。

CreateMessageAction

メソッド

メソッド戻り値の型概要
setMessage(message)CreateMessageActionこのアクションのメッセージを設定します。

DataActionsResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

DataType

メソッド

メソッド戻り値の型概要
setBasicDataType(basicDataType)DataTypeデータ型をサポートされている BasicDataType のいずれかに設定します。
setResourceType(resourceType)DataTypeデータ型をカスタム定義の ResourceType に設定します。
setValueMetadata(valueMetadata)DataType変数の型関連情報を含む ValueMetadata を設定します。

DriveItemsSelectedActionResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

DriveItemsSelectedActionResponseBuilder

メソッド

メソッド戻り値の型概要
build()DriveItemsSelectedActionResponse現在のドライブ アクション レスポンスをビルドします。
requestFileScope(itemId)DriveItemsSelectedActionResponseBuilderレスポンスが、ドライブ内のコンテキストに関連するアイテムのファイル スコープをリクエストすることを指定します。

DynamicResourceDefinition

メソッド

メソッド戻り値の型概要
addResourceField(resourceField)DynamicResourceDefinition動的リソース定義にリソース フィールドを追加します。
setResourceId(resourceId)DynamicResourceDefinition動的リソース定義の ID を設定します。この ID はマニフェストの workflowResourceDefinitionId に対応します。

EditorFileScopeActionResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

EditorFileScopeActionResponseBuilder

メソッド

メソッド戻り値の型概要
build()EditorFileScopeActionResponse現在のエディタ アクション レスポンスをビルドします。
requestFileScopeForActiveDocument()EditorFileScopeActionResponseBuilder現在アクティブなエディタ ドキュメントの drive.file スコープをリクエストします。

EndNavigation

プロパティ

プロパティタイプ説明
ACTION_UNSPECIFIEDEnumアクションが指定されていません。
CLOSE_DIALOGEnumダイアログを閉じます。
CLOSE_DIALOG_AND_EXECUTEEnumダイアログを閉じ、ダイアログを開いたカードを更新します。

ErrorActionability

プロパティ

プロパティタイプ説明
ERROR_ACTIONABILITY_UNSPECIFIEDEnum指定なし。
NOT_ACTIONABLEEnumこのエラーは、構成カードからユーザーが修正することはできません。
ACTIONABLEEnumこのエラーは、設定カードからユーザーが修正できます。

ErrorRetryability

プロパティ

プロパティタイプ説明
RETRYABILITY_UNSPECIFIEDEnum指定なし。
NOT_RETRYABLEEnumこのエラーは再試行できません。フローは最初の試行後に終了します。
RETRYABLEEnumエラーは再試行可能です。Workflow は Step の実行を最大 5 回試行します。

FontWeight

プロパティ

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

HostAppAction

メソッド

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

メソッド

メソッド戻り値の型概要
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 を設定します。

メソッド

メソッド戻り値の型概要
setTitle(title)Linkリンクのタイトルを設定します。
setUrl(url)Linkリンクの URL を設定します。

LinkPreview

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。
setLinkPreviewTitle(title)LinkPreviewプレビュー カードの上のリンク プレビューに表示されるタイトルを設定します。
setPreviewCard(previewCard)LinkPreviewサードパーティまたは Google 以外のサービスからのリンクに関する情報を表示するカードを設定します。
setTitle(title)LinkPreviewリンクのプレビューのスマートチップに表示されるタイトルを設定します。

ListContainer

メソッド

メソッド戻り値の型概要
addListItem(listItem)ListContainerリストアイテムをリスト コンテナに追加します。
setListNestLevel(listLevel)ListContainerリストのレベルを設定します。最上位のリストは 0 から始まり、ネストされたリストごとに 1 ずつ増えます。
setListType(listType)ListContainerリストのタイプを順序付きまたは順序なしに設定します。

ListItem

メソッド

メソッド戻り値の型概要
addTextFormatElement(textFormatElement)ListItemリストアイテムに TextFormatElement を追加します。

ListType

プロパティ

プロパティタイプ説明
LIST_TYPE_UNSPECIFIEDEnumデフォルト値。
ORDEREDEnum順序付きリスト。
UNORDEREDEnum順序なしリスト。

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 を設定します。

メソッド

メソッド戻り値の型概要
popCard()Navigation
popToNamedCard(cardName)Navigation
popToRoot()Navigation
printJson()Stringこのオブジェクトの JSON 表現を出力します。
pushCard(card)Navigation指定されたカードをスタックにプッシュします。
setEndNavigation(endNavigation)Navigation終了ナビゲーション アクションを設定します。
updateCard(card)Navigation現在のカードをその場で置き換えます。

Notification

メソッド

メソッド戻り値の型概要
setText(text)Notification通知に表示するテキストを設定します。

OnClose

プロパティ

プロパティタイプ説明
NOTHINGEnum閉じる際に何もしない。
RELOADEnumウィンドウが閉じると、アドオンを再読み込みします。

OpenAs

プロパティ

プロパティタイプ説明
FULL_SIZEEnum全画面のウィンドウまたはタブで開きます。
OVERLAYEnumポップアップなどのオーバーレイとして開きます。

メソッド

メソッド戻り値の型概要
setOnClose(onClose)OpenLinkURL ウィンドウまたはタブが閉じられたときの URL アクションの動作を設定します。
setOpenAs(openAs)OpenLinkURL が開かれたときの動作を設定します。
setUrl(url)OpenLink開く URL を設定します。

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)ResourceRetrievedActionResourceData をリソース取得アクションに設定して、動的リソース フィールドまたはカスタム リソース フィールドに値を指定します。

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

SendStatus

プロパティ

プロパティタイプ説明
NOT_SENDEnumデフォルト。
CONTINUE_SENDEnum下書きを更新した後もメールの送信を続けます。

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)TextFormatIconGoogle マテリアル アイコンで定義されたマテリアル アイコン名を設定します。

TextStyle

プロパティ

プロパティタイプ説明
STYLE_UNSPECIFIEDEnumスタイルは適用されていません。
ITALICEnum斜体スタイル。
UNDERLINEEnum下線のスタイル。
STRIKETHROUGHEnum取り消し線スタイル。
LINE_BREAKEnum改行。
UPPERCASEEnum大文字スタイル。
CODEEnumコードスタイル。
CODE_BLOCKEnumコードブロックのスタイル。

TimeStamp

メソッド

メソッド戻り値の型概要
setNanos(nanos)TimeStampタイムスタンプのナノ秒を設定します。これは、現在の秒内のナノ秒数を表します。
setSeconds(seconds)TimeStampタイムスタンプの秒数を設定します。これは、UNIX エポック(1970 年 1 月 1 日 00:00:00 UTC)からの秒数を表します。

UniversalActionResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

UniversalActionResponseBuilder

メソッド

メソッド戻り値の型概要
build()UniversalActionResponse現在のユニバーサル アクション レスポンスを構築して検証します。
displayAddOnCards(cardObjects)UniversalActionResponseBuilder指定されたカードを含むアドオンを表示します。
setOpenLink(openLink)UniversalActionResponseBuilderユニバーサル アクションが選択されたときに開く URL を設定します。

UpdateDraftActionResponse

メソッド

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。

UpdateDraftActionResponseBuilder

メソッド

メソッド戻り値の型概要
build()UpdateDraftActionResponse現在の更新ドラフト アクション レスポンスを作成して検証します。
setSendStatus(sendStatus)UpdateDraftActionResponseBuilder更新アクション後にメールを送信するかどうかを決定する列挙型フィールドを設定します。
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)UpdateDraftActionResponseBuilder下書きのメールの Bcc 受信者を更新するアクションを設定します。
setUpdateDraftBodyAction(updateDraftBodyAction)UpdateDraftActionResponseBuilder下書きのメール本文を更新するアクションを設定します。
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)UpdateDraftActionResponseBuilder下書きの Cc 受信者を更新するアクションを設定します。
setUpdateDraftSubjectAction(updateDraftSubjectAction)UpdateDraftActionResponseBuilder下書きの件名を更新するアクションを設定します。
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)UpdateDraftActionResponseBuilder下書きの宛先を更新するアクションを設定します。

UpdateDraftBccRecipientsAction

メソッド

メソッド戻り値の型概要
addUpdateBccRecipients(bccRecipientEmails)UpdateDraftBccRecipientsActionメールの下書きの Bcc 受信者を更新します。

UpdateDraftBodyAction

メソッド

メソッド戻り値の型概要
addUpdateContent(content, contentType)UpdateDraftBodyAction指定したコンテンツを下書きの本文に追加します。
setUpdateType(updateType)UpdateDraftBodyAction下書き本文でこの更新アクションの UpdateDraftBodyType を設定します。

UpdateDraftBodyType

プロパティ

プロパティタイプ説明
IN_PLACE_INSERTEnumデフォルト。
INSERT_AT_STARTEnum更新アクションでは、メッセージ本文の先頭にコンテンツが挿入されます。
INSERT_AT_ENDEnum更新アクションでは、メッセージ本文の末尾にコンテンツが挿入されます。

UpdateDraftCcRecipientsAction

メソッド

メソッド戻り値の型概要
addUpdateCcRecipients(ccRecipientEmails)UpdateDraftCcRecipientsActionメールの下書きの Cc 受信者を更新します。

UpdateDraftSubjectAction

メソッド

メソッド戻り値の型概要
addUpdateSubject(subject)UpdateDraftSubjectActionメールの下書きの件名を更新します。

UpdateDraftToRecipientsAction

メソッド

メソッド戻り値の型概要
addUpdateToRecipients(toRecipientEmails)UpdateDraftToRecipientsActionメールの下書きの宛先を更新します。

UpdateInlinePreviewAction

メソッド

メソッド戻り値の型概要
addCardWithId(cardWithId)UpdateInlinePreviewActionこのアクションのカードを追加します。
addExpiration(ttl)UpdateInlinePreviewActionこのアクションの有効期限を追加します。

UpdateMessageAction

メソッド

メソッド戻り値の型概要
setMessage(message)UpdateMessageActionこのアクションのメッセージを設定します。

UpdateWidget

メソッド

メソッド戻り値の型概要
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidget複数選択メニューで選択できる新しい項目を追加します。

ValidationErrorSeverity

プロパティ

プロパティタイプ説明
SEVERITY_UNSPECIFIEDEnum指定なし。
CRITICALEnum重大: エラーが重大であり、公開前に修正する必要があります。
WARNINGEnum警告: エラーは重大ではなく、公開をブロックしていません。

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検証エラーの重大度を設定します。