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

  // 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)

ボタンのリスト。ボタンも oneof data であり、これらのフィールドのうちの 1 つのみを設定する必要があります。

共用体フィールド dataWidgetMarkup に含めることができるアイテムは、次のいずれかのみです。複数の 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

アクション メソッドが呼び出されたときに提供する文字列パラメータのリスト。たとえば、「今すぐスヌーズ」、「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)
  },

  // 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_labelbottom_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)

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