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

省略可。このリストに、有効な送信に必要なウィジェットの名前を入力します。

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

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

bool

省略可。true の場合、すべてウィジェットがこのアクションで必須と見なされます。

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

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

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

Type

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

Button

ボタンの配列。

CardHeader

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

Section

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

DividerStyle

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

CardAction

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

Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。

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

"cardActions": [
  {
    "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 アプリでは利用できません。

ExpressionData

カードの式データ。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。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 の場合にのみ考慮されます。

string

セクションに割り当てられる一意の ID。変更するセクションを識別するために使用されます。ID の最大文字数は 64 文字で、[a-zA-Z0-9-]+ の形式にする必要があります。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。Google Chat アプリでは使用できません。

CollapseControl

省略可。セクションの展開ボタンと折りたたみボタンを定義します。このボタンは、セクションが折りたたみ可能な場合にのみ表示されます。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。

CarouselCard

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

NestedWidget

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

NestedWidget

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

Icon

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

string

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

OnClick

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

bool

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

bool

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

string

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

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

Layout

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

Chip

チップの配列。

HorizontalAlignment

展開ボタンと折りたたみボタンの水平方向の配置。

Button

省略可。カスタマイズ可能なボタンを定義して、セクションを開きます。expandButton フィールドと collapseButton フィールドの両方を設定する必要があります。1 つのフィールド セットのみが有効になりません。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。

Button

省略可。セクションを折りたたむためのカスタマイズ可能なボタンを定義します。expandButton フィールドと collapseButton フィールドの両方を設定する必要があります。1 つのフィールド セットのみが有効になりません。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。

Column

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

HorizontalSizeStyle

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

HorizontalAlignment

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

VerticalAlignment

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

Widgets

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

TextParagraph

TextParagraphウィジェットです。

Image

Imageウィジェットです。

DecoratedText

DecoratedTextウィジェットです。

ButtonList

ButtonListウィジェットです。

TextInput

TextInputウィジェットです。

SelectionInput

SelectionInputウィジェットです。

DateTimePicker

DateTimePickerウィジェットです。

ChipList

ChipListウィジェットです。

string

ActionRule の一意の識別子。

ExpressionDataCondition

式データによって決定される条件。

ConditionType

条件のタイプ。

HostAppDataActionMarkup

Google Workspace データを更新する方法を定義します。

Action

データはリモート データ プロバイダから取得されます。

PlatformDataSource

データは 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: 00:00:00 UTC のカレンダーの日付。たとえば、2023 年 1 月 1 日を表すには、1672531200000 を使用します。
• TIME_ONLY: UTC の時刻。たとえば、午後 12 時を表すには、43200000（または 12 * 60 * 60 * 1000）を使用します。

int32

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

Action

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

HostAppDataSourceMarkup

Gmail のメール、Google カレンダーの予定、Google Chat のメッセージなど、Google Workspace ホスト アプリケーションに固有のデータソース。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。Google Chat アプリでは使用できません。

Icon

非推奨となり、startIcon に置き換えられました。

Icon

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

VerticalAlignment

省略可。開始アイコンの垂直方向の配置。設定しない場合、アイコンは垂直方向に中央揃えになります。

Google Chat アプリでは利用できますが、Google Workspace アドオンでは利用できません。

string

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

TextParagraph

TextParagraph は top_label と同等です。常に切り捨てられます。top_label よりも複雑な形式設定が可能です。

Google Chat アプリでは利用できますが、Google Workspace アドオンでは利用できません。

string

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

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

TextParagraph

TextParagraph は text と同等です。text よりも複雑な形式設定が可能です。

Google Chat アプリでは利用できますが、Google Workspace アドオンでは利用できません。

bool

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

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

string

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

TextParagraph

TextParagraph は bottom_label と同等です。常に折り返します。bottom_label よりも複雑な形式設定が可能です。

Google Chat アプリでは利用できますが、Google Workspace アドオンでは利用できません。

OnClick

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

Button

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

SwitchControl

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

Icon

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

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

string

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

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

string

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

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

bool

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

Action

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

ControlType

ユーザー インターフェースでの切り替えの表示方法。

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

Action

Google Chat のアドオンの場合、ダイアログを閉じるアクション。

string

ActionRule の一意の識別子。

Trigger

EventAction の実行後にトリガーされるトリガーのリスト。

CommonWidgetAction

一般的なウィジェット アクション。

UpdateVisibilityAction

ウィジェットの表示設定を更新するアクション。

Visibility

新しい公開設定。

string

ExpressionData の一意の識別子。

string

コンパイルされていない式。

Condition

式の評価結果によって決定される条件のリスト。

EventAction

ExpressionData を使用できるアクションのリスト。

Suggestions

string

これは、構文チェックのマークアップに存在する可能性がある no-op スキーマ フィールドです。

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

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

string

このグリッド アイテムのユーザー指定の識別子。この識別子は、親グリッドの 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 マテリアル アイコンのいずれかを表示します。

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

"materialIcon": {
  "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

アドオンに戻るリンクの URL。

string

アドオンに戻るためのリンクのタイトル。

Card

サードパーティ サービスからのリンクに関する情報を表示するカード。

string

リンクのプレビューのスマートチップに表示されるタイトル。設定されていない場合、スマートチップには previewCard のヘッダーが表示されます。

string

リンク プレビューに表示されるタイトル。設定されていない場合、リンクのプレビューには previewCard のヘッダーが表示されます。

string

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

bool

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

さまざまなアイコン設定をプレビューするには、Google Font Icons にアクセスし、[カスタマイズ] で設定を調整します。

int32

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

さまざまなアイコン設定をプレビューするには、Google Font Icons にアクセスし、[カスタマイズ] で設定を調整します。

int32

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

さまざまなアイコン設定をプレビューするには、Google Font Icons にアクセスし、[カスタマイズ] で設定を調整します。

UpdateWidget

Google Chat のアドオンの場合、カードまたはダイアログのウィジェットを更新します。

SelectionInputWidgetSuggestions

selectionInput ウィジェットの場合、複数選択メニューの候補項目の配列。マルチセレクト メニューで外部データソースを使用して項目を入力する場合、ユーザーがメニューに入力した内容に基づいて候補を動的に入力できます。詳しくは、Google Chat ユーザーから情報を収集するをご覧ください。

SelectionItem

ユーザーが複数選択メニューに入力した後に表示される選択可能なアイテムの配列。

bool

ルートカードを除くすべてのカードをポップします。

bool

カードを 1 枚取り外します。

string

指定されたカード名を持つ指定されたカードより上のすべてのカードをポップします。

Card

カードをカードスタックにプッシュします。

Google Chat のダイアログの場合、ダイアログを開くか更新します。

Card

一番上のカードを新しいカードで更新し、入力済みのフォーム フィールドの値を保持します。同等のフィールドでない場合、値は削除されます。

Google Chat のダイアログの場合、ダイアログを開くか更新します。

EndNavigation

Google Chat のアドオンの場合、ダイアログを閉じます。

string

通知に表示する書式なしテキスト。HTML タグは含めません。

Action

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

OpenLink

指定されている場合、この onClick はリンクを開くアクションをトリガーします。

Action

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

Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。

Card

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

Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。

OverflowMenu

指定されている場合、この onClick はオーバーフロー メニューを開きます。

string

開く URL。HTTP URL が HTTPS に変換されます。

OpenAs

リンクを開く方法。

Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。

OnClose

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

Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。

OverflowMenuItem

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

Icon

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

string

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

OnClick

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

bool

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

Action

アドオンが UI の更新に使用できるアクション。

Google Chat のアドオン。

HostAppActionMarkup

個々のホストアプリによって処理されるアクション。

string

これは、構文チェックのマークアップに存在する可能性がある no-op スキーマ フィールドです。

Navigation

カードをプッシュ、ポップ、更新します。

Google Chat のアドオン。

OpenLink

リンク先を新しいタブまたはポップアップ ウィンドウで開きます。

Notification

ユーザーがカードを操作したときに、ホストの Google Workspace アプリケーションに通知を表示します。

Google Chat のアドオンの場合、ユーザーがダイアログを送信して閉じると、通知が表示されます。

LinkPreview

Google ドキュメント、Google スプレッドシート、Google スライドで利用できます。スマートチップとカードを使用してリンクをプレビューします。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

Link

Google ドキュメントで利用できます。サードパーティ リソースからリンクを返し、ホスト アプリケーションでスマートチップに変換します。1 つの項目を含むオブジェクトの配列としてフォーマットされます。

詳しくは、@ メニューからサードパーティのリソースを作成するをご覧ください。

ModifyCard

Google Chat のアドオンの場合、ユーザーの操作に基づいてカードを更新します。配列にはオブジェクトを 1 つだけ含める必要があります。

string

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

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

string

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

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

SelectionType

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

SelectionItem

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

Action

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

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

int32

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

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

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

DataSourceConfig

省略可。選択コントロールのデータソース構成。このフィールドでは、データソースをよりきめ細かく制御できます。

指定されている場合、multi_select_max_selected_items フィールド、multi_select_min_query_length フィールド、external_data_source フィールド、platform_data_source フィールドは無視されます。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。Google Chat アプリでは使用できません。

int32

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

string

省略可。選択入力フィールドの下に表示されるテキスト。ユーザーが特定の値を入力するよう促すことで、ユーザーをサポートすることを目的としています。このテキストは常に表示されます。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。Google Chat アプリでは使用できません。

Action

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

PlatformDataSource

Google Workspace のデータソース。

CommonDataSource

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

HostAppDataSourceMarkup

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

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

string

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

string

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

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

bool

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

string

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

string

RenderActions

カードにアクションを実行するよう指示したり、アドオン ホストアプリにアプリ固有のアクションを実行するよう指示したりする一連のレンダリング手順。

bool

カードの状態が変更され、既存のカードのデータが古いかどうか。

string

これは、構文チェックのマークアップに存在する可能性がある no-op スキーマ フィールドです。

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 アドオンでは利用できません。

HostAppDataSourceMarkup

Gmail のメール、Google カレンダーの予定、Google Chat のメッセージなど、Google Workspace ホスト アプリケーションに固有のデータソース。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。Google Chat アプリでは使用できません。

string

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

int32

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

デフォルト値は 0 で、この場合、すべてのコンテキストが表示されます。負の値は無視されます。

TextSyntax

テキストの構文。設定されていない場合、テキストは HTML としてレンダリングされます。

Google Chat アプリでは利用できますが、Google Workspace アドオンでは利用できません。

string

ActionRule の一意の識別子。

int32

テキスト入力ウィジェットの文字数制限を指定します。これはテキスト入力にのみ使用され、他のウィジェットでは無視されます。

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

InputType

入力ウィジェットのタイプを指定します。

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

HorizontalAlignment

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

string

ウィジェットに割り当てられた一意の ID。変更するウィジェットの識別に使用されます。ID の文字数は 64 文字以内にする必要があります。形式は [a-zA-Z0-9-]+ にする必要があります。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。Google Chat アプリでは使用できません。

Visibility

ウィジェットが表示されるか非表示になるかを指定します。デフォルト値は VISIBLE です。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。Google Chat アプリでは使用できません。

EventAction

ウィジェットで実行できるイベント アクションを指定します。

Google Workspace フローを拡張する Google Workspace アドオンで利用できます。これは、Gemini アルファ版プログラムの一部として提供されています。Google Chat アプリでは使用できません。

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 列を表示します。

3 つ以上の列を含める場合や、行を使用する場合は、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

カルーセルには、ネストされたウィジェットのコレクションが含まれています。たとえば、2 つのテキスト段落を含むカルーセルの JSON 表現は次のようになります。

{
  "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"
        }
      }
    }
  ]
}