Card Service

カードサービス

このサービスを使用すると、スクリプトで UI のカード、ウィジェットのコンポーネント、動作を構成および構築できます。このサービスで作成した UI 構造は、パソコンとモバイル デバイスの両方で自動的に利用可能になるため、両方に個別の UI を開発する必要はありません。

クラス

名前概要
ActionUI 要素内でインタラクティビティを可能にするアクション。
ActionResponseクライアントで 1 つ以上のアクションを実行するためにコールバック関数(フォーム レスポンス ハンドラなど)から返されるレスポンス オブジェクト。
ActionResponseBuilderActionResponse オブジェクトのビルダー。
ActionStatus
Attachmentアドオンによって作成された添付ファイルを表します。
AuthorizationActionユーザーがクリックされたときに AuthorizationUrl に移動する承認アクション。
AuthorizationException承認カードをユーザーに表示するために返されるエラーです。
BorderStyleウィジェットに適用できる完全な枠線スタイルを表すクラス。
BorderTypeウィジェットに適用できる枠線の種類を表す列挙型。
Buttonすべてのボタンの基本クラス。
ButtonSet行に表示される Button オブジェクトのセットを保持します。
CalendarEventActionResponseUI で行われた操作(ボタンのクリックなど)に反応して、ユーザーが現在編集しているカレンダーの予定を変更するレスポンスを表します。
CalendarEventActionResponseBuilderCalendarEventActionResponse オブジェクトのビルダー。
CardUI の単一ビューを表すコンテキスト カード
CardActionカードヘッダー メニューに追加されるクリック可能なメニュー項目。
CardBuilderCard オブジェクトのビルダー。
CardHeaderCard のヘッダー。
CardSectionカード セクションにはウィジェットのグループがまとめられ、視覚的に区別できます。
CardServiceCardService は、Google Workspace アドオンなどのさまざまな Google 拡張プロダクトで使用される汎用カードを作成する機能を提供します。
CardWithId
ChatActionResponse
ChatClientDataSource
ChatResponse
ChatResponseBuilder
ChatSpaceDataSource
CommonDataSource
ComposeActionResponseGmail アドオンの作成アクションに対するコールバック メソッドから返される可能性のあるレスポンス オブジェクト。
ComposeActionResponseBuilderComposeActionResponse オブジェクトのビルダー。
ComposedEmailType作成されたメールが単独のメールか返信の下書きかを指定する列挙値。
ContentTypeUpdateDraftActionResponse によって生成されたコンテンツのコンテンツ タイプを指定する列挙値。
DatePicker日付を入力できる入力フィールド。
DateTimePickerユーザーが日時を入力できる入力フィールド。
DecoratedTextテキストを任意の装飾で表示するウィジェット。
Dialog
DialogAction
DisplayStyleカードの表示スタイルを定義する列挙型。
Divider横方向の分割線。
DriveItemsSelectedActionResponseドライブのアイテムが選択されているとき、および UI で行われた操作(ボタンのクリックなど)に反応してドライブを変更するレスポンスを表します。
DriveItemsSelectedActionResponseBuilderDriveItemsSelectedActionResponse オブジェクトのビルダー。
EditorFileScopeActionResponseUI で行った操作に応じて、Google ドキュメント、スプレッドシート、スライドなどのエディタに変更を加えます。
EditorFileScopeActionResponseBuilderEditorFileScopeActionResponse オブジェクトのビルダー。
FixedFooterCard の下部に表示される固定フッター。
Gridグリッド アイテムのコレクションを表示する整理されたグリッド。
GridItemグリッド ウィジェット内でユーザーが操作するアイテム。
GridItemLayoutGridItem の画像とテキスト スタイルを定義する列挙型。
HorizontalAlignmentウィジェットの水平方向の配置を指定する列挙型。
HostAppDataSource
Iconさまざまな UI オブジェクト(ImageButton ウィジェットや DecoratedText ウィジェットなど)で使用できる定義済みのアイコン。
IconImage事前定義されたアイコン、またはカスタマイズ可能な切り抜きスタイルが設定された URL のアイコン。
Image1 つの画像を表示するウィジェット。
ImageButton画像が表示された ImageButton
ImageComponentグリッド アイテムに追加できる画像コンポーネント。
ImageCropStyle画像コンポーネントに適用できる切り抜きスタイルを表すクラス。
ImageCropType画像コンポーネントに適用される切り抜きスタイルを表す列挙型。
ImageStyle画像の切り抜きスタイルを定義する列挙型。
Interaction
KeyValueこのクラスは非推奨になりました。
LinkPreviewホストアプリでリンク プレビュー カードとスマートチップを表示するカード アクション。
LoadIndicatorAction の処理中に表示する読み込みインジケーターまたは進行状況インジケーターのタイプを指定する列挙型。
Navigationカード ナビゲーションを制御するヘルパー オブジェクト。
NotificationUI 要素を操作したことに対するレスポンスとしてユーザーに表示される通知。
OnCloseOpenLink を介して開かれた URL が閉じられたときの動作を指定する列挙型。
OpenAsURL を開く方法を指定する列挙型。
OpenLinkオプションを指定してリンクを開くアクションを表します。
PlatformDataSource
ResponseType
SelectionInput定義済みのオプションのセットから選択できるようにする入力フィールド。
SelectionInputTypeユーザーが選択できるアイテムの形式。
Statusステータス コードを表す列挙型。
SuggestionsTextInput ウィジェットを補完するオートコンプリート候補。
SuggestionsResponse提案コールバック関数から返せるレスポンス オブジェクト。
SuggestionsResponseBuilderSuggestionsResponse オブジェクトのビルダー。
Switchオンとオフの切り替えをサポートする UI 要素。
SwitchControlTypeSwitch ウィジェット コントロールのタイプ。
TextButtonテキストラベル付きの TextButton
TextButtonStyleTextButton のスタイルを指定する列挙型。
TextInputテキスト入力を受け入れる入力フィールド ウィジェット。
TextParagraphテキストを表示し、基本的な HTML フォーマットをサポートするウィジェット。
TimePickerユーザーが時刻を入力できる入力フィールド。
UniversalActionResponse汎用的なアクションを作成するメソッドから返されるレスポンス オブジェクト。
UniversalActionResponseBuilderUniversalActionResponse オブジェクトのビルダー。
UpdateDraftActionResponseユーザーが現在編集しているメールの下書きを更新するアクションを表します。
UpdateDraftActionResponseBuilderUpdateDraftActionResponse オブジェクトのビルダー。
UpdateDraftBccRecipientsActionメールの下書きの Bcc の宛先を更新します。
UpdateDraftBodyActionメールの下書き本文を更新します。
UpdateDraftBodyTypeUpdateDraftBodyAction のタイプを指定する列挙値。
UpdateDraftCcRecipientsActionメールの下書きの Cc の宛先を更新します。
UpdateDraftSubjectActionメールの下書きの件名を更新します。
UpdateDraftToRecipientsActionメールの下書きの宛先を更新します。
UpdatedWidget
WidgetCard に追加できるすべてのウィジェットの基本クラス。

