Package google.apps.card.v1

string

親要素がクリックされたときやアクティブになったときに呼び出されるカスタム関数。

使用例については、フォームデータを読み取るをご覧ください。

ActionParameter

アクション パラメータのリスト。

LoadIndicator

アクションを呼び出す際にアクションに表示される読み込みインジケーターを指定します。

bool

アクション後にフォームの値を保持するかどうかを示します。デフォルト値は false です。

true の場合、アクションがトリガーされた後もフォームの値は保持されます。アクションの処理中にユーザーが変更できるようにするには、LoadIndicator を NONE に設定します。Chat アプリのカード メッセージの場合、アクションの ResponseType を UPDATE_MESSAGE に設定し、アクションを含むカードと同じ card_id を使用する必要があります。

false の場合、アクションがトリガーされるとフォームの値が消去されます。アクションの処理中にユーザーが変更できないようにするには、LoadIndicator を SPINNER に設定します。

Interaction

省略可。ダイアログを開く場合に必須です。

ユーザーの操作（カード メッセージ内のボタンのクリックなど）に応じて行う処理。

指定しない場合、アプリは通常どおり action（リンクを開く、関数を実行するなど）を実行して応答します。

interaction を指定すると、アプリは特別なインタラクティブな方法で応答できます。たとえば、interaction を OPEN_DIALOG に設定すると、アプリはダイアログを開くことができます。指定すると、読み込みインジケーターは表示されません。アドオンに指定した場合、カード全体が削除され、クライアントには何も表示されません。

Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

string

このアクションが呼び出されたときに、ここにリストされているウィジェットに値がない場合、フォームの送信は中止されます。

Google Chat アプリと Google Workspace アドオンで利用できます。

bool

Google Chat アプリと Google Workspace アドオンで利用できます。

string

アクション スクリプトのパラメータの名前。

string

パラメータ値。

BorderType

枠線の種類。

Color

タイプが BORDER_TYPE_STROKE の場合に使用する色。

ストロークの色を設定するには、red、green、blue フィールドに値を指定します。値は、RGB 色値に基づく 0 ～ 1 の浮動小数点数にする必要があります。0（0/255）は色なしを表し、1（255/255）は色の最大彩度を表します。

たとえば、次のコードは、最大強度で赤色に設定します。

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

alpha フィールドはストロークの色には使用できません。指定した場合、このフィールドは無視されます。

int32

枠線の角の半径。

string

ボタン内に表示されるテキスト。

Icon

ボタン内に表示されるアイコン。icon と text の両方を設定すると、テキストの前にアイコンが表示されます。

Color

省略可。ボタンの色。設定されている場合、ボタン type は FILLED に設定され、text フィールドと icon フィールドの色は、読みやすくするためにコントラストの効いた色に設定されます。たとえば、ボタンの色が青に設定されている場合、ボタン内のテキストやアイコンは白に設定されます。

ボタンの色を設定するには、red、green、blue の各フィールドに値を指定します。値は、RGB 色値に基づく 0 ～ 1 の浮動小数点数にする必要があります。0（0/255）は色なしを表し、1（255/255）は色の最大彩度を表します。

たとえば、次のコードは、最大強度で赤色に設定します。

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

ボタンの色には alpha フィールドを使用できません。指定した場合、このフィールドは無視されます。

OnClick

必須。ユーザーがボタンをクリックしたときに実行するアクション（ハイパーリンクを開く、カスタム関数を実行するなど）。

bool

true の場合、ボタンは非アクティブな状態で表示され、ユーザー操作に反応しません。

string

ユーザー補助機能で使用される代替テキスト。

ボタンの動作をユーザーに示す説明的なテキストを設定します。たとえば、ボタンがハイパーリンクを開く場合は、「新しいブラウザタブを開き、Google Chat デベロッパー向けドキュメント（https://developers.google.com/workspace/chat"）に移動します」と記述します。

Type

