インデックス
Action
(メッセージ)Action.ActionParameter
(メッセージ)Action.Interaction
(列挙型)Action.LoadIndicator
(列挙型)BorderStyle
(メッセージ)BorderStyle.BorderType
(列挙型)Button
(メッセージ)Button.Type
(列挙型)ButtonList
(メッセージ)Card
(メッセージ)Card.CardAction
(メッセージ)Card.CardFixedFooter
(メッセージ)Card.CardHeader
(メッセージ)Card.DisplayStyle
(列挙型)Card.DividerStyle
(列挙型)Card.NestedWidget
(メッセージ)Card.Section
(メッセージ)Carousel
(メッセージ)Carousel.CarouselCard
(メッセージ)Chip
(メッセージ)ChipList
(メッセージ)ChipList.Layout
(列挙型)CollapseControl
(メッセージ)Columns
(メッセージ)Columns.Column
(メッセージ)Columns.Column.HorizontalSizeStyle
(列挙型)Columns.Column.VerticalAlignment
(列挙型)Columns.Column.Widgets
(メッセージ)DataActions
(メッセージ)DateTimePicker
(メッセージ)DateTimePicker.DateTimePickerType
(列挙型)DecoratedText
(メッセージ)DecoratedText.SwitchControl
(メッセージ)DecoratedText.SwitchControl.ControlType
(列挙型)Divider
(メッセージ)EndNavigation
(メッセージ)EndNavigation.Action
(列挙型)GetAutocompletionResponse
(メッセージ)Grid
(メッセージ)Grid.GridItem
(メッセージ)Grid.GridItem.GridItemLayout
(列挙型)Icon
(メッセージ)Image
(メッセージ)ImageComponent
(メッセージ)ImageCropStyle
(メッセージ)ImageCropStyle.ImageCropType
(列挙型)Link
(メッセージ)LinkPreview
(メッセージ)MaterialIcon
(メッセージ)ModifyCard
(メッセージ)ModifyCard.UpdateWidget
(メッセージ)ModifyCard.UpdateWidget.SelectionInputWidgetSuggestions
(メッセージ)Navigation
(メッセージ)Notification
(メッセージ)OnClick
(メッセージ)OpenLink
(メッセージ)OpenLink.OnClose
(列挙型)OpenLink.OpenAs
(列挙型)OverflowMenu
(メッセージ)OverflowMenu.OverflowMenuItem
(メッセージ)RenderActions
(メッセージ)RenderActions.Action
(メッセージ)SelectionInput
(メッセージ)SelectionInput.PlatformDataSource
(メッセージ)SelectionInput.PlatformDataSource.CommonDataSource
(列挙型)SelectionInput.SelectionItem
(メッセージ)SelectionInput.SelectionType
(列挙型)SubmitFormResponse
(メッセージ)Suggestions
(メッセージ)Suggestions.SuggestionItem
(メッセージ)TextInput
(メッセージ)TextInput.Type
(列挙型)TextParagraph
(メッセージ)Validation
(メッセージ)Validation.InputType
(列挙型)Widget
(メッセージ)Widget.HorizontalAlignment
(列挙型)Widget.ImageType
(列挙型)
アクション
フォームの送信時の動作を記述するアクション。たとえば、Apps Script スクリプトを呼び出してフォームを処理できます。アクションがトリガーされると、フォームの値がサーバーに送信されます。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
function |
親要素がクリックされたときやアクティブになったときに呼び出されるカスタム関数。 使用例については、フォームデータを読み取るをご覧ください。 |
parameters[] |
アクション パラメータのリスト。 |
load |
アクションを呼び出す際にアクションに表示される読み込みインジケーターを指定します。 |
persist |
アクション後にフォームの値を保持するかどうかを示します。デフォルト値は
|
interaction |
省略可。ダイアログを開く場合に必須です。 ユーザーの操作(カード メッセージ内のボタンのクリックなど)に応じて行う処理。 指定しない場合、アプリは通常どおり
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。 |
required |
省略可。このリストに、このアクションが有効な送信に必要とするウィジェットの名前を入力します。 このアクションが呼び出されたときに、ここにリストされているウィジェットに値がない場合、フォームの送信は中止されます。 Google Chat アプリと Google Workspace アドオンで利用できます。 |
all |
省略可。true の場合、すべてのウィジェットがこのアクションで必須と見なされます。 Google Chat アプリと Google Workspace アドオンで利用できます。 |
ActionParameter
アクション メソッドが呼び出されるときに指定する文字列パラメータのリスト。たとえば、3 つのスヌーズ ボタン(今すぐスヌーズ、1 日スヌーズ、来週スヌーズ)があるとします。action method = snooze()
を使用して、スヌーズ タイプとスヌーズ時間を文字列パラメータのリストで渡すことができます。
詳しくは、CommonEventObject
をご覧ください。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
key |
アクション スクリプトのパラメータの名前。 |
value |
パラメータ値。 |
インタラクション
省略可。ダイアログを開く場合に必須です。
ユーザーの操作(カード メッセージ内のボタンのクリックなど)に応じて行う処理。
指定しない場合、アプリは通常どおり action
(リンクを開く、関数を実行するなど)を実行して応答します。
interaction
を指定すると、アプリは特別なインタラクティブな方法で応答できます。たとえば、interaction
を OPEN_DIALOG
に設定すると、アプリはダイアログを開くことができます。
指定すると、読み込みインジケーターは表示されません。アドオンに指定した場合、カード全体が削除され、クライアントには何も表示されません。
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。
列挙型 | |
---|---|
INTERACTION_UNSPECIFIED |
デフォルト値。action は通常どおり実行されます。 |
OPEN_DIALOG |
ダイアログを開きます。これは、Chat アプリがユーザーとのやり取りに使用する、カードベースのウィンドウ インターフェースです。 カード メッセージのボタンクリックに対するレスポンスで、Chat アプリでのみサポートされます。アドオンに指定した場合、カード全体が削除され、クライアントには何も表示されません。 Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。 |
LoadIndicator
アクションを呼び出す際にアクションに表示される読み込みインジケーターを指定します。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
SPINNER |
コンテンツの読み込み中であることを示すスピナーを表示します。 |
NONE |
何も表示されません。 |
BorderStyle
カードやウィジェットの枠線のスタイル オプション(枠線の種類や色など)。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
type |
枠線の種類。 |
stroke |
タイプが ストロークの色を設定するには、 たとえば、次のコードは、最大強度で赤色に設定します。
|
corner |
枠線の角の半径。 |
BorderType
ウィジェットに適用される境界タイプを表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
BORDER_TYPE_UNSPECIFIED |
使用しないでください。(指定なし) |
NO_BORDER |
デフォルト値。枠線なし。 |
STROKE |
概要。 |
ボタン
ユーザーがクリックできるテキスト、アイコン、またはテキストとアイコンのボタン。Google Chat アプリの例については、ボタンを追加するをご覧ください。
画像をクリック可能なボタンにするには、
ではなく ImageComponent
を指定し、Image
onClick
アクションを設定します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
text |
ボタン内に表示されるテキスト。 |
icon |
ボタン内に表示されるアイコン。 |
color |
省略可。ボタンの色。設定されている場合、ボタン ボタンの色を設定するには、 たとえば、次のコードは、最大強度で赤色に設定します。
ボタンの色には |
on |
必須。ユーザーがボタンをクリックしたときに実行するアクション(ハイパーリンクを開く、カスタム関数を実行するなど)。 |
disabled |
|
alt |
ユーザー補助機能で使用される代替テキスト。 ボタンの動作をユーザーに示す説明的なテキストを設定します。たとえば、ボタンがハイパーリンクを開く場合は、「新しいブラウザタブを開き、Google Chat デベロッパー向けドキュメント(https://developers.google.com/workspace/chat")に移動します」と記述します。 |
type |
省略可。ボタンのタイプ。設定しない場合、ボタンのタイプはデフォルトで |
タイプ
省略可。ボタンのタイプ。color
フィールドが設定されている場合、type
は強制的に FILLED
になります。
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
使用しないでください。(指定なし) |
OUTLINED |
アウトライン ボタンは中強調ボタンです。通常、重要なアクションが含まれますが、Chat アプリやアドオンのメイン アクションではありません。 |
FILLED |
塗りつぶしボタンは、単色のコンテナで構成されます。視覚的なインパクトが最も大きく、Chat アプリやアドオンの重要なメイン アクションにおすすめです。 |
FILLED_TONAL |
塗りつぶしトーンボタンは、塗りつぶしボタンと枠線付きボタンの中間に位置する代替手段です。優先度の低いボタンに、アウトライン ボタンよりも少し強調を加えたい場合に便利です。 |
BORDERLESS |
ボタンのデフォルト状態には、不可視のコンテナがありません。多くの場合、優先度の最も低いアクションに使用されます(特に複数のオプションを提示する場合)。 |
ButtonList
横方向に配置されたボタンのリスト。Google Chat アプリの例については、ボタンを追加するをご覧ください。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
buttons[] |
ボタンの配列。 |
カード
Google Chat メッセージまたは Google Workspace アドオンに表示されるカード インターフェース。
カードは、定義済みのレイアウト、ボタンなどのインタラクティブな UI 要素、画像などのリッチメディアをサポートしています。カードを使用して詳細情報を表示したり、ユーザーから情報を収集したり、ユーザーを次のステップに誘導したりできます。
カードビルダーを使用してカードをデザインし、プレビューします。
カードビルダーを開くカードを作成する方法については、次のドキュメントをご覧ください。
- Google Chat アプリについては、カードまたはダイアログのコンポーネントを設計するをご覧ください。
- Google Workspace アドオンについては、カードベースのインターフェースをご覧ください。
注: カードごとに追加できるウィジェットは最大 100 個です。この上限を超えるウィジェットは無視されます。この上限は、Google Chat アプリのカード メッセージとダイアログの両方、および Google Workspace アドオンのカードに適用されます。
例: Google Chat アプリのカード メッセージ
Google Chat でサンプル カード メッセージを作成するには、次の JSON を使用します。
{
"cardsV2": [
{
"cardId": "unique-card-id",
"card": {
"header": {
"title": "Sasha",
"subtitle": "Software Engineer",
"imageUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
"imageType": "CIRCLE",
"imageAltText": "Avatar for Sasha"
},
"sections": [
{
"header": "Contact Info",
"collapsible": true,
"uncollapsibleWidgetsCount": 1,
"widgets": [
{
"decoratedText": {
"startIcon": {
"knownIcon": "EMAIL"
},
"text": "sasha@example.com"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PERSON"
},
"text": "<font color=\"#80e27e\">Online</font>"
}
},
{
"decoratedText": {
"startIcon": {
"knownIcon": "PHONE"
},
"text": "+1 (555) 555-1234"
}
},
{
"buttonList": {
"buttons": [
{
"text": "Share",
"onClick": {
"openLink": {
"url": "https://example.com/share"
}
}
},
{
"text": "Edit",
"onClick": {
"action": {
"function": "goToView",
"parameters": [
{
"key": "viewType",
"value": "EDIT"
}
]
}
}
}
]
}
}
]
}
]
}
}
]
}
フィールド | |
---|---|
header |
カードのヘッダー。ヘッダーには通常、先頭の画像とタイトルが含まれます。ヘッダーは常にカードの上部に表示されます。 |
sections[] |
ウィジェットのコレクションが含まれています。各セクションには、オプションでヘッダーを設定できます。セクションは線で区切られており、Google Chat アプリの例については、カードのセクションを定義するをご覧ください。 |
section |
ヘッダー、セクション、フッター間の区切り線のスタイル。 |
card |
カードのアクション。アクションはカードのツールバー メニューに追加されます。 Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 たとえば、次の JSON は、
|
name |
カードの名前。カード ナビゲーションのカード識別子として使用されます。 Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 |
fixed |
このカードの下部に表示される固定フッター。
Google Chat アプリと Google Workspace アドオンで利用できます。 |
display |
Google Workspace アドオンで、 Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 |
peek |
コンテキスト コンテンツを表示する場合、ピークカードのヘッダーはプレースホルダとして機能し、ユーザーがホームページ カードとコンテキスト カードを前後に移動できるようにします。 Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 |
CardAction
カードアクションは、カードに関連付けられたアクションです。たとえば、請求書カードには、請求書の削除、請求書のメール送信、請求書のブラウザでの開くなどのアクションが含まれます。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
フィールド | |
---|---|
action |
操作メニュー項目として表示されるラベル。 |
on |
このアクション アイテムの |
CardHeader
カードのヘッダーを表します。Google Chat アプリの例については、ヘッダーを追加するをご覧ください。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
title |
必須。カード ヘッダーのタイトル。ヘッダーの高さは固定です。タイトルとサブタイトルの両方を指定した場合、それぞれ 1 行を占有します。タイトルのみを指定した場合、タイトルは両方の行に表示されます。 |
subtitle |
カード ヘッダーのサブタイトル。指定すると、 |
image |
画像の切り抜きに使用するシェイプ。 Google Chat アプリと Google Workspace アドオンで利用できます。 |
image |
カード ヘッダーの画像の HTTPS URL。 |
image |
ユーザー補助機能で使用されるこの画像の代替テキスト。 |
DisplayStyle
Google Workspace アドオンでは、カードの表示方法を決定します。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
列挙型 | |
---|---|
DISPLAY_STYLE_UNSPECIFIED |
使用しないでください。(指定なし) |
PEEK |
カードのヘッダーはサイドバーの下部に表示され、グルーピングの現在の一番上のカードの一部を覆います。ヘッダーをクリックすると、カードがカード スタックにポップアップ表示されます。カードにヘッダーがない場合、生成されたヘッダーが代わりに使用されます。 |
REPLACE |
デフォルト値。カードは、カードのグルーピングの上部にあるカードのビューに置き換えて表示されます。 |
DividerStyle
カードの分割線のスタイル。現在は、カード セクション間の区切り線にのみ使用されています。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
DIVIDER_STYLE_UNSPECIFIED |
使用しないでください。(指定なし) |
SOLID_DIVIDER |
デフォルトのオプション。実線の区切りをレンダリングします。 |
NO_DIVIDER |
設定すると、分割線はレンダリングされません。このスタイルでは、分割線がレイアウトから完全に削除されます。結果は、区切り文字をまったく追加しない場合と同じです。 |
NestedWidget
CarouselCard
などのコンテナ レイアウトに表示できるウィジェットのリスト。 Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。
フィールド | |
---|---|
共用体フィールド
|
|
text |
テキスト段落ウィジェット。 |
button |
ボタンリスト ウィジェット。 |
image |
画像ウィジェット。 |
セクション
セクションには、指定された順序で垂直方向にレンダリングされるウィジェットのコレクションが含まれます。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
header |
セクションの上部に表示されるテキスト。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
widgets[] |
セクション内のすべてのウィジェット。少なくとも 1 つのウィジェットを含める必要があります。 |
collapsible |
このセクションを折りたたみ可能かどうかを示します。 折りたたみ可能なセクションでは、一部またはすべてのウィジェットが非表示になりますが、[もっと見る] をクリックすると、セクションを展開して非表示のウィジェットを表示できます。[表示を減らす] をクリックすると、ウィジェットを再度非表示にできます。 非表示にするウィジェットを指定するには、 |
uncollapsible |
セクションを閉じても表示されたままになる、閉じられないウィジェットの数。 たとえば、セクションに 5 つのウィジェットが含まれ、 |
collapse |
省略可。セクションの展開ボタンと折りたたみボタンを定義します。このボタンは、セクションを閉じることができる場合にのみ表示されます。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。 |
カルーセル
たとえば、次の JSON は、3 つのテキスト パラグラフ ウィジェットを含むカルーセルを表しています。
{
"carouselCards": [
{
"widgets": [
{
"textParagraph": {
"text": "First text paragraph in carousel",
}
}
]
},
{
"widgets": [
{
"textParagraph": {
"text": "Second text paragraph in carousel",
}
}
]
},
{
"widgets": [
{
"textParagraph": {
"text": "Third text paragraph in carousel",
}
}
]
}
]
}
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。
フィールド | |
---|---|
carousel |
カルーセルに含まれるカードのリスト。 |
CarouselCard
フィールド | |
---|---|
widgets[] |
カルーセル カードに表示されるウィジェットのリスト。ウィジェットは、指定された順序で表示されます。 |
footer |
カルーセル カードの下部に表示されるウィジェットのリスト。ウィジェットは、指定された順序で表示されます。 |
チップ
ユーザーがクリックできるテキスト、アイコン、テキストとアイコンのチップ。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
icon |
アイコン画像。 |
label |
チップ内に表示されるテキスト。 |
on |
省略可。ユーザーがチップをクリックしたときに実行するアクション(ハイパーリンクを開く、カスタム関数を実行するなど)。 |
enabled |
チップがアクティブな状態にあり、ユーザー操作に応答するかどうか。デフォルトは |
disabled |
チップが非アクティブな状態にあり、ユーザーの操作を無視するかどうか。デフォルトは |
alt |
ユーザー補助機能で使用される代替テキスト。 チップの機能についてユーザーに説明する説明テキストを設定します。たとえば、チップがハイパーリンクを開く場合は、「新しいブラウザタブを開き、Google Chat デベロッパー向けドキュメント(https://developers.google.com/workspace/chat")に移動します」と記述します。 |
ChipList
横方向に配置されたチップのリスト。横方向にスクロールするか、次の行に折り返すことができます。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
layout |
指定されたチップリスト レイアウト。 |
chips[] |
チップの配列。 |
レイアウト
チップリストのレイアウト。
列挙型 | |
---|---|
LAYOUT_UNSPECIFIED |
使用しないでください。(指定なし) |
WRAPPED |
デフォルト値。水平方向のスペースが十分でない場合、チップリストは次の行に折り返されます。 |
HORIZONTAL_SCROLLABLE |
チップが使用可能なスペースに収まらない場合は、水平方向にスクロールします。 |
CollapseControl
展開と閉じのコントロールを表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
horizontal |
展開ボタンと閉じるボタンの水平方向の配置。 |
expand |
省略可。セクションを開くカスタマイズ可能なボタンを定義します。expandButton フィールドと collapseButton フィールドの両方を設定する必要があります。フィールドセットが適用されないのは 1 つだけです。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。 |
collapse |
省略可。セクションを閉じるカスタマイズ可能なボタンを定義します。expandButton フィールドと collapseButton フィールドの両方を設定する必要があります。フィールドセットが適用されないのは 1 つだけです。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。 |
列
Columns
ウィジェットは、カードまたはダイアログに最大 2 つの列を表示します。各列にウィジェットを追加できます。ウィジェットは指定された順序で表示されます。Google Chat アプリの例については、カードとダイアログを列に表示するをご覧ください。
各列の高さは、高さの大きい列によって決まります。たとえば、最初の列が 2 番目の列よりも高い場合、両方の列のサイズは最初の列のサイズになります。各列に含めるウィジェットの数は異なるため、行を定義したり、列間でウィジェットを配置したりすることはできません。
列は並べて表示されます。各列の幅は HorizontalSizeStyle
フィールドを使用してカスタマイズできます。ユーザーの画面幅が狭すぎる場合、2 番目の列は 1 番目の列の下に折り返されます。
- ウェブでは、画面の幅が 480 ピクセル以下の場合、2 番目の列が折り返されます。
- iOS デバイスでは、画面幅が 300 pt 未満の場合、2 列目が折り返されます。
- Android デバイスでは、画面幅が 320 dp 以下の場合、2 列目が折り返されます。
2 つ以上の列を含める場合や行を使用する場合は、
ウィジェットを使用します。Grid
Google Chat アプリと Google Workspace アドオンで利用できます。列をサポートするアドオン UI には、次のようなものがあります。
- ユーザーがメールの下書きからアドオンを開いたときに表示されるダイアログ。
- Google カレンダーの予定の [添付ファイルを追加] メニューからアドオンを開いたときに表示されるダイアログ。
フィールド | |
---|---|
column |
列の配列。カードまたはダイアログには最大 2 つの列を含めることができます。 |
列
列。
フィールド | |
---|---|
horizontal |
列がカードの幅をどのように埋めるかを指定します。 |
horizontal |
ウィジェットを列の左、右、中央のいずれに配置するかを指定します。 |
vertical |
ウィジェットを列の上部、下部、中央のいずれに配置するかを指定します。 |
widgets[] |
列に含まれるウィジェットの配列。ウィジェットは、指定された順序で表示されます。 |
HorizontalSizeStyle
列がカードの幅をどのように埋めるかを指定します。各列の幅は、HorizontalSizeStyle
と列内のウィジェットの幅の両方に依存します。
列挙型 | |
---|---|
HORIZONTAL_SIZE_STYLE_UNSPECIFIED |
使用しないでください。(指定なし) |
FILL_AVAILABLE_SPACE |
デフォルト値。列は、カードの幅の 70% まで、利用可能なスペースを埋めます。両方の列が FILL_AVAILABLE_SPACE に設定されている場合、各列はスペースの 50% を占有します。 |
FILL_MINIMUM_SPACE |
列は、可能な限り最小限のスペースを占有し、カードの幅の 30% 以下に収まるようにします。 |
VerticalAlignment
ウィジェットを列の上部、下部、中央のいずれに配置するかを指定します。
列挙型 | |
---|---|
VERTICAL_ALIGNMENT_UNSPECIFIED |
使用しないでください。(指定なし) |
CENTER |
デフォルト値。ウィジェットを列の中央に揃えます。 |
TOP |
ウィジェットを列の上部に配置します。 |
BOTTOM |
ウィジェットを列の下部に配置します。 |
ウィジェット
列に含めることができる、サポートされているウィジェット。
フィールド | |
---|---|
共用体フィールド
|
|
text |
|
image |
|
decorated |
|
button |
|
text |
|
selection |
|
date |
|
chip |
|
DataActions
Google Workspace のデータを更新するアドオン アクション。
フィールド | |
---|---|
host |
Google Workspace データを更新する方法を定義します。 |
DateTimePicker
ユーザーが日付、時刻、または日付と時刻の両方を入力できるようにします。フォーム送信の検証をサポートします。Action.all_widgets_are_required
が true
に設定されている場合、またはこのウィジェットが Action.required_widgets
で指定されている場合、値が選択されていない限り、送信アクションはブロックされます。Google Chat アプリの例については、ユーザーに日時を選択させるをご覧ください。
ユーザーはテキストを入力するか、選択ツールを使用して日付と時刻を選択できます。無効な日付または時刻を入力すると、選択ツールにエラーが表示され、情報を正しく入力するよう求められます。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
name |
フォーム入力イベントで フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。 |
label |
日付、時刻、日時を入力するようユーザーに促すテキスト。たとえば、ユーザーが予約をスケジュールする場合は、 |
type |
ウィジェットが日付、時刻、日時を入力できるかどうか。 |
value |
ウィジェットに表示されるデフォルト値(Unix エポック時間からの経過時間(ミリ秒単位))。 選択ツールのタイプ(
|
timezone |
UTC からのタイムゾーン オフセットを分単位で表す数値。設定されている場合、 |
on |
ユーザーが |
DateTimePickerType
DateTimePicker
ウィジェットの日時形式。ユーザーが日付、時刻、または日付と時刻の両方を入力できるかどうかを指定します。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
DATE_AND_TIME |
ユーザーが日時を入力します。 |
DATE_ONLY |
ユーザーが日付を入力します。 |
TIME_ONLY |
ユーザーが時間を入力します。 |
DecoratedText
テキストの上にラベルを表示したり、テキストの前にアイコンを表示したり、テキストの後に選択ウィジェットを表示したり、ボタンを表示したりするなど、テキストを装飾して表示するウィジェット。Google Chat アプリの例については、装飾テキスト付きのテキストを表示するをご覧ください。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
icon |
|
start |
テキストの前に表示されるアイコン。 |
top |
|
text |
必須。メインのテキスト。 シンプルな書式設定をサポートしています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 |
wrap |
テキストの折り返し設定。
|
bottom |
|
on |
このアクションは、ユーザーが |
共用体フィールド control 。decoratedText ウィジェットのテキストの右側に表示されるボタン、スイッチ、チェックボックス、画像。control は次のいずれかになります。 |
|
button |
ユーザーがクリックしてアクションをトリガーできるボタン。 |
switch |
ユーザーがクリックして状態を変更し、アクションをトリガーできるスイッチ ウィジェット。 |
end |
テキストの後に表示されるアイコン。 |
SwitchControl
切り替えスタイルのスイッチまたは decoratedText
ウィジェット内のチェックボックス。
Google Chat アプリと Google Workspace アドオンで利用できます。
decoratedText
ウィジェットでのみサポートされます。
フィールド | |
---|---|
name |
フォーム入力イベントでスイッチ ウィジェットを識別する名前。 フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。 |
value |
ユーザーが入力した値。フォーム入力イベントの一部として返されます。 フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。 |
selected |
|
on |
スイッチの状態が変更されたときに実行するアクション(実行する関数など)。 |
control |
ユーザー インターフェースにスイッチが表示される仕組み。 Google Chat アプリと Google Workspace アドオンで利用できます。 |
ControlType
ユーザー インターフェースにスイッチが表示される仕組み。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
SWITCH |
切り替えスイッチ。 |
CHECKBOX |
CHECK_BOX に置き換えられました。 |
CHECK_BOX |
チェックボックス。 |
分割線
この型にはフィールドがありません。
ウィジェット間の区切り線を水平線として表示します。Google Chat アプリの例については、ウィジェットの間に水平方向の分割線を追加するをご覧ください。
Google Chat アプリと Google Workspace アドオンで利用できます。
たとえば、次の JSON は分割線を作成します。
"divider": {}
GetAutocompletionResponse
オートコンプリート コンテナの取得に対するレスポンス。テキスト フィールドのオートコンプリート アイテムの表示に必要な要素が含まれています。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。次に例を示します。
{
"autoComplete": {
"items": [
{
"text": "C++"
},
{
"text": "Java"
},
{
"text": "JavaScript"
},
{
"text": "Python"
}
]
}
}
フィールド | |
---|---|
auto |
|
schema |
これは、構文チェックのためにマークアップに存在する可能性のある、無効なスキーマ フィールドです。 |
グリッド
アイテムのコレクションを含むグリッドを表示します。アイテムにはテキストまたは画像のみを含めることができます。レスポンシブな列の場合や、テキストや画像以外を含める場合は、
を使用します。Google Chat アプリの例については、アイテムのコレクションを含むグリッドを表示するをご覧ください。Columns
グリッドは、任意の数の列とアイテムをサポートします。行数は、アイテム数を列数で割った値で決まります。アイテムが 10 個で列が 2 つのグリッドには、5 行あります。アイテムが 11 個で列が 2 つのグリッドには 6 行あります。
Google Chat アプリと Google Workspace アドオンで利用できます。
たとえば、次の JSON は、1 つのアイテムを含む 2 列のグリッドを作成します。
"grid": {
"title": "A fine collection of items",
"columnCount": 2,
"borderStyle": {
"type": "STROKE",
"cornerRadius": 4
},
"items": [
{
"image": {
"imageUri": "https://www.example.com/image.png",
"cropStyle": {
"type": "SQUARE"
},
"borderStyle": {
"type": "STROKE"
}
},
"title": "An item",
"textAlignment": "CENTER"
}
],
"onClick": {
"openLink": {
"url": "https://www.example.com"
}
}
}
フィールド | |
---|---|
title |
グリッドのヘッダーに表示されるテキスト。 |
items[] |
グリッドに表示するアイテム。 |
border |
各グリッドアイテムに適用する枠線スタイル。 |
column |
グリッドに表示する列の数。このフィールドが指定されていない場合はデフォルト値が使用されます。デフォルト値は、グリッドが表示される場所(ダイアログとコンパニオン)によって異なります。 |
on |
このコールバックは、個々のグリッドアイテムで再利用されますが、アイテムの ID とアイテムリスト内のインデックスがコールバックのパラメータに追加されます。 |
GridItem
グリッド レイアウト内のアイテムを表します。アイテムには、テキスト、画像、またはテキストと画像の両方を含めることができます。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
id |
このグリッドアイテムのユーザー指定の識別子。この ID は、親グリッドの |
image |
グリッドアイテムに表示される画像。 |
title |
グリッドアイテムのタイトル。 |
subtitle |
グリッド アイテムのサブタイトル。 |
layout |
グリッドアイテムに使用するレイアウト。 |
GridItemLayout
グリッド項目で使用できるさまざまなレイアウト オプションを表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
GRID_ITEM_LAYOUT_UNSPECIFIED |
使用しないでください。(指定なし) |
TEXT_BELOW |
タイトルとサブタイトルは、グリッド アイテムの画像の下に表示されます。 |
TEXT_ABOVE |
タイトルとサブタイトルは、グリッドアイテムの画像の上に表示されます。 |
アイコン
カードのウィジェットに表示されるアイコン。Google Chat アプリの例については、アイコンを追加するをご覧ください。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
alt |
省略可。ユーザー補助機能に使用されるアイコンの説明。指定しない場合、デフォルト値 アイコンが |
image |
画像に適用された切り抜きスタイル。 |
共用体フィールド icons 。カードのウィジェットに表示されるアイコン。icons は次のいずれかになります。 |
|
known |
Google Workspace が提供する組み込みアイコンのいずれかを表示します。 たとえば、飛行機のアイコンを表示するには、 サポートされているアイコンの一覧については、組み込みアイコンをご覧ください。 |
icon |
HTTPS URL でホストされているカスタム アイコンを表示します。 次に例を示します。
サポートされているファイル形式は |
material |
Google マテリアル アイコンのいずれかを表示します。 たとえば、チェックボックス アイコンを表示するには、
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。 |
画像
URL で指定され、onClick
アクションを設定できる画像。例については、画像を追加するをご覧ください。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
image |
画像をホストする HTTPS URL。 次に例を示します。
|
on |
ユーザーが画像をクリックすると、このアクションがトリガーされます。 |
alt |
ユーザー補助機能で使用されるこの画像の代替テキスト。 |
ImageComponent
画像を表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
image |
画像の URL。 |
alt |
画像のユーザー補助ラベル。 |
crop |
画像に適用する切り抜きスタイル。 |
border |
画像に適用するボーダー スタイル。 |
ImageCropStyle
画像に適用される切り抜きスタイルを表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
たとえば、16:9 のアスペクト比を適用する方法は次のとおりです。
cropStyle {
"type": "RECTANGLE_CUSTOM",
"aspectRatio": 16/9
}
フィールド | |
---|---|
type |
切り抜きタイプ。 |
aspect |
クロップタイプが たとえば、16:9 のアスペクト比を適用する方法は次のとおりです。
|
ImageCropType
画像に適用される切り抜きスタイルを表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
IMAGE_CROP_TYPE_UNSPECIFIED |
使用しないでください。(指定なし) |
SQUARE |
デフォルト値。正方形の切り抜きを適用します。 |
CIRCLE |
円形の切り抜きを適用します。 |
RECTANGLE_CUSTOM |
カスタム アスペクト比の長方形の切り抜きを適用します。aspectRatio を使用してカスタム アスペクト比を設定します。 |
RECTANGLE_4_3 |
アスペクト比 4:3 の長方形の切り抜きを適用します。 |
リンク
アドオンに返されるサードパーティ リソースのリンク オブジェクト。詳細については、@ メニューからサードパーティのリソースを作成するをご覧ください。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
フィールド | |
---|---|
url |
アドオンに戻るリンクの URL。 |
title |
アドオンに戻るリンクのタイトル。 |
LinkPreview
カードとスマートチップを表示してサードパーティのリンクをプレビューするカード アクション。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
たとえば、次の JSON は、リンク プレビューとそのスマートチップの一意のタイトルと、ヘッダーとテキストの説明を含むプレビュー カードを返します。
{
"action": {
"linkPreview": {
"title": "Smart chip title",
"linkPreviewTitle": "Link preview title",
"previewCard": {
"header": {
"title": "Preview card header",
},
"sections": [
{
"widgets": [
{
"textParagraph": {
"text": "Description of the link."
}
}
]
}
]
}
}
}
}
この例では、次のリンク プレビューが返されます。
フィールド | |
---|---|
preview |
サードパーティ サービスからのリンクに関する情報を表示するカード。 |
title |
リンク プレビューのスマートチップに表示されるタイトル。未設定の場合、スマートチップには |
link |
リンク プレビューに表示されるタイトル。設定しない場合、リンクのプレビューには |
MaterialIcon
Google マテリアル アイコン(2, 500 以上のオプションがあります)。
たとえば、重みとグレードをカスタマイズしたチェックボックス アイコンを表示するには、次のように記述します。
{
"name": "check_box",
"fill": true,
"weight": 300,
"grade": -25
}
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。
フィールド | |
---|---|
name |
Google マテリアル アイコンで定義されたアイコン名( |
fill |
アイコンを塗りつぶしてレンダリングするかどうか。デフォルト値は false です。 さまざまなアイコン設定をプレビューするには、Google フォント アイコンに移動し、[カスタマイズ] で設定を調整します。 |
weight |
アイコンのストロークの太さ。{100, 200, 300, 400, 500, 600, 700} から選択します。指定しない場合、デフォルト値は 400 です。他の値を指定した場合は、デフォルト値が使用されます。 さまざまなアイコン設定をプレビューするには、Google フォント アイコンに移動し、[カスタマイズ] で設定を調整します。 |
grade |
ウェイトとグレードは記号の太さに影響します。グレードの調整はウェイトの調整よりもきめ細かく、記号のサイズへの影響は小さくなります。{-25、0、200} から選択します。指定しない場合、デフォルト値は 0 です。他の値を指定した場合は、デフォルト値が使用されます。 さまざまなアイコン設定をプレビューするには、Google フォント アイコンに移動し、[カスタマイズ] で設定を調整します。 |
ModifyCard
Google Chat のアドオンの場合、ユーザー操作に基づいてカードを更新します。配列に含めることができるオブジェクトは 1 つだけです。
フィールド | |
---|---|
共用体フィールド
|
|
update |
Google Chat のアドオンの場合、カードまたはダイアログ内のウィジェットを更新します。 |
UpdateWidget
Google Chat のアドオンの場合、カードまたはダイアログ内のウィジェットを更新します。
フィールド | |
---|---|
共用体フィールド updated_widget 。ウィジェットの更新。updated_widget は次のいずれかになります。 |
|
selection |
|
SelectionInputWidgetSuggestions
複数選択メニューを使用する selectionInput
ウィジェットの場合、外部動的データソースからの選択アイテムを返します。
フィールド | |
---|---|
suggestions[] |
ユーザーが複数選択メニューに入力した後に表示される、選択可能なアイテムの配列。 |
通知
ユーザーがカードを操作したときに、ホスト Google Workspace アプリに通知を表示するアクション。
デベロッパー プレビュー: Google Chat のアドオンで、ユーザーがダイアログを送信して閉じると通知が表示されます。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
フィールド | |
---|---|
text |
通知に表示するプレーン テキスト(HTML タグなし)。 |
OnClick
ユーザーがカード上のインタラクティブな要素(ボタンなど)をクリックしたときにどのように応答するかを表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
共用体フィールド
|
|
action |
指定すると、この |
open |
指定すると、この |
open |
アドオンは、リンクを開く必要がある場合にこのアクションをトリガーします。これは、リンクを取得するためにサーバーと通信する必要があるという点で、上記の Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 |
card |
指定されている場合は、クリック後に新しいカードがカードスタックにプッシュされます。 Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 |
overflow |
指定すると、この |
OpenLink
ハイパーリンクを開く onClick
イベントを表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
url |
開く URL。 |
open |
リンクを開く方法。 Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 |
on |
クライアントがリンクを開いた後にリンクを忘れるか、ウィンドウが閉じられるまでリンクを保持するか。 Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 |
OnClose
OnClick
アクションで開いたリンクが閉じられたときのクライアントの動作。
実装はクライアント プラットフォームの機能によって異なります。たとえば、ウェブブラウザが OnClose
ハンドラを使用してポップアップ ウィンドウでリンクを開く場合があります。
OnOpen
ハンドラと OnClose
ハンドラの両方が設定されていて、クライアント プラットフォームが両方の値をサポートできない場合、OnClose
が優先されます。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
列挙型 | |
---|---|
NOTHING |
デフォルト値。カードが再読み込みされず、何も起こらない。 |
RELOAD |
子ウィンドウが閉じた後にカードを再読み込みします。
|
OpenAs
OnClick
アクションでリンクを開くと、クライアントはリンクをフルサイズのウィンドウ(クライアントが使用するフレームの場合)またはオーバーレイ(ポップアップなど)として開くことができます。実装はクライアント プラットフォームの機能に依存し、クライアントがサポートしていない場合、選択した値は無視されることがあります。FULL_SIZE
はすべてのクライアントでサポートされています。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
列挙型 | |
---|---|
FULL_SIZE |
リンクがフルサイズのウィンドウとして開きます(クライアントが使用するフレームがフルサイズの場合)。 |
OVERLAY |
リンクがポップアップなどのオーバーレイとして開きます。 |
OverflowMenu
ユーザーが呼び出せる 1 つ以上のアクションを含むポップアップ メニューを表示するウィジェット。たとえば、カードにメイン以外のアクションを表示するなどです。このウィジェットは、アクションが使用可能なスペースに収まらない場合に使用できます。使用するには、このウィジェットをサポートするウィジェットの OnClick
アクションで指定します。たとえば、Button
に以下の行を挿入します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
items[] |
必須。メニュー オプションのリスト。 |
OverflowMenuItem
ユーザーがオーバーフロー メニューで呼び出せるオプション。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
start |
テキストの前に表示されるアイコン。 |
text |
必須。アイテムを識別または説明するテキスト。 |
on |
必須。メニュー オプションが選択されたときに呼び出されるアクション。この |
disabled |
メニュー オプションが無効かどうか。デフォルトは false です。 |
RenderActions
カードまたはホスト アプリケーションでアクションを実行するようアドオンに指示するレンダリング インストラクションのセット。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
フィールド | |
---|---|
action |
アドオンが UI の更新に使用できるアクション。 デベロッパー プレビュー: Google Chat のアドオン。 |
host |
個々のホストアプリによって処理されるアクション。 |
schema |
これは、構文チェックのためにマークアップに存在する可能性のある、無効なスキーマ フィールドです。 |
アクション
アドオンがカードまたはホスト アプリケーションで使用できるアクション。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。
フィールド | |
---|---|
navigations[] |
カードをプッシュ、ポップ、更新します。 デベロッパー プレビュー: Google Chat のアドオン。 |
link |
ターゲット リンクを新しいタブまたはポップアップ ウィンドウで開きます。 |
notification |
ユーザーがカードを操作すると、ホスト Google Workspace アプリケーションに通知が表示されます。 デベロッパー プレビュー: Google Chat のアドオンで、ユーザーがダイアログを送信して閉じると通知が表示されます。 |
link |
Google ドキュメント、Google スプレッドシート、Google スライドで利用できます。スマートチップとカードを使用してリンクをプレビューします。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。 |
links[] |
Google ドキュメントで利用できます。サードパーティ リソースからリンクを返して、ホスト アプリケーションのスマートチップに変換します。1 つのアイテムを含むオブジェクトの配列としてフォーマットされます。 詳細については、@ メニューからサードパーティのリソースを作成するをご覧ください。 |
modify |
Google Chat のアドオンの場合、ユーザー操作に基づいてカードを更新します。配列に含めることができるオブジェクトは 1 つだけです。 |
SelectionInput
ユーザーが選択できる 1 つ以上の UI アイテムを作成するウィジェット。dropdown
メニューと multiselect
メニューのフォーム送信の検証のみをサポートします。Action.all_widgets_are_required
が true
に設定されている場合、またはこのウィジェットが Action.required_widgets
で指定されている場合、値が選択されていない限り、送信アクションはブロックされます。たとえば、プルダウン メニューやチェックボックスなどです。このウィジェットを使用すると、予測または列挙可能なデータを収集できます。Google Chat アプリの例については、選択可能な UI 要素を追加するをご覧ください。
Chat アプリは、ユーザーが選択または入力したアイテムの値を処理できます。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
未定義または抽象的なデータをユーザーから収集するには、TextInput
ウィジェットを使用します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
name |
必須。フォーム入力イベント内の選択入力を識別する名前。 フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。 |
label |
ユーザー インターフェースの選択入力フィールドの上に表示されるテキスト。 アプリに必要な情報をユーザーが入力できるように、テキストを指定します。たとえば、ユーザーがプルダウン メニューから作業チケットの緊急度を選択する場合、ラベルは「緊急度」または「緊急度を選択」になります。 |
type |
|
items[] |
選択可能なアイテムの配列。たとえば、ラジオボタンやチェックボックスの配列などです。最大 100 個のアイテムをサポートします。 |
on |
指定すると、選択内容が変更されたときにフォームが送信されます。指定しない場合は、フォームを送信する別のボタンを指定する必要があります。 フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。 |
multi |
複数選択メニューの場合、ユーザーが選択できる項目の最大数。最小値は 1 個です。指定しない場合、デフォルトは 3 個のアイテムになります。 |
multi |
複数選択メニューの場合、メニューが候補の選択項目を返す前にユーザーが入力するテキスト文字数。 設定されていない場合、マルチ選択メニューは次のデフォルト値を使用します。
|
共用体フィールド Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。 |
|
external |
リレーショナル データベースなどの外部データソース。 |
platform |
Google Workspace のデータソース。 |
PlatformDataSource
複数選択メニューを使用する
ウィジェットの場合は、Google Workspace のデータソース。複数選択メニューの項目に入力する場合に使用します。SelectionInput
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。
フィールド | |
---|---|
共用体フィールド data_source 。データソース。data_source は次のいずれかになります。 |
|
common |
Google Workspace 組織内のユーザーなど、すべての Google Workspace アプリケーションで共有されるデータソース。 |
host |
Google Workspace ホスト アプリケーションに固有のデータソース(Google Chat のスペースなど)。 このフィールドは Google API クライアント ライブラリをサポートしていますが、Cloud クライアント ライブラリでは使用できません。詳細については、クライアント ライブラリをインストールするをご覧ください。 |
CommonDataSource
すべての Google Workspace アプリケーションで共有されるデータソース。
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。
列挙型 | |
---|---|
UNKNOWN |
デフォルト値。使用しないでください。 |
USER |
Google Workspace ユーザー。ユーザーは、Google Workspace 組織内のユーザーのみを表示および選択できます。 |
SelectionItem
チェックボックスやスイッチなど、ユーザーが選択入力で選択できるアイテム。最大 100 個のアイテムをサポートします。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
text |
アイテムを識別または説明するテキスト。 |
value |
この項目に関連付けられた値。クライアントは、これをフォームの入力値として使用する必要があります。 フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。 |
selected |
アイテムがデフォルトで選択されるかどうか。選択入力で 1 つの値のみが許可される場合(ラジオボタンやプルダウン メニューなど)、このフィールドは 1 つの項目にのみ設定します。 |
start |
複数選択メニューの場合、アイテムの |
bottom |
複数選択メニューの場合、アイテムの |
SelectionType
ユーザーが選択できる項目の形式。オプションによって、サポートされるインタラクションの種類が異なります。たとえば、ユーザーは複数のチェックボックスを選択できますが、プルダウン メニューから選択できるのは 1 つの項目のみです。
各選択入力は 1 種類の選択をサポートします。たとえば、チェックボックスとスイッチを組み合わせることはできません。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
CHECK_BOX |
チェックボックスのセット。ユーザーはチェックボックスを 1 つ以上選択できます。 |
RADIO_BUTTON |
ラジオボタンのセット。ユーザーはラジオボタンを 1 つ選択できます。 |
SWITCH |
スイッチのセット。ユーザーは 1 つ以上のスイッチをオンにできます。 |
DROPDOWN |
プルダウン メニュー。ユーザーはメニューから 1 つの項目を選択できます。 |
MULTI_SELECT |
テキスト ボックスを含むメニュー。ユーザーは 1 つ以上のアイテムを入力して選択できます。Google Workspace アドオンの場合は、 Google Chat アプリの場合は、動的データソースを使用してアイテムを入力し、ユーザーがメニューに入力するときにアイテムを自動的に候補として表示することもできます。たとえば、ユーザーが Google Chat スペースの名前を入力すると、ウィジェットにスペースが自動的に候補として表示されます。複数選択メニューのアイテムを動的に入力するには、次のいずれかのデータソースを使用します。
Chat アプリに複数選択メニューを実装する方法の例については、複数選択メニューを追加するをご覧ください。 Google Chat アプリと Google Workspace アドオンで利用できます。 |
SubmitFormResponse
フォーム送信に対するレスポンス(自動入力コンテナの取得以外)。カードまたはアドオン ホストアプリが実行する必要があるアクションと、カードの状態が変更されたかどうかが含まれます。
Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。次に例を示します。
{
"renderActions": {
"action": {
"notification": {
"text": "Email address is added: salam.heba@example.com"
}
},
"hostAppAction": {
"gmailAction": {
"openCreatedDraftAction": {
"draftId": "msg-a:r-79766936926021702",
"threadServerPermId": "thread-f:15700999851086004"
}
}
}
}
}
フィールド | |
---|---|
render |
カードにアクションを実行するよう指示したり、アドオン ホストアプリにアプリ固有のアクションを実行するよう指示したりする一連のレンダリング インストラクション。 |
state |
カードの状態が変更され、既存のカードのデータが古くなっているか。 |
schema |
これは、構文チェックのためにマークアップに存在する可能性のある、無効なスキーマ フィールドです。 |
候補
ユーザーが入力できる候補値。これらの値は、ユーザーがテキスト入力フィールド内をクリックしたときに表示されます。ユーザーが入力すると、入力内容に合わせて候補値が動的にフィルタされます。
たとえば、プログラミング言語のテキスト入力フィールドでは、Java、JavaScript、Python、C++ が候補として表示されます。ユーザーが Jav
と入力し始めると、候補リストがフィルタされ、Java
と JavaScript
が表示されます。
候補値は、アプリが理解できる値をユーザーが入力できるようにするためのものです。JavaScript を参照する場合、javascript
と入力するユーザーもいれば、java script
と入力するユーザーもいます。JavaScript
を提案することで、ユーザーがアプリを操作する方法を標準化できます。
指定した場合、TextInput.type
は MULTIPLE_LINE
に設定されている場合でも常に SINGLE_LINE
になります。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
items[] |
テキスト入力フィールドのオートコンプリート候補に使用される候補のリスト。 |
SuggestionItem
ユーザーがテキスト入力フィールドに入力できる候補値の 1 つ。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
共用体フィールド
|
|
text |
テキスト入力フィールドへの候補入力の値。これは、ユーザーが自分で入力するのと同じです。 |
TextInput
ユーザーがテキストを入力できるフィールド。候補と変更時のアクションをサポートします。フォーム送信の検証をサポートします。Action.all_widgets_are_required
が true
に設定されている場合、またはこのウィジェットが Action.required_widgets
で指定されている場合、値が入力されない限り、送信アクションはブロックされます。Google Chat アプリの例については、ユーザーがテキストを入力できるフィールドを追加するをご覧ください。
Chat アプリは、フォーム入力イベント中に入力されたテキストの値を受信して処理できます。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
ユーザーから未定義または抽象的なデータを収集する必要がある場合は、テキスト入力を使用します。定義済みまたは列挙型のデータをユーザーから収集するには、SelectionInput
ウィジェットを使用します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
name |
フォーム入力イベントでテキスト入力を識別する名前。 フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。 |
label |
ユーザー インターフェースのテキスト入力フィールドの上に表示されるテキスト。 アプリに必要な情報をユーザーが入力できるように、テキストを指定します。たとえば、名前を尋ねる際に姓のみが必要であれば、
|
hint |
テキスト入力フィールドの下に表示されるテキスト。特定の値を入力するようユーザーに促す目的で使用されます。このテキストは常に表示されます。
|
value |
ユーザーが入力した値。フォーム入力イベントの一部として返されます。 フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。 |
type |
テキスト入力フィールドがユーザー インターフェースにどのように表示されるか。たとえば、フィールドが単一行か複数行かなどです。 |
on |
テキスト入力フィールドで変更が発生した場合の対応方法。たとえば、ユーザーがフィールドに追加したり、テキストを削除したりした場合です。 実行するアクションの例としては、カスタム関数の実行や、Google Chat でダイアログを開くなどがあります。 |
initial |
ユーザーが入力できる候補値。これらの値は、ユーザーがテキスト入力フィールド内をクリックしたときに表示されます。ユーザーが入力すると、入力内容に合わせて候補値が動的にフィルタされます。 たとえば、プログラミング言語のテキスト入力フィールドでは、Java、JavaScript、Python、C++ が候補として表示されます。ユーザーが 候補値は、アプリが理解できる値をユーザーが入力できるようにするためのものです。JavaScript を参照する場合、 指定した場合、 Google Chat アプリと Google Workspace アドオンで利用できます。 |
auto |
省略可。テキスト入力フィールドでユーザーが操作したときに候補が表示された場合に実行するアクションを指定します。 指定しない場合、候補は 指定すると、アプリはここで指定されたアクション(カスタム関数の実行など)を実行します。 Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。 |
validation |
このテキスト フィールドに必要な入力形式の検証を指定します。 Google Chat アプリと Google Workspace アドオンで利用できます。 |
placeholder |
テキスト入力フィールドが空のときに表示されるテキスト。このテキストは、値を入力するようユーザーに求めるメッセージとして使用します。たとえば、 Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。 |
タイプ
テキスト入力フィールドがユーザー インターフェースにどのように表示されるか。たとえば、1 行入力フィールドか複数行入力かなどです。initialSuggestions
が指定されている場合、type
は MULTIPLE_LINE
に設定されている場合でも常に SINGLE_LINE
です。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
SINGLE_LINE |
テキスト入力フィールドの高さは 1 行に固定されています。 |
MULTIPLE_LINE |
テキスト入力フィールドの高さは複数行の固定値です。 |
TextParagraph
書式設定をサポートする 1 つの段落のテキスト。Google Chat アプリの例については、書式設定されたテキストの段落を追加するをご覧ください。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
text |
ウィジェットに表示するテキスト。 |
max |
ウィジェットに表示されるテキストの最大行数。テキストが指定された最大行数を超えると、超過分は [もっと見る] ボタンの背後に隠されます。テキストが指定された最大行数以下の場合、[もっと見る] ボタンは表示されません。 デフォルト値は 0 です。この場合、すべてのコンテキストが表示されます。負の値は無視されます。 |
検証
アタッチされているウィジェットの検証に必要なデータを表します。
Google Chat アプリと Google Workspace アドオンで利用できます。
フィールド | |
---|---|
character |
テキスト入力ウィジェットの文字数制限を指定します。これはテキスト入力にのみ使用され、他のウィジェットでは無視されます。 Google Chat アプリと Google Workspace アドオンで利用できます。 |
input |
入力ウィジェットのタイプを指定します。 Google Chat アプリと Google Workspace アドオンで利用できます。 |
InputType
入力ウィジェットのタイプ。
列挙型 | |
---|---|
INPUT_TYPE_UNSPECIFIED |
タイプの指定なし。使用しないでください。 |
TEXT |
すべての文字を使用できる通常のテキスト。 |
INTEGER |
整数値。 |
FLOAT |
浮動小数点値。 |
EMAIL |
メールアドレス。 |
EMOJI_PICKER |
システム提供の絵文字選択ツールから選択した絵文字。 |
ウィジェット
各カードはウィジェットで構成されています。
ウィジェットは、テキスト、画像、ボタンなどのオブジェクト タイプを 1 つ表すことができる複合オブジェクトです。
フィールド | |
---|---|
horizontal |
ウィジェットを列の左、右、中央のいずれに配置するかを指定します。 |
共用体フィールド data 。ウィジェットに設定できるアイテムは、次のいずれか 1 つだけです。複数のウィジェット フィールドを使用して、より多くのアイテムを表示できます。data は次のいずれかになります。 |
|
text |
テキスト パラグラフを表示します。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。 たとえば、次の JSON では太字のテキストが作成されます。
|
image |
画像を表示します。 たとえば、次の JSON は代替テキストを含む画像を作成します。
|
decorated |
装飾されたテキスト項目を表示します。 たとえば、次の JSON は、メールアドレスを表示する装飾付きテキスト ウィジェットを作成します。
|
button |
ボタンのリスト。 たとえば、次の JSON は 2 つのボタンを作成します。1 つ目は青いテキスト ボタンで、2 つ目はリンクを開く画像ボタンです。
|
text |
ユーザーが入力できるテキスト ボックスを表示します。 たとえば、次の JSON はメールアドレスのテキスト入力を作成します。
別の例として、次の JSON は、静的な候補を含むプログラミング言語のテキスト入力を作成します。
|
selection |
ユーザーがアイテムを選択できる選択コントロールを表示します。選択コントロールには、チェックボックス、ラジオボタン、スイッチ、プルダウン メニューがあります。 たとえば、次の JSON は、ユーザーがサイズを選択できるプルダウン メニューを作成します。
|
date |
ユーザーが日付、時刻、または日時を入力できるウィジェットを表示します。 たとえば、次の JSON は、予約のスケジュールを設定する日時選択ツールを作成します。
|
divider |
ウィジェットの間に水平線の分割線を表示します。 たとえば、次の JSON は分割線を作成します。
|
grid |
アイテムのコレクションを含むグリッドを表示します。 グリッドは、任意の数の列とアイテムをサポートします。行数は、アイテム数の上限を列数で割った値によって決まります。アイテムが 10 個で列が 2 つのグリッドには、5 行あります。アイテムが 11 個で列が 2 つのグリッドには 6 行あります。 Google Chat アプリと Google Workspace アドオンで利用できます。 たとえば、次の JSON は、1 つのアイテムを含む 2 列のグリッドを作成します。
|
columns |
最大 2 列を表示します。 2 つを超える列を含める場合や行を使用する場合は、 たとえば、次の JSON では、それぞれにテキスト パラグラフを含む 2 つの列が作成されます。
|
carousel |
カルーセルには、ネストされたウィジェットのコレクションが含まれています。たとえば、次の JSON は、2 つのテキスト パラグラフを含むカルーセルを表しています。
|
chip |
チップのリスト。 たとえば、次の JSON では 2 つのチップが作成されます。1 つ目はテキスト チップで、2 つ目はリンクを開くアイコン チップです。
|
HorizontalAlignment
ウィジェットを列の左、右、中央のいずれに配置するかを指定します。
Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。
列挙型 | |
---|---|
HORIZONTAL_ALIGNMENT_UNSPECIFIED |
使用しないでください。(指定なし) |
START |
デフォルト値。ウィジェットを列の先頭の位置に配置します。左から右のレイアウトの場合は左に揃えます。右から左のレイアウトの場合は、右揃えになります。 |
CENTER |
ウィジェットを列の中央に配置します。 |
END |
ウィジェットを列の末尾の位置に配置します。左から右のレイアウトでは、ウィジェットを右揃えにします。右から左のレイアウトの場合、ウィジェットを左側に配置します。 |
ImageType
画像の切り抜きに使用するシェイプ。
Google Chat アプリと Google Workspace アドオンで利用できます。
列挙型 | |
---|---|
SQUARE |
デフォルト値。画像に正方形のマスクを適用します。たとえば、4x3 の画像は 3x3 になります。 |
CIRCLE |
画像に円形のマスクを適用します。たとえば、4x3 の画像は直径 3 の円になります。 |