Action

Methods

メソッド戻り値の型概要
setFunctionName(functionName)Action呼び出されるコールバック関数の名前を設定します。
setInteraction(interaction)Actionユーザーとのやり取りを設定します。ダイアログを開く場合にのみ必要です。
setLoadIndicator(loadIndicator)Actionアクションの進行中に表示される読み込みインジケーターを設定します。
setParameters(parameters)Actionカスタム パラメータをコールバック関数に渡すことができます。
setPersistValues(persistValues)Actionアクション レスポンスによってフォームの Card が更新された後に、フォームの値がクライアントの値とサーバーの値のどちらで決定されるかを示します。

ActionResponse

Methods

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

ActionResponseBuilder

Methods

メソッド戻り値の型概要
build()ActionResponse現在のアクション レスポンスを作成して検証します。
setNavigation(navigation)ActionResponseBuilderNavigation アクションへのレスポンスを設定します。
setNotification(notification)ActionResponseBuilderアクションがアクティブになったときに表示する通知を設定します。
setOpenLink(openLink)ActionResponseBuilderアクションがアクティブになったときの移動先の URL を設定します。
setStateChanged(stateChanged)ActionResponseBuilderこのアクションによって既存のデータ状態が変更されたことを示すフラグを設定します。

ActionStatus

Methods

メソッド戻り値の型概要
setStatusCode(statusCode)ActionStatusダイアログを開くリクエストまたは送信するリクエストのステータスを表します。
setUserFacingMessage(message)ActionStatusリクエストのステータスについてユーザーに送信するメッセージ。

Attachment

Methods

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

AuthorizationAction

Methods

メソッド戻り値の型概要
setAuthorizationUrl(authorizationUrl)AuthorizationActionユーザーが認証プロンプトから移動される認証 URL を設定します。

AuthorizationException

Methods

メソッド戻り値の型概要
printJson()Stringこのオブジェクトの JSON 表現を出力します。
setAuthorizationUrl(authUrl)AuthorizationExceptionユーザーが認証プロンプトから移動される認証 URL を設定します。
setCustomUiCallback(callback)AuthorizationExceptionカスタム認証プロンプトを生成するために呼び出す関数の名前。
setResourceDisplayName(name)AuthorizationException承認を求めるときにユーザーに表示される名前を設定します。
throwException()voidこの例外をトリガーしてスローします。

BorderStyle

Methods

メソッド戻り値の型概要
setCornerRadius(radius)BorderStyle枠線の角の丸みを設定します(例: 8)。
setStrokeColor(color)BorderStyle枠線の色を設定します。
setType(type)BorderStyle枠線の種類を設定します。

BorderType

プロパティ

プロパティタイプ説明
NO_BORDEREnum枠線のスタイルがありません。
STROKEEnumストロークの枠線のスタイル。

Button

Methods

メソッド戻り値の型概要
setAuthorizationAction(action)Buttonオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setComposeAction(action, composedEmailType)Buttonオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setOnClickAction(action)Buttonオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)Buttonオブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
setOpenLink(openLink)Buttonオブジェクトがクリックされたときに開く URL を設定します。

ButtonSet

Methods

メソッド戻り値の型概要
addButton(button)ButtonSetボタンを追加します。

CalendarEventActionResponse

Methods

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

CalendarEventActionResponseBuilder