省略可。ボタンのタイプ。設定しない場合、ボタンのタイプはデフォルトで OUTLINED になります。color フィールドが設定されている場合、ボタンのタイプは FILLED に強制され、このフィールドに設定された値は無視されます。

Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

Button

ボタンの配列。

CardHeader

カードのヘッダー。ヘッダーには通常、先頭の画像とタイトルが含まれます。ヘッダーは常にカードの上部に表示されます。

Section

ウィジェットのコレクションが含まれています。各セクションには、オプションでヘッダーを設定できます。セクションは線で区切られており、Google Chat アプリの例については、カードのセクションを定義するをご覧ください。

DividerStyle

ヘッダー、セクション、フッター間の区切り線のスタイル。

CardAction

カードのアクション。アクションはカードのツールバー メニューに追加されます。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

たとえば、次の JSON は、Settings オプションと Send Feedback オプションを使用してカード アクション メニューを作成します。

"card_actions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

カードの名前。カード ナビゲーションのカード識別子として使用されます。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

CardFixedFooter

このカードの下部に表示される固定フッター。

primaryButton または secondaryButton を指定せずに fixedFooter を設定すると、エラーが発生します。Chat アプリでは、ダイアログで固定フッターを使用できますが、カード メッセージでは使用できません。

Google Chat アプリと Google Workspace アドオンで利用できます。

DisplayStyle

Google Workspace アドオンで、peekCardHeader の表示プロパティを設定します。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

CardHeader

コンテキスト コンテンツを表示する場合、ピークカードのヘッダーはプレースホルダとして機能し、ユーザーがホームページ カードとコンテキスト カードを前後に移動できるようにします。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

string

操作メニュー項目として表示されるラベル。

OnClick

このアクション アイテムの onClick アクション。

Button

固定フッターのメインボタン。ボタンは、テキストと色が設定されたテキストボタンである必要があります。

Button

固定フッターのセカンダリ ボタン。ボタンは、テキストと色が設定されたテキストボタンである必要があります。secondaryButton を設定する場合は、primaryButton も設定する必要があります。

string

必須。カード ヘッダーのタイトル。ヘッダーの高さは固定です。タイトルとサブタイトルの両方を指定した場合、それぞれ 1 行を占有します。タイトルのみを指定した場合、タイトルは両方の行に表示されます。

string

カード ヘッダーのサブタイトル。指定すると、title の下に独自の行に表示されます。

ImageType

画像の切り抜きに使用するシェイプ。

Google Chat アプリと Google Workspace アドオンで利用できます。

string

カード ヘッダーの画像の HTTPS URL。

string

ユーザー補助機能で使用されるこの画像の代替テキスト。

TextParagraph

テキスト段落ウィジェット。

ButtonList

ボタンリスト ウィジェット。

Image

画像ウィジェット。

string

セクションの上部に表示されるテキスト。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。

Widget

セクション内のすべてのウィジェット。少なくとも 1 つのウィジェットを含める必要があります。

bool

このセクションを折りたたみ可能かどうかを示します。

折りたたみ可能なセクションでは、一部またはすべてのウィジェットが非表示になりますが、[もっと見る] をクリックすると、セクションを展開して非表示のウィジェットを表示できます。[表示を減らす] をクリックすると、ウィジェットを再度非表示にできます。

非表示にするウィジェットを指定するには、uncollapsibleWidgetsCount を指定します。

int32

セクションを閉じても表示されたままになる、閉じられないウィジェットの数。

たとえば、セクションに 5 つのウィジェットが含まれ、uncollapsibleWidgetsCount が 2 に設定されている場合、最初の 2 つのウィジェットは常に表示され、最後の 3 つはデフォルトで閉じられます。uncollapsibleWidgetsCount は、collapsible が true の場合にのみ考慮されます。

CollapseControl

省略可。セクションの展開ボタンと折りたたみボタンを定義します。このボタンは、セクションを閉じることができる場合にのみ表示されます。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。 Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

CarouselCard

カルーセルに含まれるカードのリスト。

NestedWidget

