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 行を占めます。タイトルのみが指定されている場合は、2 行ともタイトルに使用されます。

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)
    }
  ],

  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "keyValue": {
    object (KeyValue)
  }
}
フィールド
buttons[]

object (Button)

ボタンのリスト。ボタンも oneof data であり、これらのフィールドのうち 1 つだけを設定する必要があります。
WidgetMarkup には、次のいずれかの項目のみを指定できます。複数の WidgetMarkup フィールドを使用して、より多くのアイテムを表示できます。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 表現 
{

  "action": {
    object (FormAction)
  },
  "openLink": {
    object (OpenLink)
  }
}
フィールド
相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
action

object (FormAction)

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

相互に排他的なフィールドの終了。

FormAction

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

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

string

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

parameters[]

object (ActionParameter)

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

ActionParameter

アクション メソッドが呼び出されたときに指定する文字列パラメータのリスト。たとえば、[今すぐスヌーズ]、[1 日スヌーズ]、[来週スヌーズ] の 3 つのスヌーズ ボタンがあるとします。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)
  },

  "icon": enum (Icon),
  "iconUrl": string

  "button": {
    object (Button)
  }
}
フィールド
topLabel

string

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

string

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

boolean

コンテンツを複数行にするかどうか。

bottomLabel

string

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

object (OnClick)

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

アイコン、top_label、bottom_label のうち少なくとも 1 つを定義する必要があります。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
icon

enum (Icon)

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

string

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

相互に排他的なフィールドの終了。
コントロール ウィジェット。button または switch_widget のいずれかを設定できますが、両方は設定できません。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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

ボタン

A ボタン。テキストボタンまたは画像ボタンにすることができます。

JSON 表現 
{

  "textButton": {
    object (TextButton)
  },
  "imageButton": {
    object (ImageButton)
  }
}
フィールド
相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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,

  "icon": enum (Icon),
  "iconUrl": string
}
フィールド
onClick

object (OnClick)

onclick アクション。
name

string

ユーザー補助に使用されるこの imageButton の名前。この名前が指定されていない場合は、デフォルト値が指定されます。
アイコンは、Icon、enum、または URL で指定できます。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
icon

enum (Icon)

Chat API が提供するアイコンを指す enum で指定されたアイコン。
iconUrl

string

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

相互に排他的なフィールドの終了。

CardAction

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

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

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

string

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

onClick

object (OnClick)

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