Methods

メソッド戻り値の型概要
addAttachments(attachments)CalendarEventActionResponseBuilder関連する UI 操作が行われたときに、返信でカレンダーの予定に添付ファイルを追加するよう指定します。
addAttendees(emails)CalendarEventActionResponseBuilder関連する UI 操作が行われたときに、指定された参加者をカレンダーの予定に追加するよう応答するよう指定します。
build()CalendarEventActionResponseカレンダーの現在の予定アクションに対する返信を作成し、検証します。
setConferenceData(conferenceData)CalendarEventActionResponseBuilder関連する UI 操作が行われたときに、指定した会議データをカレンダーの予定に設定するよう応答で指定します。

Card

Methods

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

CardAction

Methods

メソッド戻り値の型概要
setAuthorizationAction(action)CardActionオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setComposeAction(action, composedEmailType)CardActionオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setOnClickAction(action)CardActionオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)CardActionオブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
setOpenLink(openLink)CardActionオブジェクトがクリックされたときに開く URL を設定します。
setText(text)CardActionこのアクションのメニュー テキストを設定します。

CardBuilder

Methods

メソッド戻り値の型概要
addCardAction(cardAction)CardBuilderこのカードに CardAction を追加します。
addSection(section)CardBuilderこのカードにセクションを追加します。
build()Card現在のカードをビルドして検証します。
setDisplayStyle(displayStyle)CardBuilderこのカードの表示スタイルを設定します。
setFixedFooter(fixedFooter)CardBuilderこのカードの固定フッターを設定します。
setHeader(cardHeader)CardBuilderこのカードのヘッダーを設定します。
setName(name)CardBuilderこのカードの名前を設定します。
setPeekCardHeader(peekCardHeader)CardBuilderピークカードのヘッダーを設定します。

CardHeader

Methods

メソッド戻り値の型概要
setImageAltText(imageAltText)CardHeaderヘッダー画像の代替テキストを設定します。
setImageStyle(imageStyle)CardHeaderカードヘッダーのアイコンのトリミングを設定します。
setImageUrl(imageUrl)CardHeaderURL またはデータ文字列を指定して、ヘッダーで使用する画像を設定します。
setSubtitle(subtitle)CardHeaderカードヘッダーのサブタイトルを設定します。
setTitle(title)CardHeaderカードヘッダーのタイトルを設定します。

CardSection

Methods

メソッド戻り値の型概要
addWidget(widget)CardSection指定されたウィジェットをこのセクションに追加します。
setCollapsible(collapsible)CardSectionセクションを折りたたむかどうかを設定します。
setHeader(header)CardSectionセクションのヘッダーを設定します。
setNumUncollapsibleWidgets(numUncollapsibleWidgets)CardSectionこのセクションを閉じたときに表示するウィジェットの数を設定します。

CardService

プロパティ

プロパティタイプ説明
BorderTypeBorderTypeBorderType 列挙型。
ComposedEmailTypeComposedEmailTypeComposedEmailType 列挙型。
ContentTypeContentTypeContentType 列挙型。
GridItemLayoutGridItemLayoutGridItemLayout 列挙型。
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 列挙型。
IconIconIcon 列挙型。
ImageCropTypeImageCropTypeImageCropType 列挙型。
ImageStyleImageStyleImageStyle 列挙型。
LoadIndicatorLoadIndicatorLoadIndicator 列挙型。
OnCloseOnCloseOnClose 列挙型。
OpenAsOpenAsOpenAs 列挙型。
SelectionInputTypeSelectionInputTypeSelectionInputType 列挙型。
TextButtonStyleTextButtonStyleTextButtonStyle 列挙型。
UpdateDraftBodyTypeUpdateDraftBodyTypeUpdateDraftBodyType 列挙型。

Methods