カルーセル カードに表示されるウィジェットのリスト。ウィジェットは、指定された順序で表示されます。

NestedWidget

カルーセル カードの下部に表示されるウィジェットのリスト。ウィジェットは、指定された順序で表示されます。

Icon

アイコン画像。icon と text の両方を設定すると、テキストの前にアイコンが表示されます。

string

チップ内に表示されるテキスト。

OnClick

省略可。ユーザーがチップをクリックしたときに実行するアクション（ハイパーリンクを開く、カスタム関数を実行するなど）。

bool

チップがアクティブな状態にあり、ユーザー操作に応答するかどうか。デフォルトは true です。非推奨です。代わりに disabled を使用してください。

bool

チップが非アクティブな状態にあり、ユーザーの操作を無視するかどうか。デフォルトは false です。

string

ユーザー補助機能で使用される代替テキスト。

チップの機能についてユーザーに説明する説明テキストを設定します。たとえば、チップがハイパーリンクを開く場合は、「新しいブラウザタブを開き、Google Chat デベロッパー向けドキュメント（https://developers.google.com/workspace/chat"）に移動します」と記述します。

Layout

指定されたチップリスト レイアウト。

Chip

チップの配列。

HorizontalAlignment

展開ボタンと閉じるボタンの水平方向の配置。

Button

省略可。セクションを開くカスタマイズ可能なボタンを定義します。expand_button フィールドと collapse_button フィールドの両方を設定する必要があります。フィールドセットが適用されないのは 1 つだけです。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。

Button

省略可。セクションを閉じるカスタマイズ可能なボタンを定義します。expand_button フィールドと collapse_button フィールドの両方を設定する必要があります。フィールドセットが適用されないのは 1 つだけです。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。

Column

列の配列。カードまたはダイアログには最大 2 つの列を含めることができます。

HorizontalSizeStyle

列がカードの幅をどのように埋めるかを指定します。

HorizontalAlignment

ウィジェットを列の左、右、中央のいずれに配置するかを指定します。

VerticalAlignment

ウィジェットを列の上部、下部、中央のいずれに配置するかを指定します。

Widgets

列に含まれるウィジェットの配列。ウィジェットは、指定された順序で表示されます。

TextParagraph

TextParagraphウィジェットです。

Image

Imageウィジェットです。

DecoratedText

DecoratedTextウィジェットです。

ButtonList

ButtonListウィジェットです。

TextInput

TextInputウィジェットです。

SelectionInput

SelectionInputウィジェットです。

DateTimePicker

DateTimePickerウィジェットです。

ChipList

ChipList ウィジェットです。 Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

string

フォーム入力イベントで DateTimePicker を識別する名前。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

string

日付、時刻、日時を入力するようユーザーに促すテキスト。たとえば、ユーザーが予約をスケジュールする場合は、Appointment date や Appointment date and time などのラベルを使用します。

DateTimePickerType

ウィジェットが日付、時刻、日時を入力できるかどうか。

int64

ウィジェットに表示されるデフォルト値（Unix エポック時間からの経過時間（ミリ秒単位））。

選択ツールのタイプ（DateTimePickerType）に基づいて値を指定します。

• DATE_AND_TIME: カレンダーの日時（UTC）。たとえば、2023 年 1 月 1 日午後 12 時（UTC）を表すには、1672574400000 を使用します。
• DATE_ONLY: UTC の 00:00:00 のカレンダーの日付。たとえば、2023 年 1 月 1 日を表すには、1672531200000 を使用します。
• TIME_ONLY: UTC の時刻。たとえば、午後 12 時を示すには、43200000（または 12 * 60 * 60 * 1000）を使用します。

int32

UTC からのタイムゾーン オフセットを分単位で表す数値。設定されている場合、value_ms_epoch は指定されたタイムゾーンで表示されます。未設定の場合、値はユーザーのタイムゾーン設定にデフォルトで設定されます。

Action

ユーザーが DateTimePicker インターフェースで [保存] または [消去] をクリックするとトリガーされます。

Validation

