カード
カードは、テキストや画像などの UI ウィジェットを追加できる UI 要素です。
JSON 表現 |
---|
{ "header": { object ( |
フィールド | |
---|---|
header
|
カードのヘッダー。通常、ヘッダーにはタイトルと画像を指定します。 |
sections[]
|
セクションは線の区切りで区切られます。 |
cardActions[]
|
このカードでの操作。 |
name
|
カードの名前。 |
CardHeader
JSON 表現 |
---|
{
"title": string,
"subtitle": string,
"imageStyle": enum (
|
フィールド | |
---|---|
title
|
タイトルを指定してください。ヘッダーの高さは固定されています。タイトルとサブタイトルの両方を指定すると、それぞれが 1 行になります。タイトルのみを指定する場合は、2 行に記述します。 |
subtitle
|
カードヘッダーのサブタイトル。 |
imageStyle
|
画像の種類(正方形の枠線や円形の枠線など)。 |
imageUrl
|
カードヘッダーの画像の URL。 |
ImageStyle
列挙型 | |
---|---|
IMAGE_STYLE_UNSPECIFIED
|
|
IMAGE
|
正方形の枠線。 |
AVATAR
|
円形の枠線。 |
セクション
セクションには、指定された順序で(垂直に)レンダリングされるウィジェットのコレクションが含まれます。どのプラットフォームでもカードの幅は固定されるため、現時点ではレイアウト プロパティ(float など)は必要ありません。
JSON 表現 |
---|
{
"header": string,
"widgets": [
{
object (
|
フィールド | |
---|---|
header
|
セクションのヘッダー。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、このモジュールの Google Chat アプリでのテキストの書式設定 および Google Workspace アドオンでのテキストの書式設定。 |
widgets[]
|
セクションには、少なくとも 1 つのウィジェットが含まれている必要があります。 |
WidgetMarkup
ウィジェットは、テキストと画像を表示する UI 要素です。
JSON 表現 |
---|
{ "buttons": [ { object ( |
フィールド | |
---|---|
buttons[]
|
ボタンのリスト。ボタンも
|
共用体フィールド
data 。
WidgetMarkup
は次のいずれかのアイテムのみを持つことができます。複数の
WidgetMarkup
その他のアイテムを表示します。
data
は次のいずれか 1 つのみを指定できます。
|
|
textParagraph
|
このウィジェットに段落テキストを表示します。 |
image
|
このウィジェットに画像を表示します。 |
keyValue
|
このウィジェットに Key-Value アイテムを表示します。 |
TextParagraph
テキストの段落。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、このモジュールの Google Chat アプリでのテキストの書式設定 および Google Workspace アドオンでのテキストの書式設定。
JSON 表現 |
---|
{ "text": string } |
フィールド | |
---|---|
text
|
|
画像
URL で指定される画像。
onclick
できます。
JSON 表現 |
---|
{
"imageUrl": string,
"onClick": {
object (
|
フィールド | |
---|---|
imageUrl
|
画像の URL です。 |
onClick
|
「
|
aspectRatio
|
この画像のアスペクト比(幅と高さ)。このフィールドを使用すると、画像の読み込みを待っている間に画像の高さを適切に予約できます。画像に組み込まれているアスペクト比をオーバーライドするためのものではありません。未設定の場合、サーバーは画像をプリフェッチして埋めます。 |
OnClick
「
onclick
できます(リンクを開くなど)。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
action
|
フォームのアクションは
|
openLink
|
この
|
FormAction
フォームのアクションは、フォームが送信されたときの動作を記述します。たとえば、Apps Script を呼び出してフォームを処理できます。
JSON 表現 |
---|
{
"actionMethodName": string,
"parameters": [
{
object (
|
フィールド | |
---|---|
actionMethodName
|
メソッド名は、フォームの送信をトリガーしたフォームのどの部分かを識別するために使用されます。この情報は、カードクリック イベントの一部として Chat アプリにエコーバックされます。共通の動作をトリガーする複数の要素に同じメソッド名を使用できます。 |
parameters[]
|
アクション パラメータのリスト。 |
ActionParameter
アクション メソッドが呼び出されたときに指定する文字列パラメータのリスト。例えば、今すぐスヌーズ、1 日スヌーズ、来週スヌーズの 3 つのスヌーズボタンを考えてみましょう。用途
action method = snooze()
: スヌーズの種類とスヌーズ時間を文字列パラメータのリストに渡します。
JSON 表現 |
---|
{ "key": string, "value": string } |
フィールド | |
---|---|
key
|
アクション スクリプトのパラメータの名前。 |
value
|
パラメータの値。 |
OpenLink
新しいウィンドウを開くリンク。
JSON 表現 |
---|
{ "url": string } |
フィールド | |
---|---|
url
|
開く URL。 |
KeyValue
UI 要素には、キー(ラベル)と値(コンテンツ)が含まれます。この要素には、次のようなアクションも含めることができます。
onclick
] ボタンを離します。
JSON 表現 |
---|
{ "topLabel": string, "content": string, "contentMultiline": boolean, "bottomLabel": string, "onClick": { object ( |
フィールド | |
---|---|
topLabel
|
上部ラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、このモジュールの Google Chat アプリでのテキストの書式設定 および Google Workspace アドオンでのテキストの書式設定。 |
content
|
コンテンツのテキスト。書式設定されたテキストがサポートされており、常に必須です。テキストの書式設定について詳しくは、このモジュールの Google Chat アプリでのテキストの書式設定 および Google Workspace アドオンでのテキストの書式設定。 |
contentMultiline
|
コンテンツが複数行になるかどうか。 |
bottomLabel
|
下部のラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定について詳しくは、このモジュールの Google Chat アプリでのテキストの書式設定 および Google Workspace アドオンでのテキストの書式設定。 |
onClick
|
「
|
共用体フィールド
icons 。1 つ以上のアイコン
top_label
および
bottom_label
定義する必要があります。
icons
は次のいずれか 1 つのみを指定できます。
|
|
icon
|
Chat API によって対応するアイコン画像に置き換えられる列挙値。 |
iconUrl
|
URL で指定されたアイコン。 |
共用体フィールド
control 。コントロール ウィジェット。次のどちらかを設定できます。
button
または
switch_widget で、両方は不可。
control
は次のいずれか 1 つのみを指定できます。
|
|
button
|
クリックしてアクションをトリガーできるボタン。 |
アイコン
サポートされているアイコンのセット。
列挙型 | |
---|---|
ICON_UNSPECIFIED
|
|
AIRPLANE
|
|
BOOKMARK
|
|
BUS
|
|
CAR
|
|
CLOCK
|
|
CONFIRMATION_NUMBER_ICON
|
|
DOLLAR
|
|
DESCRIPTION
|
|
EMAIL
|
|
EVENT_PERFORMER
|
|
EVENT_SEAT
|
|
FLIGHT_ARRIVAL
|
|
FLIGHT_DEPARTURE
|
|
HOTEL
|
|
HOTEL_ROOM_TYPE
|
|
INVITE
|
|
MAP_PIN
|
|
MEMBERSHIP
|
|
MULTIPLE_PEOPLE
|
|
OFFER
|
|
PERSON
|
|
PHONE
|
|
RESTAURANT_ICON
|
|
SHOPPING_CART
|
|
STAR
|
|
STORE
|
|
TICKET
|
|
TRAIN
|
|
VIDEO_CAMERA
|
|
VIDEO_PLAY
|
ボタン
ボタン。テキストボタンまたは画像ボタンです。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
textButton
|
テキストと
|
imageButton
|
画像とテキストを含むボタン
|
TextButton
テキストと
onclick
できます。
JSON 表現 |
---|
{
"text": string,
"onClick": {
object (
|
フィールド | |
---|---|
text
|
ボタンのテキスト。 |
onClick
|
「
|
ImageButton
画像ボタン
onclick
できます。
JSON 表現 |
---|
{ "onClick": { object ( |
フィールド | |
---|---|
onClick
|
「
|
name
|
名前
|
共用体フィールド
icons 。アイコンは、
Icon
enum
できます。
icons
は次のいずれか 1 つのみを指定できます。
|
|
icon
|
アイコンは、
|
iconUrl
|
URL で指定されたアイコン。 |
CardAction
カード アクションとは、カードに関連付けられているアクションです。請求書カードの場合、通常は請求書を削除するか、請求書をメールで送信するか、ブラウザで請求書を開きます。
Google Chat アプリではサポートされません。
JSON 表現 |
---|
{
"actionLabel": string,
"onClick": {
object (
|
フィールド | |
---|---|
actionLabel
|
操作メニュー項目に表示されるために使用されるラベル。 |
onClick
|
このアクション アイテムの click アクション。 |