メソッド戻り値の型概要
newAction()Action新しい Action を作成します。
newActionResponseBuilder()ActionResponseBuilder新しい ActionResponseBuilder を作成します。
newActionStatus()ActionStatus新しい ActionStatus を作成します。
newAttachment()Attachment新しい Attachment を作成します。
newAuthorizationAction()AuthorizationAction新しい AuthorizationAction を作成します。
newAuthorizationException()AuthorizationException新しい AuthorizationException を作成します。
newBorderStyle()BorderStyle新しい BorderStyle を作成します。
newButtonSet()ButtonSet新しい ButtonSet を作成します。
newCalendarEventActionResponseBuilder()CalendarEventActionResponseBuilder新しい CalendarEventActionResponseBuilder を作成します。
newCardAction()CardAction新しい CardAction を作成します。
newCardBuilder()CardBuilder新しい CardBuilder を作成します。
newCardHeader()CardHeader新しい CardHeader を作成します。
newCardSection()CardSection新しい CardSection を作成します。
newCardWithId()CardWithId新しい CardWithId を作成します。
newChatActionResponse()ChatActionResponse新しい ChatActionResponse を作成します。
newChatResponseBuilder()ChatResponseBuilder新しい ChatResponseBuilder を作成します。
newComposeActionResponseBuilder()ComposeActionResponseBuilder新しい ComposeActionResponseBuilder を作成します。
newDatePicker()DatePicker新しい DatePicker を作成します。
newDateTimePicker()DateTimePicker新しい DateTimePicker を作成します。
newDecoratedText()DecoratedText新しい DecoratedText を作成します。
newDialog()Dialog新しい Dialog を作成します。
newDialogAction()DialogAction新しい DialogAction を作成します。
newDivider()Divider新しい Divider を作成します。
newDriveItemsSelectedActionResponseBuilder()DriveItemsSelectedActionResponseBuilder新しい DriveItemsSelectedActionResponseBuilder を作成します。
newEditorFileScopeActionResponseBuilder()EditorFileScopeActionResponseBuilder新しい EditorFileScopeActionResponseBuilder を作成します。
newFixedFooter()FixedFooter新しい FixedFooter を作成します。
newGrid()Grid新しい Grid を作成します。
newGridItem()GridItem新しい GridItem を作成します。
newIconImage()IconImage新しい IconImage を作成します。
newImage()Image新しい Image を作成します。
newImageButton()ImageButton新しい ImageButton を作成します。
newImageComponent()ImageComponent新しい ImageComponent を作成します。
newImageCropStyle()ImageCropStyle新しい ImageCropStyle を作成します。
newKeyValue()KeyValue新しい KeyValue を作成します。
newLinkPreview()LinkPreview新しい LinkPreview を作成します。
newNavigation()Navigation新しい Navigation を作成します。
newNotification()Notification新しい Notification を作成します。
newOpenLink()OpenLink新しい OpenLink を作成します。
newSelectionInput()SelectionInput新しい SelectionInput を作成します。
newSuggestions()Suggestions新しい Suggestions を作成します。
newSuggestionsResponseBuilder()SuggestionsResponseBuilder新しい SuggestionsResponseBuilder を作成します。
newSwitch()Switch新しい Switch を作成します。
newTextButton()TextButton新しい TextButton を作成します。
newTextInput()TextInput新しい TextInput を作成します。
newTextParagraph()TextParagraph新しい TextParagraph を作成します。
newTimePicker()TimePicker新しい TimePicker を作成します。
newUniversalActionResponseBuilder()UniversalActionResponseBuilder新しい UniversalActionResponseBuilder を作成します。
newUpdateDraftActionResponseBuilder()UpdateDraftActionResponseBuilder新しい UpdateDraftActionResponseBuilder を作成します。
newUpdateDraftBccRecipientsAction()UpdateDraftBccRecipientsAction新しい UpdateDraftBccRecipientsAction を作成します。
newUpdateDraftBodyAction()UpdateDraftBodyAction新しい UpdateDraftBodyAction を作成します。
newUpdateDraftCcRecipientsAction()UpdateDraftCcRecipientsAction新しい UpdateDraftCcRecipientsAction を作成します。
newUpdateDraftSubjectAction()UpdateDraftSubjectAction新しい UpdateDraftSubjectAction を作成します。
newUpdateDraftToRecipientsAction()UpdateDraftToRecipientsAction新しい UpdateDraftToRecipientsAction を作成します。

CardWithId

Methods

メソッド戻り値の型概要
setCard(card)CardWithIdcardWithId のカードを設定します。
setCardId(id)CardWithIdcardWithId の一意のカード ID を設定します。

ChatActionResponse

Methods

メソッド戻り値の型概要
setDialogAction(dialogAction)ChatActionResponseダイアログ アクションをダイアログに関連するイベントに設定します。
setResponseType(responseType)ChatActionResponseChat アプリのレスポンスの種類。
setUpdatedWidget(updatedWidget)ChatActionResponseウィジェットのオートコンプリート オプションを提供するために使用される、更新されたウィジェットを設定します。
setUrl(url)ChatActionResponseユーザーが認証または構成するための URL。

ChatClientDataSource

Methods

メソッド戻り値の型概要
setSpaceDataSource(spaceDataSource)ChatClientDataSource複数選択メニューの選択項目として Google Chat スペースにデータを入力するデータソース。

ChatResponse

Methods

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

ChatResponseBuilder

Methods

メソッド戻り値の型概要
addCardsV2(cardWithId)ChatResponseBuilderメッセージのカード フィールドを設定します。
build()ChatResponse現在のアクション レスポンスを作成して検証します。
setActionResponse(actionResponse)ChatResponseBuilderメッセージのアクション レスポンス フィールドを設定します。
setText(text)ChatResponseBuilderChat メッセージのテキストを設定します。

ChatSpaceDataSource

Methods

メソッド戻り値の型概要
setDefaultToCurrentSpace(defaultToCurrentSpace)ChatSpaceDataSourcetrue に設定すると、複数選択メニューで、現在の Google Chat スペースがデフォルトでアイテムとして選択されます。

CommonDataSource

プロパティ

プロパティタイプ説明
UNKNOWNEnumデフォルト値。
USEREnumGoogle Workspace ユーザー。

ComposeActionResponse

Methods

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

ComposeActionResponseBuilder

Methods

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

ComposedEmailType

プロパティ

プロパティタイプ説明
REPLY_AS_DRAFTEnum別のメールへの返信の下書きです。
STANDALONE_DRAFTEnum単独のメールの下書きです。

ContentType

プロパティ