Google Chat アプリと Google Workspace アドオンで利用できます。

Icon

startIcon に置き換えられました。

Icon

テキストの前に表示されるアイコン。

string

text の上に表示されるテキスト。常に切り捨てられます。

string

必須。メインのテキスト。

シンプルな書式設定をサポートしています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。

bool

テキストの折り返し設定。true の場合、テキストは折り返されて複数行に表示されます。それ以外の場合、テキストは切り捨てられます。

text にのみ適用されます。topLabel と bottomLabel には適用されません。

string

text の下に表示されるテキスト。常に折り返します。

OnClick

このアクションは、ユーザーが topLabel または bottomLabel をクリックしたときにトリガーされます。

Button

ユーザーがクリックしてアクションをトリガーできるボタン。

SwitchControl

ユーザーがクリックして状態を変更し、アクションをトリガーできるスイッチ ウィジェット。

Icon

テキストの後に表示されるアイコン。

組み込みアイコンとカスタムアイコンをサポートします。

string

フォーム入力イベントでスイッチ ウィジェットを識別する名前。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

string

ユーザーが入力した値。フォーム入力イベントの一部として返されます。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

bool

true の場合、スイッチが選択されています。

Action

スイッチの状態が変更されたときに実行するアクション（実行する関数など）。

ControlType

ユーザー インターフェースにスイッチが表示される仕組み。

Google Chat アプリと Google Workspace アドオンで利用できます。

string

グリッドのヘッダーに表示されるテキスト。

GridItem

グリッドに表示するアイテム。

BorderStyle

各グリッドアイテムに適用する枠線スタイル。

int32

グリッドに表示する列の数。このフィールドが指定されていない場合はデフォルト値が使用されます。デフォルト値は、グリッドが表示される場所（ダイアログとコンパニオン）によって異なります。

OnClick

このコールバックは、個々のグリッドアイテムで再利用されますが、アイテムの ID とアイテムリスト内のインデックスがコールバックのパラメータに追加されます。

string

このグリッドアイテムのユーザー指定の識別子。この ID は、親グリッドの onClick コールバック パラメータで返されます。

ImageComponent

グリッドアイテムに表示される画像。

string

グリッドアイテムのタイトル。

string

グリッド アイテムのサブタイトル。

GridItemLayout

グリッドアイテムに使用するレイアウト。

string

省略可。ユーザー補助機能に使用されるアイコンの説明。指定しない場合、デフォルト値 Button が設定されます。ベスト プラクティスとして、アイコンに表示される内容と、該当する場合は機能について、わかりやすい説明を設定してください。例: A user's account portrait、または Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat。

アイコンが Button に設定されている場合、ユーザーがボタンにカーソルを合わせると、altText がヘルパー テキストとして表示されます。ただし、ボタンに text も設定されている場合、アイコンの altText は無視されます。

ImageType

画像に適用された切り抜きスタイル。CIRCLE の切り抜きを適用すると、画像が組み込みアイコンよりも大きく描画されることがあります。

string

Google Workspace が提供する組み込みアイコンのいずれかを表示します。

たとえば、飛行機のアイコンを表示するには、AIRPLANE を指定します。バスの場合は、BUS を指定します。

サポートされているアイコンの一覧については、組み込みアイコンをご覧ください。

string

HTTPS URL でホストされているカスタム アイコンを表示します。

次に例を示します。

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

サポートされているファイル形式は .png と .jpg です。

MaterialIcon

Google マテリアル アイコンのいずれかを表示します。

たとえば、チェックボックス アイコンを表示するには、

"material_icon": {
  "name": "check_box"
}

Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

string

画像をホストする HTTPS URL。

次に例を示します。

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

OnClick

ユーザーが画像をクリックすると、このアクションがトリガーされます。

string

ユーザー補助機能で使用されるこの画像の代替テキスト。

string

画像の URL。

string

画像のユーザー補助ラベル。

ImageCropStyle

画像に適用する切り抜きスタイル。

BorderStyle

