Cards v1

カード

カードは、テキストや画像などの UI ウィジェットを含めることができる UI 要素です。

JSON 表現 
{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string
}
フィールド
header

object (CardHeader)

カードのヘッダー。ヘッダーには通常、タイトルと画像が含まれます。

sections[]

object (Section)

セクションは線で区切ります。

cardActions[]

object (CardAction)

このカードのアクション。

name

string

カードの名前。

CardHeader

JSON 表現 
{
  "title": string,
  "subtitle": string,
  "imageStyle": enum (ImageStyle),
  "imageUrl": string
}
フィールド
title

string

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

subtitle

string

カード ヘッダーのサブタイトル。

imageStyle

enum (ImageStyle)

画像の種類（正方形の枠線、円形の枠線など）。
imageUrl

string

カード ヘッダーの画像の URL です。

ImageStyle

列挙型
IMAGE_STYLE_UNSPECIFIED
IMAGE 正方形の枠線。
AVATAR 円形の枠線。

セクション

セクションには、指定された順序で（垂直方向に）レンダリングされるウィジェットのコレクションが含まれています。すべてのプラットフォームでカードの幅は狭く固定されているため、現在のところ、レイアウト プロパティ（float など）は必要ありません。

JSON 表現 
{
  "header": string,
  "widgets": [
    {
      object (WidgetMarkup)
    }
  ]
}
フィールド
header

string

セクションのヘッダー。書式設定されたテキストがサポートされています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定とGoogle Workspace アドオンでのテキストの書式設定をご覧ください。
widgets[]

object (WidgetMarkup)

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

WidgetMarkup

ウィジェットは、テキストと画像を表示する UI 要素です。

JSON 表現 
{
  "buttons": [
    {
      object (Button)
    }
  ],

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
  // End of list of possible types for union field data.
}
フィールド
buttons[]

object (Button)

ボタンのリスト。Buttons も oneof data であり、これらのフィールドのいずれか 1 つのみを設定する必要があります。
共用体フィールド data。WidgetMarkup には、次のいずれかの項目のみを含めることができます。複数の WidgetMarkup フィールドを使用して、より多くのアイテムを表示できます。data は次のいずれかになります。
textParagraph

object (TextParagraph)

このウィジェットにテキストの段落を表示します。

image

object (Image)

このウィジェットに画像を表示します。

keyValue

object (KeyValue)

このウィジェットに Key-Value アイテムを表示します。

TextParagraph

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

JSON 表現 
{
  "text": string
}
フィールド
text

string

画像

URL で指定され、onclick アクションを設定できる画像。

JSON 表現 
{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "aspectRatio": number
}
フィールド
imageUrl

string

画像の URL です。

onClick

object (OnClick)

onclick アクション。
aspectRatio

number

この画像のアスペクト比（幅と高さ）。このフィールドを使用すると、画像の読み込みを待機している間に、画像に適切な高さを予約できます。画像の組み込みのアスペクト比をオーバーライドするものではありません。設定されていない場合、サーバーは画像をプリフェッチして埋めます。

OnClick

onclick アクション（リンクを開くなど）。

JSON 表現 
{

  // Union field data can be only one of the following:
  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
  // End of list of possible types for union field data.
}
フィールド

共用体フィールド data。

data は次のいずれかになります。
action

object (FormAction)

フォーム アクションは、この onclick アクションによってトリガーされます（指定されている場合）。

FormAction

フォーム アクションは、フォームが送信されたときの動作を記述します。たとえば、Apps Script を呼び出してフォームを処理できます。

JSON 表現 
{
  "actionMethodName": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ]
}
フィールド
actionMethodName

string

メソッド名は、フォームの送信をトリガーしたフォームの部分を特定するために使用されます。この情報は、カードのクリック イベントの一部として Chat アプリにエコーバックされます。共通の動作をトリガーする複数の要素に同じメソッド名を使用できます。
parameters[]

object (ActionParameter)

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

ActionParameter

アクション メソッドが呼び出されるときに指定する文字列パラメータのリスト。たとえば、3 つのスヌーズ ボタン（今スヌーズ、1 日スヌーズ、来週スヌーズ）があるとします。action method = snooze() を使用して、スヌーズ タイプとスヌーズ時間を文字列パラメータのリストで渡すことができます。

JSON 表現 
{
  "key": string,
  "value": string
}
フィールド
key

string

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

string

パラメータの値。

KeyValue

UI 要素には、キー（ラベル）と値（コンテンツ）が含まれています。この要素には、onclick ボタンなどのアクションも含めることができます。

JSON 表現 
{
  "topLabel": string,
  "content": string,
  "contentMultiline": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  }
  // End of list of possible types for union field control.
}
フィールド
topLabel

string

上部ラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定とGoogle Workspace アドオンでのテキストの書式設定をご覧ください。
content

string

コンテンツのテキスト。書式設定されたテキストがサポートされており、常に必要です。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定とGoogle Workspace アドオンでのテキストの書式設定をご覧ください。
contentMultiline

boolean

コンテンツが複数行である必要があるかどうか。

bottomLabel

string

下部ラベルのテキスト。書式設定されたテキストがサポートされています。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定とGoogle Workspace アドオンでのテキストの書式設定をご覧ください。
onClick

object (OnClick)

onclick アクション。クリックできるのは、上部ラベル、下部ラベル、コンテンツ領域のみです。

共用体フィールド icons。アイコン top_label と bottom_label の少なくとも 1 つを定義する必要があります。icons は次のいずれかになります。
icon

enum (Icon)

Chat API によって対応するアイコン画像に置き換えられる列挙型の値。
iconUrl

string

URL で指定されたアイコン。

共用体フィールド control。コントロール ウィジェット。button または switch_widget のいずれかを設定できますが、両方は設定できません。control は次のいずれかになります。
button

object (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 type can be only one of the following:
  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
  // End of list of possible types for union field type.
}
フィールド

共用体フィールド type。

type は次のいずれかになります。
textButton

object (TextButton)

テキストと onclick アクションを含むボタン。
imageButton

object (ImageButton)

画像と onclick アクションのあるボタン。

TextButton

テキストと onclick アクションを含むボタン。

JSON 表現 
{
  "text": string,
  "onClick": {
    object (OnClick)
  }
}
フィールド
text

string

ボタンのテキスト。

onClick

object (OnClick)

ボタンの onclick アクション。

ImageButton

onclick アクションを含む画像ボタン。

JSON 表現 
{
  "onClick": {
    object (OnClick)
  },
  "name": string,

  // Union field icons can be only one of the following:
  "icon": enum (Icon),
  "iconUrl": string
  // End of list of possible types for union field icons.
}
フィールド
onClick

object (OnClick)

onclick アクション。
name

string

ユーザー補助に使用されるこの imageButton の名前。この名前が指定されていない場合は、デフォルト値が提供されます。
共用体フィールド icons。アイコンは、Icon、enum、または URL で指定できます。icons は次のいずれかになります。
icon

enum (Icon)

Chat API から提供されるアイコンをインデックスする enum で指定されたアイコン。
iconUrl

string

URL で指定されたアイコン。

CardAction

カードアクションは、カードに関連付けられたアクションです。請求書カードの場合、一般的なアクションは、請求書の削除、請求書のメール送信、ブラウザでの請求書の開くなどです。

Google Chat アプリではサポートされていません。

JSON 表現 
{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}
フィールド
actionLabel

string

アクション メニュー項目に表示されていたラベル。

onClick

object (OnClick)

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