プロパティタイプ説明
TEXTEnum生成されたコンテンツが書式なしテキストであることを示します。
MUTABLE_HTMLEnum生成されたコンテンツが HTML としてフォーマットされていることを示します。
IMMUTABLE_HTMLEnum生成されたコンテンツは HTML 形式ですが、生成後に編集できないことを示します。

DatePicker

Methods

メソッド戻り値の型概要
setFieldName(fieldName)DatePickerUI インタラクション時に生成されるイベント オブジェクトで、この選択ツールを識別するフィールド名を設定します。
setOnChangeAction(action)DatePicker選択ツール入力が変更されるたびにスクリプトが実行する Action を設定します。
setTitle(title)DatePicker入力フィールドの上に表示されるタイトルを設定します。
setValueInMsSinceEpoch(valueMsEpoch)DatePicker入力フィールドに設定する事前入力された値を設定します。
setValueInMsSinceEpoch(valueMsEpoch)DatePicker入力フィールドに設定する事前入力された値を設定します。

DateTimePicker

Methods

メソッド戻り値の型概要
setFieldName(fieldName)DateTimePickerUI インタラクション時に生成されるイベント オブジェクトで、この選択ツールを識別するフィールド名を設定します。
setOnChangeAction(action)DateTimePicker選択ツール入力が変更されるたびにスクリプトが実行する Action を設定します。
setTimeZoneOffsetInMins(timeZoneOffsetMins)DateTimePickerタイムゾーンと UTC のオフセットを分単位で設定します。
setTitle(title)DateTimePicker入力フィールドの上に表示されるタイトルを設定します。
setValueInMsSinceEpoch(valueMsEpoch)DateTimePicker入力フィールドに設定する事前入力された値を設定します。
setValueInMsSinceEpoch(valueMsEpoch)DateTimePicker入力フィールドに設定する事前入力された値を設定します。

DecoratedText

Methods

メソッド戻り値の型概要
setAuthorizationAction(action)DecoratedTextオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setBottomLabel(text)DecoratedTextキーとして使用されるラベルテキストを設定します。テキスト コンテンツの下に表示されます。
setButton(button)DecoratedTextテキストの右側に表示される Button を設定します。
setComposeAction(action, composedEmailType)DecoratedTextオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setEndIcon(endIcon)DecoratedTextコンテンツの右側に表示される IconImage(省略可)を設定します。
setOnClickAction(action)DecoratedTextオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)DecoratedTextオブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
setOpenLink(openLink)DecoratedTextオブジェクトがクリックされたときに開く URL を設定します。
setStartIcon(startIcon)DecoratedTextテキスト コンテンツの前に表示するオプションの IconImage を設定します。
setSwitchControl(switchToSet)DecoratedTextコンテンツの右側に表示される Switch を設定します。
setText(text)DecoratedText値として使用されるテキストを設定します。
setTopLabel(text)DecoratedTextキーとして使用されるラベルテキストを設定します。テキスト コンテンツの上に表示されます。
setWrapText(wrapText)DecoratedText値のテキストを 1 行に表示するか複数行で表示するかを設定します。

Dialog

Methods

メソッド戻り値の型概要
setBody(card)DialogDialog のカードを設定します。

DialogAction

Methods

メソッド戻り値の型概要
setActionStatus(actionStatus)DialogActionDialogAction のアクション ステータスを設定します。
setDialog(dialog)DialogActionDialogAction のダイアログを設定します。

DisplayStyle

プロパティ

プロパティタイプ説明
PEEKEnum既存のコンテンツの上に重ねて、アドオン コンテンツの下にカードヘッダーを表示する。
REPLACEEnum既存のコンテンツを置き換えてカードを表示します。

Divider

DriveItemsSelectedActionResponse

Methods

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

DriveItemsSelectedActionResponseBuilder

Methods

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

EditorFileScopeActionResponse

Methods

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

EditorFileScopeActionResponseBuilder

Methods

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

FixedFooter

Methods

メソッド戻り値の型概要
setPrimaryButton(button)FixedFooter固定フッターにメインボタンを設定します。
setSecondaryButton(button)FixedFooterセカンダリ ボタンを固定フッターに設定します。

Grid

Methods

メソッド戻り値の型概要
addItem(gridItem)Gridグリッドに新しいグリッド アイテムを追加します。
setAuthorizationAction(action)Gridオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setBorderStyle(borderStyle)Grid各グリッド アイテムに適用する枠線のスタイルを設定します。
setComposeAction(action, composedEmailType)Gridオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setNumColumns(numColumns)Gridグリッドに表示する列数です。
setOnClickAction(action)Gridオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)Gridオブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
setOpenLink(openLink)Gridオブジェクトがクリックされたときに開く URL を設定します。
setTitle(title)Gridグリッドのタイトル テキストを設定します。

GridItem

Methods

メソッド戻り値の型概要
setIdentifier(id)GridItemグリッド アイテムの識別子を設定します。
setImage(image)GridItemこのグリッド アイテムの画像を設定します。
setLayout(layout)GridItemグリッド アイテムのテキストと画像のレイアウトを設定します。
setSubtitle(subtitle)GridItemグリッド アイテムのサブタイトルを設定します。
setTextAlignment(alignment)GridItemグリッド アイテムの水平方向の配置を設定します。
setTitle(title)GridItemグリッド アイテムのタイトル テキストを設定します。