画像に適用するボーダー スタイル。

ImageCropType

切り抜きタイプ。

double

クロップタイプが RECTANGLE_CUSTOM の場合に使用するアスペクト比。

たとえば、16:9 のアスペクト比を適用する方法は次のとおりです。

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

string

Google マテリアル アイコンで定義されたアイコン名（check_box など）。無効な名前は破棄され、空の文字列に置き換えられるため、アイコンがレンダリングされなくなります。

bool

アイコンを塗りつぶしてレンダリングするかどうか。デフォルト値は false です。

さまざまなアイコン設定をプレビューするには、Google フォント アイコンに移動し、[カスタマイズ] で設定を調整します。

int32

アイコンのストロークの太さ。{100, 200, 300, 400, 500, 600, 700} から選択します。指定しない場合、デフォルト値は 400 です。他の値を指定した場合は、デフォルト値が使用されます。

さまざまなアイコン設定をプレビューするには、Google フォント アイコンに移動し、[カスタマイズ] で設定を調整します。

int32

ウェイトとグレードは記号の太さに影響します。グレードの調整はウェイトの調整よりもきめ細かく、記号のサイズへの影響は小さくなります。{-25、0、200} から選択します。指定しない場合、デフォルト値は 0 です。他の値を指定した場合は、デフォルト値が使用されます。

さまざまなアイコン設定をプレビューするには、Google フォント アイコンに移動し、[カスタマイズ] で設定を調整します。

Action

指定すると、この onClick によってアクションがトリガーされます。

OpenLink

指定すると、この onClick はリンクを開くアクションをトリガーします。

Action

アドオンは、リンクを開く必要がある場合にこのアクションをトリガーします。これは、リンクを取得するためにサーバーと通信する必要があるという点で、上記の open_link とは異なります。そのため、リンクを開くアクション レスポンスが返される前に、ウェブクライアントが準備作業を行う必要があります。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

Card

指定されている場合は、クリック後に新しいカードがカードスタックにプッシュされます。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

OverflowMenu

指定すると、この onClick でオーバーフロー メニューが開きます。 Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

string

開く URL。

OpenAs

リンクを開く方法。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

OnClose

クライアントがリンクを開いた後にリンクを忘れるか、ウィンドウが閉じられるまでリンクを保持するか。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

OverflowMenuItem

必須。メニュー オプションのリスト。

Icon

テキストの前に表示されるアイコン。

string

必須。アイテムを識別または説明するテキスト。

OnClick

必須。メニュー オプションが選択されたときに呼び出されるアクション。この OnClick には OverflowMenu を含めることはできません。指定された OverflowMenu は破棄され、メニュー項目が無効になります。

bool

メニュー オプションが無効かどうか。デフォルトは false です。

string

必須。フォーム入力イベント内の選択入力を識別する名前。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

string

ユーザー インターフェースの選択入力フィールドの上に表示されるテキスト。

アプリに必要な情報をユーザーが入力できるように、テキストを指定します。たとえば、ユーザーがプルダウン メニューから作業チケットの緊急度を選択する場合、ラベルは「緊急度」または「緊急度を選択」になります。

SelectionType

SelectionInput ウィジェットでユーザーに表示されるアイテムのタイプ。選択タイプは、さまざまなタイプのインタラクションをサポートしています。たとえば、ユーザーはチェックボックスを 1 つ以上選択できますが、プルダウン メニューから選択できるのは 1 つの値のみです。

SelectionItem

選択可能なアイテムの配列。たとえば、ラジオボタンやチェックボックスの配列などです。最大 100 個のアイテムをサポートします。

Action

指定すると、選択内容が変更されたときにフォームが送信されます。指定しない場合は、フォームを送信する別のボタンを指定する必要があります。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

int32

複数選択メニューの場合、ユーザーが選択できる項目の最大数。最小値は 1 個です。指定しない場合、デフォルトは 3 個のアイテムになります。

int32

複数選択メニューの場合、メニューが候補の選択項目を返す前にユーザーが入力するテキスト文字数。

