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 オプションを使用してカード アクション メニューを作成します。

"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 を設定すると、エラーが発生します。チャットアプリでは、ダイアログで固定フッターを使用できますが、カード メッセージでは使用できません。

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

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

string

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

Widget

セクションのすべてのウィジェット。ウィジェットを 1 つ以上含める必要があります。

bool

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

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

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

int32

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

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

CollapseControl

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

Icon

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

string

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

OnClick

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

bool

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

bool

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

string

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

チップの機能についてユーザーに説明する説明的なテキストを設定します。たとえば、チップがハイパーリンクを開く場合は、「新しいブラウザタブを開き、Google Chat デベロッパー向けドキュメント（https://developers.google.com/workspace/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 ウィジェットです。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 アドオンでご利用いただけます。

Action

クライアントがダイアログフローを終了するためのレンダリング アクション。

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

Suggestions

string

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

string

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

GridItem

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

BorderStyle

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

int32

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

OnClick

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

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

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

string

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

string

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

bool

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

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

int32

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

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

int32

重量とグレードはシンボルの太さに影響します。グレードの調整は、重みの調整よりも細かく、記号のサイズに小さな影響を及ぼします。{-25、0、200} から選択します。指定しない場合、デフォルト値は 0 です。その他の値が指定されている場合は、デフォルト値が使用されます。

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

bool

カードスタックにより、ルートカード以外のすべてのカードがポップオフします。

bool

カードのグルーピングから 1 枚のカードがポップアウトします。

string

カードスタックは、指定されたカード名を持つ指定されたカードの上にあるすべてのカードをポップします。

Card

カードの積み重ねがカードを積み重ねの上に押し上げます。

Card

カード グルーピングでは、一番上のカードが新しいカードに更新され、入力されたフォーム フィールドの値は保持されます。同等でないフィールドの場合、値は破棄されます。

EndNavigation

Dialogflow のナビゲーション終了アクション。詳しくは、Google Chat アプリのホームページを作成するをご覧ください。

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

string

通知に表示するプレーン テキスト（HTML タグなし）。

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 です。

Action

HostAppActionMarkup

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

string

これは、構文チェックのためにマークアップに存在する可能性のある、無効なスキーマ フィールドです。

Navigation

表示されたカードのプッシュ、ポップ、更新を行います。

OpenLink

直ちに新しいタブまたはポップアップでターゲット リンクを開きます。

Notification

エンドユーザーに通知を表示します。

LinkPreview

リンクのプレビューをエンドユーザーに表示します。

Link

Google Workspace アプリケーション内から作成されたサードパーティ リソースのリンク。1 つのアイテムを含むオブジェクトの配列としてフォーマットされます。詳細については、[@] メニューからサードパーティ リソースを作成するをご覧ください。

string

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

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

string

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

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

SelectionType

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

SelectionItem

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

Action

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

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

int32

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

int32

複数選択メニューの場合、アプリがクエリする前にユーザーが入力したテキスト文字数が予測入力され、メニューの候補アイテムが表示されます。

指定しない場合のデフォルトは、静的データソースでは 0 文字、外部データソースでは 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 フィールドの下に表示される、テキストの説明またはラベル。

RenderActions

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

bool

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

string

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

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

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