GridItemLayout

プロパティ

プロパティタイプ説明
TEXT_BELOWEnumタイトルとサブタイトルは、グリッド アイテムの画像の下に表示されます。
TEXT_ABOVEEnumタイトルとサブタイトルは、グリッド アイテムの画像の上に表示されます。

HorizontalAlignment

プロパティ

プロパティタイプ説明
STARTEnumウィジェットを文側の端に揃えます。
CENTEREnumウィジェットを中央に揃えます。
ENDEnumウィジェットを文側の末端に揃えます。

HostAppDataSource

Methods

メソッド戻り値の型概要
setChatDataSource(chatClientDataSource)HostAppDataSourceGoogle Chat のデータソースを設定します。

Icon

プロパティ

プロパティタイプ説明
NONEEnumアイコンがありません。
AIRPLANEEnum飛行機の飛行アイコン
BOOKMARKEnumブックマーク アイコン
BUSEnumバスのアイコン
CAREnum車のアイコン
CLOCKEnum時計のアイコン
CONFIRMATION_NUMBER_ICONEnum確認番号アイコン
DOLLAREnumドルのアイコン
DESCRIPTIONEnum説明アイコン
EMAILEnumメールアイコン
EVENT_PERFORMEREnumメールアイコン
EVENT_SEATEnumイベントの座席アイコン
FLIGHT_ARRIVALEnumフライトの到着アイコン
FLIGHT_DEPARTUREEnumフライトの出発アイコン
HOTELEnumホテルのアイコン
HOTEL_ROOM_TYPEEnumホテルのアイコン
INVITEEnum招待アイコン
MAP_PINEnum地図のピンアイコン
MEMBERSHIPEnumメンバーシップ アイコン
MULTIPLE_PEOPLEEnum複数のユーザー アイコン
OFFEREnum特典アイコン
PERSONEnum人型アイコン
PHONEEnum電話アイコン
RESTAURANT_ICONEnumレストランのアイコン
SHOPPING_CARTEnumショッピング カート アイコン
STAREnumスターアイコン
STOREEnum店舗アイコン
TICKETEnumチケット アイコン
TRAINEnum電車アイコン
VIDEO_CAMERAEnumビデオカメラ アイコン
VIDEO_PLAYEnum動画再生アイコン

IconImage

Methods

メソッド戻り値の型概要
setAltText(altText)IconImageユーザー補助に使用される URL の代替テキストを設定します。
setIcon(icon)IconImageURL が設定されていない場合、事前定義されたアイコンを設定します。
setIconUrl(url)IconImageアイコンが設定されていない場合、アイコンの URL を設定します。
setImageCropType(imageCropType)IconImage画像の切り抜きスタイルを設定します。

Image

Methods

メソッド戻り値の型概要
setAltText(altText)Imageユーザー補助機能向けに画像の代替テキストを設定します。
setAuthorizationAction(action)Imageオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setComposeAction(action, composedEmailType)Imageオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setImageUrl(url)ImageURL またはデータ文字列を指定して、使用する画像を設定します。
setOnClickAction(action)Imageオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)Imageオブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
setOpenLink(openLink)Imageオブジェクトがクリックされたときに開く URL を設定します。

ImageButton

Methods

メソッド戻り値の型概要
setAltText(altText)ImageButtonユーザー補助機能向けにボタンの代替テキストを設定します。
setAuthorizationAction(action)ImageButtonオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setComposeAction(action, composedEmailType)ImageButtonオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setIcon(icon)ImageButtonボタンに表示する事前定義された Icon を設定します。
setIconUrl(url)ImageButtonこのボタンのアイコンとして使用する画像の URL を設定します。
setOnClickAction(action)ImageButtonオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)ImageButtonオブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
setOpenLink(openLink)ImageButtonオブジェクトがクリックされたときに開く URL を設定します。

ImageComponent

Methods

メソッド戻り値の型概要
setAltText(altText)ImageComponent画像の代替テキストを設定します。
setBorderStyle(borderStyle)ImageComponent画像に適用する枠線のスタイルを設定します。
setCropStyle(imageCropStyle)ImageComponent画像の切り抜きスタイルを設定します。
setImageUrl(url)ImageComponent画像の URL を設定します。

ImageCropStyle

Methods

メソッド戻り値の型概要
setAspectRatio(ratio)ImageCropStyle切り抜きタイプが RECTANGLE_CUSTOM の場合に使用するアスペクト比を設定します。
setImageCropType(type)ImageCropStyle画像の切り抜きタイプを設定します。

ImageCropType

プロパティ

プロパティタイプ説明
SQUAREEnum正方形の切り抜きスタイル。
CIRCLEEnum円の切り抜きスタイル。
RECTANGLE_CUSTOMEnumカスタム比率が設定された長方形の切り抜きスタイル。
RECTANGLE_4_3Enumアスペクト比 4:3 の長方形の切り抜きスタイル。

ImageStyle

プロパティ

プロパティタイプ説明
SQUAREEnum切り抜きは不可。
CIRCLEEnum円形に切り抜きます。

Interaction

プロパティ