設定されていない場合、マルチ選択メニューは次のデフォルト値を使用します。

• メニューが SelectionInput アイテムの静的配列を使用する場合、デフォルトは 0 文字で、配列からアイテムがすぐに入力されます。
• メニューが動的データソース（multi_select_data_source）を使用する場合、デフォルトは 3 文字で、データソースにクエリを実行して候補アイテムを返します。

Validation

プルダウン メニューの場合、この選択入力フィールドの検証。

Google Chat アプリと Google Workspace アドオンで利用できます。

Action

リレーショナル データベースなどの外部データソース。

PlatformDataSource

Google Workspace のデータソース。

CommonDataSource

Google Workspace 組織内のユーザーなど、すべての Google Workspace アプリケーションで共有されるデータソース。

HostAppDataSourceMarkup

Google Workspace ホスト アプリケーションに固有のデータソース（Google Chat のスペースなど）。

このフィールドは Google API クライアント ライブラリをサポートしていますが、Cloud クライアント ライブラリでは使用できません。詳細については、クライアント ライブラリをインストールするをご覧ください。

string

アイテムを識別または説明するテキスト。

string

この項目に関連付けられた値。クライアントは、これをフォームの入力値として使用する必要があります。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

bool

アイテムがデフォルトで選択されるかどうか。選択入力で 1 つの値のみが許可される場合（ラジオボタンやプルダウン メニューなど）、このフィールドは 1 つの項目にのみ設定します。

string

複数選択メニューの場合、アイテムの text フィールドの横に表示されるアイコンの URL。PNG ファイルと JPEG ファイルをサポートしています。HTTPS URL である必要があります。例: https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

string

複数選択メニューの場合、アイテムの text フィールドの下に表示されるテキストの説明またはラベル。

SuggestionItem

テキスト入力フィールドのオートコンプリート候補に使用される候補のリスト。

string

テキスト入力フィールドへの候補入力の値。これは、ユーザーが自分で入力するのと同じです。

string

フォーム入力イベントでテキスト入力を識別する名前。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

string

ユーザー インターフェースのテキスト入力フィールドの上に表示されるテキスト。

アプリに必要な情報をユーザーが入力できるように、テキストを指定します。たとえば、名前を尋ねる際に姓のみが必要であれば、name ではなく surname を記述します。

hintText が指定されていない場合は必須。それ以外の場合は、任意です。

string

テキスト入力フィールドの下に表示されるテキスト。特定の値を入力するようユーザーに促す目的で使用されます。このテキストは常に表示されます。

label が指定されていない場合は必須。それ以外の場合は、任意です。

string

ユーザーが入力した値。フォーム入力イベントの一部として返されます。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

Type

テキスト入力フィールドがユーザー インターフェースにどのように表示されるか。たとえば、フィールドが単一行か複数行かなどです。

Action

テキスト入力フィールドで変更が発生した場合の対応方法。たとえば、ユーザーがフィールドに追加したり、テキストを削除したりした場合です。

実行するアクションの例としては、カスタム関数の実行や、Google Chat でダイアログを開くなどがあります。

Suggestions

ユーザーが入力できる候補値。これらの値は、ユーザーがテキスト入力フィールド内をクリックしたときに表示されます。ユーザーが入力すると、入力内容に合わせて候補値が動的にフィルタされます。

たとえば、プログラミング言語のテキスト入力フィールドでは、Java、JavaScript、Python、C++ が候補として表示されます。ユーザーが Jav と入力し始めると、候補リストがフィルタされ、Java と JavaScript のみが表示されます。

候補値は、アプリが理解できる値をユーザーが入力できるようにするためのものです。JavaScript を参照する場合、javascript と入力するユーザーもいれば、java script と入力するユーザーもいます。JavaScript を提案することで、ユーザーがアプリを操作する方法を標準化できます。

指定した場合、TextInput.type は MULTIPLE_LINE に設定されている場合でも常に SINGLE_LINE になります。