プロパティタイプ説明
INTERACTION_UNSPECIFIEDEnumデフォルト値。
OPEN_DIALOGEnumダイアログを開きます。これは、Chat アプリでユーザーとやり取りする際に使用するカードベースのインターフェースです。

KeyValue

Methods

メソッド戻り値の型概要
setAuthorizationAction(action)KeyValueオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setComposeAction(action, composedEmailType)KeyValueオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setOnClickAction(action)KeyValueオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)KeyValueオブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
setOpenLink(openLink)KeyValueオブジェクトがクリックされたときに開く URL を設定します。

LinkPreview

Methods

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

LoadIndicator

プロパティ

プロパティタイプ説明
SPINNEREnumスピナー インジケーターを使用します。
NONEEnumインジケーターは使用しないでください。

Methods

メソッド戻り値の型概要
popCard()Navigationナビゲーション スタックからカードをポップします。
popToNamedCard(cardName)Navigationカード名で指定されたカードにポップします。
popToRoot()Navigationカードスタックをルートカードにポップします。
printJson()Stringこのオブジェクトの JSON 表現を出力します。
pushCard(card)Navigation指定されたカードをスタックにプッシュします。
updateCard(card)Navigation現在のカードのインプレース交換を行います。

Notification

Methods

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

OnClose

プロパティ

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

OpenAs

プロパティ

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

Methods

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

PlatformDataSource

Methods

メソッド戻り値の型概要
setCommonDataSource(commonDataSource)PlatformDataSourceGoogle Workspace のデータソースを設定します。
setHostAppDataSource(hostAppDataSource)PlatformDataSource複数選択メニューでスペースを挿入するために使用します。

ResponseType

プロパティ

プロパティタイプ説明
TYPE_UNSPECIFIEDEnumNEW_MESSAGE として処理されるデフォルトの型。
NEW_MESSAGEEnumトピックに新しいメッセージとして投稿します。
UPDATE_MESSAGEEnumChat アプリのメッセージを更新します。
UPDATE_USER_MESSAGE_CARDSEnumユーザーのメッセージのカードを更新する。
REQUEST_CONFIGEnumユーザーに追加の認証または構成を非公開で求めます。
DIALOGEnumダイアログを表示します。
UPDATE_WIDGETEnumウィジェット テキストのオートコンプリートのオプションのクエリ。

SelectionInput

Methods

メソッド戻り値の型概要
addItem(text, value, selected)SelectionInput選択可能な新しい項目を追加します。
addMultiSelectItem(text, value, selected, startIconUri, bottomText)SelectionInput複数選択メニュー用に選択可能な新しい項目を追加します。
setExternalDataSource(action)SelectionInputリレーショナル データベースなどの外部データソースを設定します。
setFieldName(fieldName)SelectionInputUI 操作が行われたときに生成されるイベント オブジェクトで、この選択入力を識別するキーを設定します。
setMultiSelectMaxSelectedItems(maxSelectedItems)SelectionInputユーザーが選択できるアイテムの最大数を設定します。
setMultiSelectMinQueryLength(queryLength)SelectionInputChat アプリがオートコンプリートを照会して候補項目をカードに表示するまでに、ユーザーが入力するテキスト文字数を設定します。
setOnChangeAction(action)SelectionInput選択入力が変更されるたびに実行される Action を設定します。
setPlatformDataSource(platformDataSource)SelectionInputGoogle Workspace からデータソースを設定します。
setTitle(title)SelectionInput入力フィールドの前に表示されるタイトルを設定します。
setType(type)SelectionInputこの入力の型を設定します。

SelectionInputType

プロパティ

プロパティタイプ説明
CHECK_BOXEnumチェックボックスの入力スタイル。
RADIO_BUTTONEnumラジオボタンの入力スタイル。
DROPDOWNEnumプルダウン メニューの選択の入力スタイル。
SWITCHEnumスイッチのセット。
MULTI_SELECTEnum

Status

プロパティ

プロパティタイプ説明
OKEnumHTTP マッピング: 200 OK
CANCELLEDEnumHTTP マッピング: 499 クライアントのクローズ リクエスト
UNKNOWNEnum不明なエラーです。
INVALID_ARGUMENTEnumクライアントが無効な引数を指定しました。
DEADLINE_EXCEEDEDEnumHTTP マッピング: 504 ゲートウェイ タイムアウト
NOT_FOUNDEnumHTTP マッピング: 404 見つかりません
ALREADY_EXISTSEnumクライアントが作成しようとしたエンティティはすでに存在します。
PERMISSION_DENIEDEnumHTTP マッピング: 403 禁止です
UNAUTHENTICATEDEnumHTTP マッピング: 401 権限なし
RESOURCE_EXHAUSTEDEnumHTTP マッピング: 429 リクエストが多すぎます
FAILED_PRECONDITIONEnumシステムがオペレーションの実行に必要な状態にないため、オペレーションが拒否されました。
ABORTEDEnumオペレーションは、一般にシーケンサー チェックの失敗やトランザクションの中止など、同時実行の問題が原因で中止されました。
OUT_OF_RANGEEnumオペレーションが有効な範囲を超えて試行されました。
UNIMPLEMENTEDEnumHTTP マッピング: 501 実装されていません
INTERNALEnum内部エラー。
UNAVAILABLEEnumHTTP マッピング: 503 サービスを利用できません
DATA_LOSSEnum回復不能なデータの消失や破損。