Google Chat アプリと Google Workspace アドオンで利用できます。

Action

省略可。テキスト入力フィールドでユーザーが操作したときに候補が表示された場合に実行するアクションを指定します。

指定しない場合、候補は initialSuggestions によって設定され、クライアントによって処理されます。

指定すると、アプリはここで指定されたアクション（カスタム関数の実行など）を実行します。

Google Workspace アドオンで利用可能。Google Chat アプリでは利用できません。

Validation

Google Chat アプリと Google Workspace アドオンで利用できます。

string

テキスト入力フィールドが空のときに表示されるテキスト。このテキストは、値を入力するようユーザーに求めるメッセージとして使用します。たとえば、Enter a number from 0 to 100 です。

Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

string

ウィジェットに表示するテキスト。

int32

ウィジェットに表示されるテキストの最大行数。テキストが指定された最大行数を超えると、超過分は [もっと見る] ボタンの背後に隠されます。テキストが指定された最大行数以下の場合、[もっと見る] ボタンは表示されません。

デフォルト値は 0 です。この場合、すべてのコンテキストが表示されます。負の値は無視されます。 Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

int32

Google Chat アプリと Google Workspace アドオンで利用できます。

InputType

Google Chat アプリと Google Workspace アドオンで利用できます。

HorizontalAlignment

ウィジェットを列の左、右、中央のいずれに配置するかを指定します。

TextParagraph

テキスト パラグラフを表示します。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。

たとえば、次の JSON では太字のテキストが作成されます。

"textParagraph": {
  "text": "  <b>bold text</b>"
}

Image

画像を表示します。

たとえば、次の JSON は代替テキストを含む画像を作成します。

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

DecoratedText

装飾されたテキスト項目を表示します。

たとえば、次の JSON は、メールアドレスを表示する装飾付きテキスト ウィジェットを作成します。

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

ButtonList

ボタンのリスト。

たとえば、次の JSON は 2 つのボタンを作成します。1 つ目は青いテキスト ボタンで、2 つ目はリンクを開く画像ボタンです。

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

TextInput

ユーザーが入力できるテキスト ボックスを表示します。

たとえば、次の JSON はメールアドレスのテキスト入力を作成します。

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

別の例として、次の JSON は、静的な候補を含むプログラミング言語のテキスト入力を作成します。

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

SelectionInput

ユーザーがアイテムを選択できる選択コントロールを表示します。選択コントロールには、チェックボックス、ラジオボタン、スイッチ、プルダウン メニューがあります。

たとえば、次の JSON は、ユーザーがサイズを選択できるプルダウン メニューを作成します。

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

DateTimePicker

ユーザーが日付、時刻、または日時を入力できるウィジェットを表示します。

たとえば、次の JSON は、予約のスケジュールを設定する日時選択ツールを作成します。

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

Divider

ウィジェットの間に水平線の分割線を表示します。

たとえば、次の JSON は分割線を作成します。

"divider": {
}

Grid

アイテムのコレクションを含むグリッドを表示します。

グリッドは、任意の数の列とアイテムをサポートします。行数は、アイテム数の上限を列数で割った値によって決まります。アイテムが 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"
    }
  }
}

Columns

最大 2 列を表示します。

2 つを超える列を含める場合や行を使用する場合は、Grid ウィジェットを使用します。

たとえば、次の JSON では、それぞれにテキスト パラグラフを含む 2 つの列が作成されます。

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

Carousel

カルーセルには、ネストされたウィジェットのコレクションが含まれています。たとえば、次の JSON は、2 つのテキスト パラグラフを含むカルーセルを表しています。

{
  "widgets": [
    {
      "textParagraph": {
        "text": "First text paragraph in the carousel."
      }
    },
    {
      "textParagraph": {
        "text": "Second text paragraph in the carousel."
      }
    }
  ]
}

ChipList

チップのリスト。

たとえば、次の JSON では 2 つのチップが作成されます。1 つ目はテキスト チップで、2 つ目はリンクを開くアイコン チップです。

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。