Suggestions

Methods

メソッド戻り値の型概要
addSuggestion(suggestion)Suggestionsテキストの候補を追加します。
addSuggestions(suggestions)Suggestionsテキスト候補のリストを追加します。

SuggestionsResponse

Methods

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

SuggestionsResponseBuilder

Methods

メソッド戻り値の型概要
build()SuggestionsResponse現在の提案レスポンスを作成して検証します。
setSuggestions(suggestions)SuggestionsResponseBuilderテキスト フィールドのオートコンプリートで使用される候補を設定します。

Switch

Methods

メソッド戻り値の型概要
setControlType(controlType)Switchスイッチのコントロール タイプを設定します。
setFieldName(fieldName)SwitchUI 操作が発生したときに生成されるイベント オブジェクトで、このスイッチを識別するキーを設定します。
setOnChangeAction(action)Switchスイッチが切り替わったときに行う操作を設定します。
setSelected(selected)Switchこのスイッチを選択状態で開始するか、選択解除して開始するかを設定します。
setValue(value)Switchこのスイッチがオンに切り替えられたときにフォーム入力として送信される値を設定します。

SwitchControlType

プロパティ

プロパティタイプ説明
SWITCHEnumスイッチ ウィジェットのスタイル付きコントロールの切り替え。
CHECK_BOXEnumスイッチ ウィジェットのチェックボックス スタイルのコントロール。

TextButton

Methods

メソッド戻り値の型概要
setAltText(altText)TextButtonユーザー補助機能向けにボタンの代替テキストを設定します。
setAuthorizationAction(action)TextButtonオブジェクトがクリックされたときに認可フローへの URL を開く承認アクションを設定します。
setBackgroundColor(backgroundColor)TextButtonTextButtonStyle.FILLED ボタンの背景色を設定します。
setComposeAction(action, composedEmailType)TextButtonオブジェクトがクリックされたときにメールの下書きを作成するアクションを設定します。
setDisabled(disabled)TextButtonボタンを無効にするかどうかを設定します。
setOnClickAction(action)TextButtonオブジェクトがクリックされたときに実行されるアクションを設定します。
setOnClickOpenLinkAction(action)TextButtonオブジェクトをクリックしたときにタブの URL を開くアクションを設定します。
setOpenLink(openLink)TextButtonオブジェクトがクリックされたときに開く URL を設定します。
setText(text)TextButtonボタンに表示されるテキストを設定します。
setTextButtonStyle(textButtonStyle)TextButtonボタンのスタイルを設定します。

TextButtonStyle

プロパティ

プロパティタイプ説明
OUTLINEDEnum背景がクリアな標準テキストボタン。
FILLEDEnum色付きの背景のテキストボタン。

TextInput

Methods

メソッド戻り値の型概要
setFieldName(fieldName)TextInputUI インタラクション時に生成されるイベント オブジェクト内の、このテキスト入力を識別するキーを設定します。
setHint(hint)TextInputテキスト入力のヒントを設定します。
setMultiline(multiline)TextInput入力テキストを 1 行に表示するか複数行で表示するかを設定します。
setOnChangeAction(action)TextInputテキスト入力が変更されたときに実行されるアクションを設定します。
setSuggestions(suggestions)TextInputテキスト フィールドにオートコンプリートの候補を設定します。
setSuggestionsAction(suggestionsAction)TextInputオートコンプリートのユーザー入力に基づいて候補を取得するコールバック アクションを設定します。
setTitle(title)TextInput入力フィールドの上に表示するタイトルを設定します。
setValue(value)TextInput入力フィールドに設定する事前入力された値を設定します。

TextParagraph

Methods

メソッド戻り値の型概要
setText(text)TextParagraph段落のテキストを設定します。

TimePicker

Methods

メソッド戻り値の型概要
setFieldName(fieldName)TimePickerUI インタラクション時に生成されるイベント オブジェクトで、この選択ツールを識別するフィールド名を設定します。
setHours(hours)TimePicker事前入力された営業時間の値を入力フィールドに設定します。
setMinutes(minutes)TimePicker事前入力された分単位の値を入力フィールドに設定します。
setOnChangeAction(action)TimePicker選択ツール入力が変更されるたびにスクリプトが実行する Action を設定します。
setTitle(title)TimePicker入力フィールドの上に表示されるタイトルを設定します。

UniversalActionResponse

Methods

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

UniversalActionResponseBuilder

Methods

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

UpdateDraftActionResponse

Methods

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

UpdateDraftActionResponseBuilder

Methods

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

UpdateDraftBccRecipientsAction

Methods

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

UpdateDraftBodyAction

Methods

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

UpdateDraftBodyType

プロパティ

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

UpdateDraftCcRecipientsAction

Methods

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

UpdateDraftSubjectAction

Methods

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

UpdateDraftToRecipientsAction

Methods

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

UpdatedWidget

Methods

メソッド戻り値の型概要
addItem(text, value, selected, startIconUri, bottomText)UpdatedWidget選択可能な新しい項目を追加します。

Widget