このページは Cloud Translation API によって翻訳されました。

Cards v2

カード

Google Chat メッセージまたは Google Workspace アドオンに表示されるカードインターフェース。

カードは、定義されたレイアウト、ボタンなどのインタラクティブな UI 要素、画像などのリッチメディアをサポートしています。カードを使用して、詳細情報を提示したり、ユーザーから情報を収集したり、ユーザーに次のステップを案内したりします。

カードビルダーでカードを設計してプレビューします。

カードの作成方法については、次のドキュメントをご覧ください。

Google Chat アプリの場合は、カードまたはダイアログのコンポーネントを設計するをご覧ください。
Google Workspace アドオンについては、カードベースのインターフェースをご覧ください。

注: カードごとに最大 100 個のウィジェットを追加できます。この上限を超えるウィジェットは無視されます。この上限は、Google Chat 用アプリのカードメッセージとダイアログ、および Google Workspace アドオンのカードの両方に適用されます。

例: Google Chat アプリのカードメッセージ

連絡先カードの例

Google Chat でサンプルカードメッセージを作成するには、次の JSON を使用します。

{
  "cardsV2": [
    {
      "cardId": "unique-card-id",
      "card": {
        "header": {
           "title": "Sasha",
           "subtitle": "Software Engineer",
           "imageUrl":
           "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
           "imageType": "CIRCLE",
           "imageAltText": "Avatar for Sasha"
         },
         "sections": [
           {
             "header": "Contact Info",
             "collapsible": true,
             "uncollapsibleWidgetsCount": 1,
             "widgets": [
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "EMAIL"
                   },
                   "text": "sasha@example.com"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PERSON"
                   },
                   "text": "<font color=\"#80e27e\">Online</font>"
                 }
               },
               {
                 "decoratedText": {
                   "startIcon": {
                     "knownIcon": "PHONE"
                   },
                   "text": "+1 (555) 555-1234"
                 }
               },
               {
                 "buttonList": {
                   "buttons": [
                     {
                       "text": "Share",
                       "onClick": {
                        "openLink": {
                           "url": "https://example.com/share"
                         }
                       }
                     },
                     {
                       "text": "Edit",
                       "onClick": {
                         "action": {
                           "function": "goToView",
                           "parameters": [
                             {
                               "key": "viewType",
                               "value": "EDIT"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}

JSON 表現

JSON 表現
{ "header": { object (`CardHeader`) }, "sections": [ { object (`Section`) } ], "sectionDividerStyle": enum (`DividerStyle`), "cardActions": [ { object (`CardAction`) } ], "name": string, "fixedFooter": { object (`CardFixedFooter`) }, "displayStyle": enum (`DisplayStyle`), "peekCardHeader": { object (`CardHeader`) } }

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

フィールド
`header`	`object (CardHeader)` カードのヘッダー。ヘッダーには通常、先頭の画像とタイトルが含まれます。ヘッダーは常にカードの上部に表示されます。
`sections[]`	`object (Section)` ウィジェットのコレクションが含まれています。各セクションには、独自のオプションのヘッダーがあります。セクションは、線で区切って表示されます。Google Chat アプリの例については、カードのセクションを定義するをご覧ください。
`sectionDividerStyle`	`enum (DividerStyle)` ヘッダー、セクション、フッター間の区切り線のスタイル。
`cardActions[]`	`object (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" } } } ]`
`name`	`string` カードの名前。カードナビゲーションのカード識別子として使用されます。 Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。
`fixedFooter`	`object (CardFixedFooter)` このカードの下部に表示される固定フッター。 `primaryButton` または `secondaryButton` を指定せずに `fixedFooter` を設定すると、エラーが発生します。Chat 用アプリでは、ダイアログで固定フッターを使用できますが、カードメッセージでは使用できません。 Google Chat 用アプリと Google Workspace アドオンで利用できます。
`displayStyle`	`enum (DisplayStyle)` Google Workspace アドオンで、`peekCardHeader` の表示プロパティを設定します。 Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。
`peekCardHeader`	`object (CardHeader)` コンテキストコンテンツを表示する場合、ピークカードのヘッダーはプレースホルダとして機能し、ユーザーはホームページのカードとコンテキストカードの間を前後に移動できます。 Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。

CardHeader

カードのヘッダーを表します。Google Chat アプリの例については、ヘッダーを追加するをご覧ください。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "title": string, "subtitle": string, "imageType": enum (`ImageType`), "imageUrl": string, "imageAltText": string }

フィールド
`title`	`string` 必須。カードのヘッダーのタイトル。ヘッダーの高さは固定されています。タイトルとサブタイトルの両方が指定されている場合、それぞれ 1 行を占有します。タイトルのみが指定されている場合は、両方の行が使用されます。
`subtitle`	`string` カードヘッダーのサブタイトル。指定すると、`title` の下の行に表示されます。
`imageType`	`enum (ImageType)` 画像の切り抜きに使用する図形。 Google Chat 用アプリと Google Workspace アドオンで利用できます。
`imageUrl`	`string` カードのヘッダーにある画像の HTTPS URL。
`imageAltText`	`string` ユーザー補助機能で使用されるこの画像の代替テキスト。

ImageType

画像の切り抜きに使用する図形。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`SQUARE`	デフォルト値。画像に正方形のマスクを適用します。たとえば、4x3 の画像は 3x3 になります。
`CIRCLE`	画像に円形のマスクを適用します。たとえば、4x3 の画像は直径 3 の円になります。

セクション

セクションには、指定された順序で縦方向にレンダリングされるウィジェットのコレクションが含まれます。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "header": string, "widgets": [ { object (`Widget`) } ], "collapsible": boolean, "uncollapsibleWidgetsCount": integer, "collapseControl": { object (`CollapseControl`) } }

フィールド
`header`	`string` セクションの上部に表示されるテキスト。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
`widgets[]`	`object (Widget)` セクション内のすべてのウィジェット。少なくとも 1 つのウィジェットを含める必要があります。
`collapsible`	`boolean` このセクションが折りたたみ可能かどうかを示します。折りたたみ可能なセクションでは、一部またはすべてのウィジェットが非表示になりますが、ユーザーは [もっと見る] をクリックしてセクションを開き、非表示のウィジェットを表示できます。[表示を減らす] をクリックすると、ウィジェットを再び非表示にできます。非表示にするウィジェットを特定するには、`uncollapsibleWidgetsCount` を指定します。
`uncollapsibleWidgetsCount`	`integer` セクションが折りたたまれても表示されたままになる、折りたたみ不可のウィジェットの数。たとえば、セクションに 5 つのウィジェットが含まれていて、`uncollapsibleWidgetsCount` が `2` に設定されている場合、最初の 2 つのウィジェットは常に表示され、最後の 3 つはデフォルトで折りたたまれます。`uncollapsibleWidgetsCount` は、`collapsible` が `true` の場合にのみ考慮されます。
`collapseControl`	`object (CollapseControl)` 省略可。セクションの展開ボタンと折りたたみボタンを定義します。このボタンは、セクションが折りたたみ可能な場合にのみ表示されます。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。

JSON 表現

JSON 表現
{ "horizontalAlignment": enum (`HorizontalAlignment`), // Union field `data` can be only one of the following: "textParagraph": { object (`TextParagraph`) }, "image": { object (`Image`) }, "decoratedText": { object (`DecoratedText`) }, "buttonList": { object (`ButtonList`) }, "textInput": { object (`TextInput`) }, "selectionInput": { object (`SelectionInput`) }, "dateTimePicker": { object (`DateTimePicker`) }, "divider": { object (`Divider`) }, "grid": { object (`Grid`) }, "columns": { object (`Columns`) }, "carousel": { object (`Carousel`) }, "chipList": { object (`ChipList`) } // End of list of possible types for union field `data`. }

{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "carousel": {
    object (Carousel)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

フィールド
`horizontalAlignment`	`enum (HorizontalAlignment)` ウィジェットを列の左、右、中央のいずれに配置するかを指定します。
共用体フィールド `data`。ウィジェットには、次のいずれか 1 つのみを含めることができます。複数のウィジェットフィールドを使用して、より多くのアイテムを表示できます。`data` は次のいずれかになります。
`textParagraph`	`object (TextParagraph)` テキスト段落を表示します。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。たとえば、次の JSON は太字のテキストを作成します。 `"textParagraph": { "text": " <b>bold text</b>" }`
`image`	`object (Image)` 画像を表示します。たとえば、次の JSON は代替テキストを含む画像を作成します。 `"image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" }`
`decoratedText`	`object (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`	`object (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`	`object (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`	`object (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`	`object (DateTimePicker)` ユーザーが日付、時刻、または日付と時刻を入力できるウィジェットを表示します。たとえば、次の JSON は、予約をスケジュールするための日時選択ツールを作成します。 `"dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": 796435200000 }`
`divider`	`object (Divider)` ウィジェット間に水平線の区切り線を表示します。たとえば、次の JSON は区切り線を作成します。 `"divider": { }`
`grid`	`object (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`	`object (Columns)` 最大 2 列を表示します。 3 つ以上の列を含める場合や、行を使用する場合は、`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" } } ] } ] }`
`carousel`	`object (Carousel)` カルーセルには、ネストされたウィジェットのコレクションが含まれています。たとえば、2 つのテキスト段落を含むカルーセルの JSON 表現は次のようになります。 `{ "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] }`
`chipList`	`object (ChipList)` チップのリスト。たとえば、次の JSON は 2 つのチップを作成します。1 つ目はテキストチップ、2 つ目はリンクを開くアイコンチップです。 `"chipList": { "chips": [ { "text": "Edit", "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] }`

TextParagraph

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

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "text": string, "maxLines": integer, "textSyntax": enum (`TextSyntax`) }

フィールド

フィールド
`text`	`string` ウィジェットに表示されるテキスト。
`maxLines`	`integer` ウィジェットに表示されるテキストの最大行数。テキストが指定された最大行数を超えると、超過したコンテンツは [もっと見る] ボタンの背後に隠されます。テキストが指定された最大行数以下の場合、[もっと見る] ボタンは表示されません。デフォルト値は 0 で、この場合、すべてのコンテキストが表示されます。負の値は無視されます。
`textSyntax`	`enum (TextSyntax)` テキストの構文。設定されていない場合、テキストは HTML としてレンダリングされます。デベロッパープレビュー: Google Workspace デベロッパープレビュープログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。

text

string

ウィジェットに表示されるテキスト。

maxLines

integer

ウィジェットに表示されるテキストの最大行数。テキストが指定された最大行数を超えると、超過したコンテンツは [もっと見る] ボタンの背後に隠されます。テキストが指定された最大行数以下の場合、[もっと見る] ボタンは表示されません。

デフォルト値は 0 で、この場合、すべてのコンテキストが表示されます。負の値は無視されます。

textSyntax

enum (TextSyntax)

テキストの構文。設定されていない場合、テキストは HTML としてレンダリングされます。

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

TextSyntax

テキストの書式設定に使用する構文。

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

列挙型
`TEXT_SYNTAX_UNSPECIFIED`	指定しない場合、テキストは HTML としてレンダリングされます。
`HTML`	テキストは HTML としてレンダリングされます。これがデフォルト値です。
`MARKDOWN`	テキストはマークダウンとしてレンダリングされます。

画像

URL で指定された画像。onClick アクションを設定できます。例については、画像を追加するをご覧ください。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "imageUrl": string, "onClick": { object (`OnClick`) }, "altText": string }

フィールド

フィールド
`imageUrl`	`string` 画像をホストする HTTPS URL。次に例を示します。 `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png`
`onClick`	`object (OnClick)` ユーザーが画像をクリックすると、このアクションがトリガーされます。
`altText`	`string` ユーザー補助機能で使用されるこの画像の代替テキスト。

imageUrl

string

画像をホストする HTTPS URL。

次に例を示します。

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

onClick

object (OnClick)

ユーザーが画像をクリックすると、このアクションがトリガーされます。

altText

string

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

OnClick

ユーザーがカード上のインタラクティブな要素（ボタンなど）をクリックしたときのレスポンス方法を表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現

JSON 表現
{ // Union field `data` can be only one of the following: "action": { object (`Action`) }, "openLink": { object (`OpenLink`) }, "openDynamicLinkAction": { object (`Action`) }, "card": { object (`Card`) }, "overflowMenu": { object (`OverflowMenu`) } // End of list of possible types for union field `data`. }

{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  },
  "overflowMenu": {
    object (OverflowMenu)
  }
  // End of list of possible types for union field data.
}

フィールド
共用体フィールド `data`。 `data` は次のいずれかになります。
`action`	`object (Action)` 指定すると、この `onClick` によってアクションがトリガーされます。
`openLink`	`object (OpenLink)` 指定されている場合、この `onClick` はリンクを開くアクションをトリガーします。
`openDynamicLinkAction`	`object (Action)` アドオンは、リンクを開く必要がある場合にこのアクションをトリガーします。これは、リンクを取得するためにサーバーと通信する必要があるという点で、上記の `openLink` とは異なります。そのため、ウェブクライアントは、リンクを開くアクションのレスポンスが返ってくる前に、準備作業を行う必要があります。 Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。
`card`	`object (Card)` 指定されている場合、クリック後に新しいカードがカードスタックにプッシュされます。 Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。
`overflowMenu`	`object (OverflowMenu)` 指定すると、`onClick` オーバーフローメニューが開きます。

アクション

フォームが送信されたときの動作を記述するアクション。たとえば、Apps Script スクリプトを呼び出してフォームを処理できます。アクションがトリガーされると、フォームの値がサーバーに送信されます。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現

JSON 表現
{ "function": string, "parameters": [ { object (`ActionParameter`) } ], "loadIndicator": enum (`LoadIndicator`), "persistValues": boolean, "interaction": enum (`Interaction`), "requiredWidgets": [ string ], "allWidgetsAreRequired": boolean }

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}

フィールド
`function`	`string` 包含要素がクリックされたとき、またはアクティブになったときに呼び出すカスタム関数。使用例については、フォームデータの読み取りをご覧ください。
`parameters[]`	`object (ActionParameter)` アクションパラメータのリスト。
`loadIndicator`	`enum (LoadIndicator)` アクションを呼び出すときにアクションが表示する読み込みインジケーターを指定します。
`persistValues`	`boolean` アクション後にフォームの値が保持されるかどうかを示します。デフォルト値は `false` です。 `true` の場合、アクションがトリガーされた後もフォームの値は残ります。アクションの処理中にユーザーが変更できるようにするには、`LoadIndicator` を `NONE` に設定します。Chat 用アプリのカードメッセージの場合、アクションの `ResponseType` も `UPDATE_MESSAGE` に設定し、アクションを含むカードと同じ `cardId` を使用する必要があります。 `false` の場合、アクションがトリガーされるとフォームの値がクリアされます。アクションの処理中にユーザーが変更を行わないようにするには、`LoadIndicator` を `SPINNER` に設定します。
`interaction`	`enum (Interaction)` 省略可。ダイアログを開く場合は必須です。ユーザーとのインタラクション（ユーザーがカードメッセージのボタンをクリックするなど）に応答して行う処理。指定しない場合、アプリは通常どおり `action`（リンクを開く、関数を実行するなど）を実行して応答します。 `interaction` を指定することで、アプリは特別なインタラクティブな方法で応答できます。たとえば、`interaction` を `OPEN_DIALOG` に設定すると、アプリはダイアログを開くことができます。指定すると、読み込みインジケーターは表示されません。アドオンで指定されている場合、カード全体が削除され、クライアントに何も表示されません。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。
`requiredWidgets[]`	`string` 省略可。このリストに、有効な送信に必要なウィジェットの名前を入力します。この Action が呼び出されたときに、ここにリストされているウィジェットに値がない場合、フォームの送信は中止されます。 Google Chat 用アプリと Google Workspace アドオンで利用できます。
`allWidgetsAreRequired`	`boolean` 省略可。true の場合、すべてウィジェットがこのアクションで必要と見なされます。 Google Chat 用アプリと Google Workspace アドオンで利用できます。

ActionParameter

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

詳しくは、CommonEventObject をご覧ください。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "key": string, "value": string }

フィールド

フィールド
`key`	`string` アクションスクリプトのパラメータの名前。
`value`	`string` パラメータの値。

key

string

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

value

string

パラメータの値。

LoadIndicator

アクションを呼び出すときにアクションが表示する読み込みインジケーターを指定します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`SPINNER`	コンテンツが読み込まれていることを示すスピナーを表示します。
`NONE`	何も表示されません。

操作

省略可。ダイアログを開く場合は必須です。

ユーザーとのインタラクション（ユーザーがカードメッセージのボタンをクリックするなど）に応答して行う処理。

指定しない場合、アプリは通常どおり action（リンクを開く、関数を実行するなど）を実行して応答します。

interaction を指定することで、アプリは特別なインタラクティブな方法で応答できます。たとえば、interaction を OPEN_DIALOG に設定すると、アプリはダイアログを開くことができます。

指定すると、読み込みインジケーターは表示されません。アドオンで指定されている場合、カード全体が削除され、クライアントに何も表示されません。

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

列挙型

INTERACTION_UNSPECIFIED デフォルト値。action は通常どおり実行されます。

列挙型
`INTERACTION_UNSPECIFIED`	デフォルト値。`action` は通常どおり実行されます。
`OPEN_DIALOG`	ダイアログを開きます。これは、Chat 用アプリがユーザーとのやり取りに使用する、ウィンドウ表示のカードベースのインターフェースです。カードメッセージのボタンクリックに対するレスポンスとして、Chat 用アプリでのみサポートされます。アドオンで指定されている場合、カード全体が削除され、クライアントに何も表示されません。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。

OPEN_DIALOG

ダイアログを開きます。これは、Chat 用アプリがユーザーとのやり取りに使用する、ウィンドウ表示のカードベースのインターフェースです。

カードメッセージのボタンクリックに対するレスポンスとして、Chat 用アプリでのみサポートされます。アドオンで指定されている場合、カード全体が削除され、クライアントに何も表示されません。

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

OpenLink

ハイパーリンクを開く onClick イベントを表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "url": string, "openAs": enum (`OpenAs`), "onClose": enum (`OnClose`) }

フィールド

フィールド
`url`	`string` 開く URL。
`openAs`	`enum (OpenAs)` リンクを開く方法。 Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。
`onClose`	`enum (OnClose)` クライアントがリンクを開いた後にリンクを忘れるか、ウィンドウが閉じるまでリンクを監視するかどうか。 Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。

url

string

開く URL。

openAs

enum (OpenAs)

リンクを開く方法。

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

onClose

enum (OnClose)

クライアントがリンクを開いた後にリンクを忘れるか、ウィンドウが閉じるまでリンクを監視するかどうか。

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

OpenAs

OnClick アクションでリンクを開く場合、クライアントは全画面ウィンドウ（クライアントが使用するフレームの場合）またはオーバーレイ（ポップアップなど）として開くことができます。実装はクライアントプラットフォームの機能に依存し、クライアントがサポートしていない場合、選択した値は無視される可能性があります。FULL_SIZE はすべてのクライアントでサポートされています。

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

列挙型
`FULL_SIZE`	リンクは全画面ウィンドウとして開きます（クライアントで使用されているフレームの場合）。
`OVERLAY`	リンクはポップアップなどのオーバーレイとして開きます。

OnClose

OnClick アクションで開いたリンクが閉じられたときにクライアントが行う処理。

実装はクライアントプラットフォームの機能によって異なります。たとえば、ウェブブラウザは OnClose ハンドラを使用して、ポップアップウィンドウでリンクを開くことがあります。

OnOpen ハンドラと OnClose ハンドラの両方が設定されていて、クライアントプラットフォームが両方の値をサポートできない場合は、OnClose が優先されます。

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

列挙型

NOTHING デフォルト値。カードは再読み込みされず、何も起こりません。

列挙型
`NOTHING`	デフォルト値。カードは再読み込みされず、何も起こりません。
`RELOAD`	子ウィンドウが閉じられた後にカードを再読み込みします。 `OpenAs.OVERLAY` と組み合わせて使用すると、子ウィンドウはモーダルダイアログとして機能し、子ウィンドウが閉じるまで親カードはブロックされます。

RELOAD

子ウィンドウが閉じられた後にカードを再読み込みします。

OpenAs.OVERLAY と組み合わせて使用すると、子ウィンドウはモーダルダイアログとして機能し、子ウィンドウが閉じるまで親カードはブロックされます。

OverflowMenu

ユーザーが呼び出すことができる 1 つ以上のアクションを含むポップアップメニューを表示するウィジェット。たとえば、カードにメイン以外のアクションを表示する場合などです。このウィジェットは、アクションが利用可能なスペースに収まらない場合に使用できます。使用するには、このウィジェットをサポートするウィジェットの OnClick アクションで指定します。たとえば、Button では次のようになります。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "items": [ { object (`OverflowMenuItem`) } ] }

フィールド

フィールド
`items[]`	`object (OverflowMenuItem)` 必須。メニューオプションのリスト。

items[]

object (OverflowMenuItem)

必須。メニューオプションのリスト。

OverflowMenuItem

ユーザーがオーバーフローメニューで呼び出すことができるオプション。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "startIcon": { object (`Icon`) }, "text": string, "onClick": { object (`OnClick`) }, "disabled": boolean }

フィールド
`startIcon`	`object (Icon)` テキストの前に表示されるアイコン。
`text`	`string` 必須。ユーザーにアイテムを識別または説明するテキスト。
`onClick`	`object (OnClick)` 必須。メニューオプションが選択されたときに呼び出されるアクション。この `OnClick` に `OverflowMenu` を含めることはできません。指定された `OverflowMenu` はすべて削除され、メニューアイテムは無効になります。
`disabled`	`boolean` メニューオプションが無効かどうか。デフォルトは false です。

アイコン

カードのウィジェットに表示されるアイコン。Google Chat 用アプリの例については、アイコンを追加するをご覧ください。

組み込みアイコンとカスタムアイコンをサポートします。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現

JSON 表現
{ "altText": string, "imageType": enum (`ImageType`), // Union field `icons` can be only one of the following: "knownIcon": string, "iconUrl": string, "materialIcon": { object (`MaterialIcon`) } // End of list of possible types for union field `icons`. }

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

フィールド
`altText`	`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`	`enum (ImageType)` 画像に適用される切り抜きスタイル。場合によっては、`CIRCLE` のクロップを適用すると、画像が組み込みアイコンよりも大きく描画されます。
共用体フィールド `icons`。カードのウィジェットに表示されるアイコン。`icons` は次のいずれかになります。
`knownIcon`	`string` Google Workspace が提供する組み込みアイコンのいずれかを表示します。たとえば、飛行機のアイコンを表示するには、`AIRPLANE` を指定します。バスの場合は、`BUS` を指定します。サポートされているアイコンの完全なリストについては、組み込みアイコンをご覧ください。
`iconUrl`	`string` HTTPS URL でホストされているカスタムアイコンを表示します。次に例を示します。 `"iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"` サポートされているファイル形式は、`.png` と `.jpg` です。
`materialIcon`	`object (MaterialIcon)` Google マテリアルアイコンのいずれかを表示します。たとえば、チェックボックスアイコンを表示するには、 `"materialIcon": { "name": "check_box" }` Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。

MaterialIcon

2, 500 以上のオプションを含む Google マテリアルアイコン。

たとえば、カスタマイズした重みとグレードでチェックボックスアイコンを表示するには、次のように記述します。

{
  "name": "check_box",
  "fill": true,
  "weight": 300,
  "grade": -25
}

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

JSON 表現
{ "name": string, "fill": boolean, "weight": integer, "grade": integer }

フィールド
`name`	`string` Google マテリアルアイコンで定義されたアイコン名（`check_box` など）。無効な名前は破棄され、空の文字列に置き換えられます。その結果、アイコンのレンダリングが失敗します。
`fill`	`boolean` アイコンが塗りつぶしとしてレンダリングされるかどうか。デフォルト値は false です。さまざまなアイコン設定をプレビューするには、Google Font Icons にアクセスし、[カスタマイズ] で設定を調整します。
`weight`	`integer` アイコンのストロークの太さ。{100, 200, 300, 400, 500, 600, 700} から選択します。指定しない場合、デフォルト値は 400 です。他の値が指定された場合は、デフォルト値が使用されます。さまざまなアイコン設定をプレビューするには、Google Font Icons にアクセスし、[カスタマイズ] で設定を調整します。
`grade`	`integer` ウェイトとグレードは記号の太さに影響します。グレードの調整はウェイトの調整よりもきめ細かく、記号のサイズに与える影響は小さいです。{-25, 0, 200} から選択します。指定しない場合、デフォルト値は 0 です。他の値が指定された場合は、デフォルト値が使用されます。さまざまなアイコン設定をプレビューするには、Google Font Icons にアクセスし、[カスタマイズ] で設定を調整します。

DecoratedText

テキストを表示するウィジェット。テキストの上または下のラベル、テキストの前のアイコン、選択ウィジェット、テキストの後のボタンなどの装飾をオプションで追加できます。Google Chat アプリの例については、装飾テキストでテキストを表示するをご覧ください。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現

JSON 表現
{ "icon": { object (`Icon`) }, "startIcon": { object (`Icon`) }, "startIconVerticalAlignment": enum (`VerticalAlignment`), "topLabel": string, "topLabelText": { object (`TextParagraph`) }, "text": string, "contentText": { object (`TextParagraph`) }, "wrapText": boolean, "bottomLabel": string, "bottomLabelText": { object (`TextParagraph`) }, "onClick": { object (`OnClick`) }, // Union field `control` can be only one of the following: "button": { object (`Button`) }, "switchControl": { object (`SwitchControl`) }, "endIcon": { object (`Icon`) } // End of list of possible types for union field `control`. }

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "startIconVerticalAlignment": enum (VerticalAlignment),
  "topLabel": string,
  "topLabelText": {
    object (TextParagraph)
  },
  "text": string,
  "contentText": {
    object (TextParagraph)
  },
  "wrapText": boolean,
  "bottomLabel": string,
  "bottomLabelText": {
    object (TextParagraph)
  },
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}

フィールド
`icon (deprecated)`	`object (Icon)` この項目は非推奨です。非推奨。`startIcon` を使用してください。
`startIcon`	`object (Icon)` テキストの前に表示されるアイコン。
`startIconVerticalAlignment`	`enum (VerticalAlignment)` 省略可。開始アイコンの垂直方向の配置。設定しない場合、アイコンは垂直方向に中央揃えになります。デベロッパープレビュー: Google Workspace デベロッパープレビュープログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。
`topLabel`	`string` `text` の上に表示されるテキスト。常に切り捨てられます。
`topLabelText`	`object (TextParagraph)` `TextParagraph` は `topLabel` と同等です。常に切り捨てます。`topLabel` よりも複雑な書式設定が可能です。デベロッパープレビュー: Google Workspace デベロッパープレビュープログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。
`text`	`string` 必須。メインのテキスト。簡単な書式設定をサポートします。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
`contentText`	`object (TextParagraph)` `TextParagraph` は `text` と同等です。`text` よりも複雑な書式設定が可能です。デベロッパープレビュー: Google Workspace デベロッパープレビュープログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。
`wrapText`	`boolean` テキストの折り返し設定。`true` の場合、テキストは折り返されて複数行に表示されます。それ以外の場合、テキストは切り捨てられます。 `text` にのみ適用されます。`topLabel` と `bottomLabel` には適用されません。
`bottomLabel`	`string` `text` の下に表示されるテキスト。常に折り返します。
`bottomLabelText`	`object (TextParagraph)` `TextParagraph` は `bottomLabel` と同等です。常に折り返します。`bottomLabel` よりも複雑な書式設定が可能です。デベロッパープレビュー: Google Workspace デベロッパープレビュープログラムの一部として利用できます。このプログラムでは、特定の機能に早期アクセスできます。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。
`onClick`	`object (OnClick)` このアクションは、ユーザーが `topLabel` または `bottomLabel` をクリックしたときにトリガーされます。
共用体フィールド `control`。`decoratedText` ウィジェットのテキストの右側に表示されるボタン、スイッチ、チェックボックス、または画像。`control` は次のいずれかになります。
`button`	`object (Button)` ユーザーがクリックしてアクションをトリガーできるボタン。
`switchControl`	`object (SwitchControl)` ユーザーがクリックして状態を変更し、アクションをトリガーできるスイッチウィジェット。
`endIcon`	`object (Icon)` テキストの後に表示されるアイコン。組み込みアイコンとカスタムアイコンをサポートします。

VerticalAlignment

垂直方向の配置属性を表します。

列挙型
`VERTICAL_ALIGNMENT_UNSPECIFIED`	未指定のタイプ。使用しないでください。
`TOP`	上部に配置します。
`MIDDLE`	中央位置に合わせます。
`BOTTOM`	下部に配置します。

ボタン

ユーザーがクリックできるテキスト、アイコン、またはテキストとアイコンのボタン。Google Chat アプリの例については、ボタンを追加するをご覧ください。

画像をクリックスルーボタンにするには、Image（ImageComponent ではない）を指定し、onClick アクションを設定します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "text": string, "icon": { object (`Icon`) }, "color": { object (`Color`) }, "onClick": { object (`OnClick`) }, "disabled": boolean, "altText": string, "type": enum (`Type`) }

フィールド
`text`	`string` ボタン内に表示されるテキスト。
`icon`	`object (Icon)` ボタン内に表示されるアイコン。`icon` と `text` の両方が設定されている場合は、アイコンがテキストの前に表示されます。
`color`	`object (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`	`object (OnClick)` 必須。ユーザーがボタンをクリックしたときに実行するアクション（ハイパーリンクを開く、カスタム関数を実行するなど）。
`disabled`	`boolean` `true` の場合、ボタンは非アクティブ状態で表示され、ユーザー操作に応答しません。
`altText`	`string` ユーザー補助機能で使用される代替テキスト。ボタンの機能をユーザーに知らせる説明テキストを設定します。たとえば、ボタンがハイパーリンクを開く場合は、「新しいブラウザタブを開き、https://developers.google.com/workspace/chat" の Google Chat デベロッパードキュメントに移動します」と記述します。
`type`	`enum (Type)` 省略可。ボタンのタイプ。設定しない場合、ボタンタイプはデフォルトで `OUTLINED` になります。`color` フィールドが設定されている場合、ボタンのタイプは強制的に `FILLED` になり、このフィールドに設定された値は無視されます。

色

RGBA カラースペースのカラーを表します。この表現は、コンパクトさよりも、さまざまな言語での色表現との変換の容易さを重視して設計されています。たとえば、この表現のフィールドは、Java の java.awt.Color のコンストラクタに簡単に提供できます。また、iOS の UIColor の +colorWithRed:green:blue:alpha メソッドにも簡単に提供できます。さらに、少しの作業で、JavaScript の CSS rgba() 文字列に簡単にフォーマットできます。

このリファレンスページには、RGB 値の解釈に使用する必要がある絶対色空間（sRGB、Adobe RGB、DCI-P3、BT.2020 など）の情報は含まれていません。デフォルトでは、アプリケーションは sRGB 色空間を想定します。

色の等価性を判断する必要がある場合、実装では、特に明記されていない限り、赤、緑、青、アルファのすべての値がそれぞれ最大 1e-5 異なる 2 つの色を等しいものとして扱います。

例（Java）:

 import com.google.type.Color;

 // ...
 public static java.awt.Color fromProto(Color protocolor) {
   float alpha = protocolor.hasAlpha()
       ? protocolor.getAlpha().getValue()
       : 1.0;

   return new java.awt.Color(
       protocolor.getRed(),
       protocolor.getGreen(),
       protocolor.getBlue(),
       alpha);
 }

 public static Color toProto(java.awt.Color color) {
   float red = (float) color.getRed();
   float green = (float) color.getGreen();
   float blue = (float) color.getBlue();
   float denominator = 255.0;
   Color.Builder resultBuilder =
       Color
           .newBuilder()
           .setRed(red / denominator)
           .setGreen(green / denominator)
           .setBlue(blue / denominator);
   int alpha = color.getAlpha();
   if (alpha != 255) {
     result.setAlpha(
         FloatValue
             .newBuilder()
             .setValue(((float) alpha) / denominator)
             .build());
   }
   return resultBuilder.build();
 }
 // ...

例（iOS / Obj-C）:

 // ...
 static UIColor* fromProto(Color* protocolor) {
    float red = [protocolor red];
    float green = [protocolor green];
    float blue = [protocolor blue];
    FloatValue* alpha_wrapper = [protocolor alpha];
    float alpha = 1.0;
    if (alpha_wrapper != nil) {
      alpha = [alpha_wrapper value];
    }
    return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];
 }

 static Color* toProto(UIColor* color) {
     CGFloat red, green, blue, alpha;
     if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {
       return nil;
     }
     Color* result = [[Color alloc] init];
     [result setRed:red];
     [result setGreen:green];
     [result setBlue:blue];
     if (alpha <= 0.9999) {
       [result setAlpha:floatWrapperWithValue(alpha)];
     }
     [result autorelease];
     return result;
}
// ...

例（JavaScript）:

// ...

var protoToCssColor = function(rgb_color) {
   var redFrac = rgb_color.red || 0.0;
   var greenFrac = rgb_color.green || 0.0;
   var blueFrac = rgb_color.blue || 0.0;
   var red = Math.floor(redFrac * 255);
   var green = Math.floor(greenFrac * 255);
   var blue = Math.floor(blueFrac * 255);

   if (!('alpha' in rgb_color)) {
      return rgbToCssColor(red, green, blue);
   }

   var alphaFrac = rgb_color.alpha.value || 0.0;
   var rgbParams = [red, green, blue].join(',');
   return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');
};

var rgbToCssColor = function(red, green, blue) {
  var rgbNumber = new Number((red << 16) | (green << 8) | blue);
  var hexString = rgbNumber.toString(16);
  var missingZeros = 6 - hexString.length;
  var resultBuilder = ['#'];
  for (var i = 0; i < missingZeros; i++) {
     resultBuilder.push('0');
  }
  resultBuilder.push(hexString);
  return resultBuilder.join('');
};

// ...

JSON 表現
{ "red": number, "green": number, "blue": number, "alpha": number }

フィールド
`red`	`number` カラーの赤色の量。[0, 1] の範囲内の値として示されます。
`green`	`number` カラーの緑色の量。[0, 1] の範囲内の値として示されます。
`blue`	`number` カラーの青色の量。[0, 1] の範囲内の値として示されます。
`alpha`	`number` ピクセルに適用する必要があるこのカラーの割合。つまり、最終的なピクセルカラーは次の式で定義されます。 `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` つまり、値 1.0 はソリッドカラーに相当し、値 0.0 は透明色に相当します。これは、単純な浮動小数点スカラーではなくラッパーメッセージを使用します。これにより、デフォルト値が設定されたのか未設定値だったのかを区別できます。省略された場合、このカラーオブジェクトは（alpha 値として明示的に値 1.0 が指定された場合と同様に）ソリッドカラーとしてレンダリングされます。

タイプ

省略可。ボタンのタイプ。color フィールドが設定されている場合、type は強制的に FILLED になります。

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

列挙型
`TYPE_UNSPECIFIED`	使用しないでください。指定なし。
`OUTLINED`	アウトラインボタンは中強調ボタンです。通常、Chat 用アプリやアドオンのメインアクションではないものの、重要なアクションが含まれます。
`FILLED`	塗りつぶしボタンには、単色のコンテナがあります。視覚的なインパクトが最も大きく、Chat 用アプリやアドオンの重要なプライマリアクションにおすすめです。
`FILLED_TONAL`	塗りつぶしトーンボタンは、塗りつぶしボタンとアウトラインボタンの中間的な選択肢です。優先度の低いボタンをアウトラインボタンよりも少し強調する必要があるコンテキストで役立ちます。
`BORDERLESS`	ボタンのデフォルト状態に非表示のコンテナはありません。優先度の低いアクション（特に複数のオプションを表示する場合）によく使用されます。

SwitchControl

decoratedText ウィジェット内の切り替えスタイルのスイッチまたはチェックボックス。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

decoratedText ウィジェットでのみサポートされています。

JSON 表現
{ "name": string, "value": string, "selected": boolean, "onChangeAction": { object (`Action`) }, "controlType": enum (`ControlType`) }

フィールド
`name`	`string` フォーム入力イベントでスイッチウィジェットを識別する名前。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
`value`	`string` ユーザーが入力した値。フォーム入力イベントの一部として返されます。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
`selected`	`boolean` `true` の場合、スイッチが選択されます。
`onChangeAction`	`object (Action)` スイッチの状態が変更されたときに実行するアクション（実行する関数など）。
`controlType`	`enum (ControlType)` ユーザーインターフェースでの切り替えの表示方法。 Google Chat 用アプリと Google Workspace アドオンで利用できます。

ControlType

ユーザーインターフェースでの切り替えの表示方法。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`SWITCH`	切り替えスタイルのスイッチ。
`CHECKBOX`	非推奨。`CHECK_BOX` を使用してください。
`CHECK_BOX`	チェックボックス。

ButtonList

ボタンが横に並んだリスト。Google Chat アプリの例については、ボタンを追加するをご覧ください。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

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

フィールド

フィールド
`buttons[]`	`object (Button)` ボタンの配列。

buttons[]

object (Button)

ボタンの配列。

TextInput

ユーザーがテキストを入力できるフィールド。提案と変更時のアクションをサポートします。フォーム送信の検証をサポートします。Action.all_widgets_are_required が true に設定されている場合、またはこのウィジェットが Action.required_widgets で指定されている場合、値が入力されない限り送信アクションはブロックされます。Google Chat 用アプリの例については、ユーザーがテキストを入力できるフィールドを追加するをご覧ください。

Chat 用アプリは、フォーム入力イベント中に、入力されたテキストの値を受信して処理できます。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

ユーザーから未定義のデータや抽象的なデータを収集する必要がある場合は、テキスト入力を使用します。ユーザーから定義済みまたは列挙型のデータを収集するには、SelectionInput ウィジェットを使用します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現

JSON 表現
{ "name": string, "label": string, "hintText": string, "value": string, "type": enum (`Type`), "onChangeAction": { object (`Action`) }, "initialSuggestions": { object (`Suggestions`) }, "autoCompleteAction": { object (`Action`) }, "validation": { object (`Validation`) }, "placeholderText": string }

{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string
}

フィールド
`name`	`string` フォーム入力イベントでテキスト入力が識別される名前。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
`label`	`string` ユーザーインターフェースのテキスト入力フィールドの上に表示されるテキスト。アプリに必要な情報をユーザーが入力するのに役立つテキストを指定します。たとえば、名前を尋ねるが、特に姓が必要な場合は、`name` ではなく `surname` と記述します。 `hintText` が指定されていない場合は必須。それ以外の場合は省略可能です。
`hintText`	`string` テキスト入力フィールドの下に表示されるテキスト。ユーザーが特定の値を入力するよう促すことで、ユーザーをサポートすることを目的としています。このテキストは常に表示されます。 `label` が指定されていない場合は必須。それ以外の場合は省略可能です。
`value`	`string` ユーザーが入力した値。フォーム入力イベントの一部として返されます。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
`type`	`enum (Type)` ユーザーインターフェースでのテキスト入力フィールドの表示方法。たとえば、フィールドが単一行か複数行かなどです。
`onChangeAction`	`object (Action)` テキスト入力フィールドで変更が発生した場合の処理。たとえば、ユーザーがフィールドにテキストを追加したり、テキストを削除したりする場合です。実行するアクションの例としては、カスタム関数を実行する、Google Chat でダイアログを開くなどがあります。
`initialSuggestions`	`object (Suggestions)` ユーザーが入力できる候補値。これらの値は、ユーザーがテキスト入力フィールド内をクリックすると表示されます。ユーザーが入力すると、入力内容に合わせて候補値が動的にフィルタされます。たとえば、プログラミング言語のテキスト入力フィールドでは、Java、JavaScript、Python、C++ が候補として表示されることがあります。ユーザーが `Jav` と入力し始めると、候補のリストがフィルタされ、`Java` と `JavaScript` のみが表示されます。候補値は、アプリが理解できる値をユーザーが入力できるようにするためのものです。JavaScript を参照する場合、ユーザーによっては `javascript` と入力し、別のユーザーは `java script` と入力することがあります。`JavaScript` を提案することで、ユーザーがアプリを操作する方法を標準化できます。指定した場合、`TextInput.type` が `MULTIPLE_LINE` に設定されていても、常に `SINGLE_LINE` になります。 Google Chat 用アプリと Google Workspace アドオンで利用できます。
`autoCompleteAction`	`object (Action)` 省略可。テキスト入力フィールドで、ユーザーが操作したときに候補を表示するアクションを指定します。指定しない場合、候補は `initialSuggestions` によって設定され、クライアントによって処理されます。指定されている場合、アプリはここで指定されたアクション（カスタム関数の実行など）を実行します。 Google Workspace アドオンでは利用できますが、Google Chat アプリでは利用できません。
`validation`	`object (Validation)` このテキストフィールドに必要な入力形式の検証を指定します。 Google Chat 用アプリと Google Workspace アドオンで利用できます。
`placeholderText`	`string` フィールドが空の場合にテキスト入力フィールドに表示されるテキスト。このテキストを使用して、ユーザーに値を入力するよう促します。例: `Enter a number from 0 to 100`。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。

タイプ

ユーザーインターフェースでのテキスト入力フィールドの表示方法。たとえば、1 行の入力フィールドか、複数行の入力かなどです。initialSuggestions が指定されている場合、type は MULTIPLE_LINE に設定されていても、常に SINGLE_LINE になります。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`SINGLE_LINE`	テキスト入力フィールドの高さは 1 行に固定されています。
`MULTIPLE_LINE`	テキスト入力フィールドの高さは複数行に固定されています。

RenderActions

カードにアクションの実行を指示したり、アドオンホストアプリまたは Chat 用アプリにアプリ固有のアクションの実行を指示したりする一連のレンダリング手順。

Google Chat アプリと Google Workspace アドオンで利用できます。

フィールド
`action`	`Action`

アクション

フィールド

navigations[]

Navigation

カードをプッシュ、ポップ、更新します。

Google Chat のアドオン。

スタックに新しいカードを追加します（前に移動）。Chat 用アプリの場合、アプリのホームでのみ使用できます。

Google Chat アプリと Google Workspace アドオンで利用できます。

navigations: {
  pushCard: CARD
}

一番上のカードを新しいカードに置き換えます。Chat 用アプリの場合、アプリのホームでのみ使用できます。

Google Chat アプリと Google Workspace アドオンで利用できます。

navigations: {
  updateCard: CARD
}

フィールド

共用体フィールド navigate_action。

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

pushCard

Card

カードをカードスタックにプッシュします。

Google Chat のダイアログの場合、ダイアログを開くか更新します。

updateCard

Card

一番上のカードを新しいカードで更新し、入力済みのフォームフィールドの値を保持します。同等のフィールドでない場合、値は削除されます。

Google Chat のダイアログの場合、ダイアログを開くか更新します。

候補

ユーザーが入力できる候補値。これらの値は、ユーザーがテキスト入力フィールド内をクリックすると表示されます。ユーザーが入力すると、入力内容に合わせて候補値が動的にフィルタされます。

たとえば、プログラミング言語のテキスト入力フィールドでは、Java、JavaScript、Python、C++ が候補として表示されることがあります。ユーザーが Jav と入力し始めると、候補のリストがフィルタされ、Java と JavaScript が表示されます。

候補値は、アプリが理解できる値をユーザーが入力できるようにするためのものです。JavaScript を参照する場合、javascript と入力するユーザーもいれば、java script と入力するユーザーもいます。JavaScript を提案することで、ユーザーがアプリを操作する方法を標準化できます。

指定した場合、TextInput.type は MULTIPLE_LINE に設定されていても常に SINGLE_LINE になります。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "items": [ { object (`SuggestionItem`) } ] }

フィールド

items[]

object (SuggestionItem)

テキスト入力フィールドの予測入力候補に使用される候補のリスト。

SuggestionItem

ユーザーがテキスト入力フィールドに入力できる候補値の 1 つ。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ // Union field `content` can be only one of the following: "text": string // End of list of possible types for union field `content`. }

フィールド

共用体フィールド content。

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

text

string

テキスト入力フィールドへの入力候補の値。これは、ユーザーが自分で入力する内容と同じです。

検証

アタッチされているウィジェットを検証するために必要なデータを表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "characterLimit": integer, "inputType": enum (`InputType`) }

フィールド

characterLimit

integer

テキスト入力ウィジェットの文字数制限を指定します。これはテキスト入力にのみ使用され、他のウィジェットでは無視されます。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

inputType

enum (InputType)

入力ウィジェットのタイプを指定します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

InputType

入力ウィジェットのタイプ。

列挙型
`INPUT_TYPE_UNSPECIFIED`	未指定のタイプ。使用しないでください。
`TEXT`	すべての文字を受け入れる通常のテキスト。
`INTEGER`	整数値。
`FLOAT`	浮動小数点数値。
`EMAIL`	メールアドレス。
`EMOJI_PICKER`	システム提供の絵文字選択ツールから選択された絵文字。

SelectionInput

ユーザーが選択できる 1 つ以上の UI アイテムを作成するウィジェット。dropdown メニューと multiselect メニューのフォーム送信検証のみをサポートします。Action.all_widgets_are_required が true に設定されている場合、またはこのウィジェットが Action.required_widgets で指定されている場合、値が選択されていないと送信アクションはブロックされます。たとえば、プルダウンメニューやチェックボックスなどです。このウィジェットを使用すると、予測または列挙可能なデータを収集できます。Google Chat アプリの例については、選択可能な UI 要素を追加するをご覧ください。

Chat 用アプリは、ユーザーが選択または入力したアイテムの値を処理できます。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

ユーザーから未定義または抽象的なデータを収集するには、TextInput ウィジェットを使用します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}

フィールド
`name`	`string` 必須。フォーム入力イベントで選択入力を識別する名前。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
`label`	`string` ユーザーインターフェースの選択入力フィールドの上に表示されるテキスト。アプリに必要な情報をユーザーが入力するのに役立つテキストを指定します。たとえば、ユーザーがプルダウンメニューから作業チケットの緊急度を選択する場合、ラベルは「緊急度」または「緊急度を選択」になります。
`type`	`enum (SelectionType)` `SelectionInput` ウィジェットでユーザーに表示されるアイテムのタイプ。選択タイプは、さまざまなタイプのインタラクションをサポートしています。たとえば、ユーザーは 1 つ以上のチェックボックスを選択できますが、プルダウンメニューから選択できる値は 1 つだけです。
`items[]`	`object (SelectionItem)` 選択可能なアイテムの配列。たとえば、ラジオボタンやチェックボックスの配列などです。最大 100 個のアイテムをサポートします。
`onChangeAction`	`object (Action)` 指定されている場合、選択が変更されるとフォームが送信されます。指定しない場合は、フォームを送信する別のボタンを指定する必要があります。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
`multiSelectMaxSelectedItems`	`integer` 複数選択メニューの場合、ユーザーが選択できるアイテムの最大数。最小値は 1 個です。指定しない場合、デフォルトは 3 個のアイテムです。
`multiSelectMinQueryLength`	`integer` 複数選択メニューの場合、メニューが候補の選択項目を返すまでにユーザーが入力するテキスト文字の数。設定されていない場合、マルチセレクトメニューでは次のデフォルト値が使用されます。メニューで `SelectionInput` アイテムの静的配列を使用している場合、デフォルトは 0 文字で、配列からアイテムがすぐに設定されます。メニューで動的データソース（`multi_select_data_source`）を使用している場合、データソースにクエリを実行して候補アイテムを返す前に、デフォルトで 3 文字が入力されます。
共用体フィールド `multi_select_data_source`。複数選択メニューの場合、選択項目を動的に入力するデータソース。 Google Chat アプリでは使用できますが、Google Workspace アドオンでは使用できません。`multi_select_data_source` は次のいずれかになります。
`externalDataSource`	`object (Action)` リレーショナルデータベースなどの外部データソース。
`platformDataSource`	`object (PlatformDataSource)` Google Workspace のデータソース。

SelectionType

ユーザーが選択できるアイテムの形式。オプションによって、サポートされるインタラクションの種類が異なります。たとえば、ユーザーは複数のチェックボックスを選択できますが、プルダウンメニューから選択できるのは 1 つの項目のみです。

各選択入力は 1 種類の選択をサポートします。たとえば、チェックボックスとスイッチを混在させることはできません。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`CHECK_BOX`	チェックボックスのセット。ユーザーは 1 つ以上のチェックボックスを選択できます。
`RADIO_BUTTON`	ラジオボタンのセット。ユーザーは 1 つのラジオボタンを選択できます。
`SWITCH`	スイッチのセット。ユーザーは 1 つ以上のスイッチをオンにできます。
`DROPDOWN`	プルダウンメニュー。ユーザーはメニューから 1 つの項目を選択できます。
`MULTI_SELECT`	テキストボックスを含むメニュー。ユーザーは 1 つ以上の項目を入力して選択できます。Google Workspace アドオンの場合、`SelectionItem` オブジェクトの静的配列を使用して項目を入力する必要があります。 Google Chat 用アプリでは、動的データソースを使用して項目を入力したり、ユーザーがメニューに入力する際に項目を自動提案したりすることもできます。たとえば、ユーザーが Google Chat スペースの名前の入力を開始すると、ウィジェットがスペースを自動的に提案します。マルチセレクトメニューの項目を動的に入力するには、次のいずれかのタイプのデータソースを使用します。 Google Workspace データ: Google Workspace のユーザーや Google Chat スペースなどの Google Workspace のデータを使用して項目が入力されます。外部データ: アイテムは Google Workspace の外部にある外部データソースから入力されます。 Chat 用アプリの複数選択メニューを実装する方法の例については、複数選択メニューを追加するをご覧ください。 Google Chat 用アプリと Google Workspace アドオンで利用できます。

SelectionItem

チェックボックスやスイッチなど、選択入力でユーザーが選択できるアイテム。最大 100 個のアイテムをサポートします。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現

{
  "text": string,
  "value": string,
  "selected": boolean,
  "bottomText": string,

  // Union field start_icon can be only one of the following:
  "startIconUri": string
  // End of list of possible types for union field start_icon.
}

フィールド
`text`	`string` ユーザーにアイテムを識別または説明するテキスト。
`value`	`string` このアイテムに関連付けられた値。クライアントはこれをフォーム入力値として使用する必要があります。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
`selected`	`boolean` アイテムがデフォルトで選択されているかどうか。選択入力で 1 つの値のみが許可される場合（ラジオボタンやプルダウンメニューなど）、このフィールドは 1 つの項目に対してのみ設定します。
`bottomText`	`string` 複数選択メニューの場合、項目の `text` フィールドの下に表示されるテキストの説明またはラベル。
共用体フィールド `start_icon`。複数選択メニューの場合、アイテムの `text` フィールドの横に表示されるアイコンの URL。PNG ファイルと JPEG ファイルをサポートしています。`HTTPS` URL である必要があります。次に例を示します。 `https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png` `start_icon` は次のいずれかになります。
`startIconUri`	`string`

PlatformDataSource

マルチセレクトメニューを使用する SelectionInput ウィジェットの場合、Google Workspace のデータソース。マルチセレクトメニューの項目を入力するために使用されます。

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

JSON 表現

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

フィールド

共用体フィールド data_source。データソース。data_source は次のいずれかになります。

commonDataSource

enum (CommonDataSource)

Google Workspace 組織のユーザーなど、すべての Google Workspace アプリケーションで共有されるデータソース。

hostAppDataSource

object (HostAppDataSourceMarkup)

Google Workspace ホストアプリ（Google Chat のスペースなど）に固有のデータソース。

このフィールドは Google API クライアントライブラリをサポートしていますが、Cloud クライアントライブラリでは使用できません。詳細については、クライアントライブラリをインストールするをご覧ください。

CommonDataSource

すべての Google Workspace アプリケーションで共有されるデータソース。

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

列挙型
`UNKNOWN`	デフォルト値。使用しないでください。
`USER`	Google Workspace ユーザー。ユーザーは、自分の Google Workspace 組織のユーザーのみを表示して選択できます。

HostAppDataSourceMarkup

マルチセレクトメニューを使用する SelectionInput ウィジェットの場合、Google Workspace アプリケーションのデータソース。データソースは、複数選択メニューの選択項目を設定します。

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

JSON 表現
{ // Union field `data_source` can be only one of the following: "chatDataSource": { object (`ChatClientDataSourceMarkup`) } // End of list of possible types for union field `data_source`. }

フィールド

共用体フィールド data_source。複数選択メニューの項目を設定する Google Workspace アプリケーション。data_source は次のいずれかになります。

chatDataSource

object (ChatClientDataSourceMarkup)

Google Chat のデータソース。

ChatClientDataSourceMarkup

マルチセレクトメニューを使用する SelectionInput ウィジェットの場合、Google Chat のデータソース。データソースは、複数選択メニューの選択項目を設定します。たとえば、ユーザーは自分がメンバーになっている Google Chat スペースを選択できます。

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

JSON 表現
{ // Union field `source` can be only one of the following: "spaceDataSource": { object (`SpaceDataSource`) } // End of list of possible types for union field `source`. }

フィールド

共用体フィールド source。Google Chat データソース。source は次のいずれかになります。

spaceDataSource

object (SpaceDataSource)

ユーザーがメンバーになっている Google Chat スペース。

SpaceDataSource

Google Chat スペースをマルチセレクトメニューの選択項目として入力するデータソース。ユーザーがメンバーであるスペースのみが入力されます。

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

JSON 表現
{ "defaultToCurrentSpace": boolean }

フィールド

defaultToCurrentSpace

boolean

true に設定されている場合、マルチ選択メニューでは、現在の Google Chat スペースがデフォルトで項目として選択されます。

DateTimePicker

ユーザーが日付、時刻、または日付と時刻の両方を入力できるようにします。フォーム送信の検証をサポートします。Action.all_widgets_are_required が true に設定されている場合、またはこのウィジェットが Action.required_widgets で指定されている場合、値が選択されていないと送信アクションはブロックされます。Google Chat 用アプリの例については、ユーザーが日時を選択できるようにするをご覧ください。

ユーザーはテキストを入力したり、選択ツールを使用して日付と時刻を選択したりできます。ユーザーが無効な日付や時刻を入力すると、ピッカーにエラーが表示され、正しい情報を入力するよう促されます。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "name": string, "label": string, "type": enum (`DateTimePickerType`), "valueMsEpoch": int64, "timezoneOffsetDate": integer, "onChangeAction": { object (`Action`) } }

フィールド
`name`	`string` フォーム入力イベントで `DateTimePicker` を識別する名前。フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。
`label`	`string` ユーザーに日付、時刻、または日時を入力するよう促すテキスト。たとえば、ユーザーが予約をスケジュールしている場合は、`Appointment date` や `Appointment date and time` などのラベルを使用します。
`type`	`enum (DateTimePickerType)` ウィジェットが日付、時刻、または日付と時刻の入力をサポートしているかどうか。
`valueMsEpoch`	`int64` ウィジェットに表示されるデフォルト値。Unix エポック時刻からの経過時間（ミリ秒単位）。ピッカーのタイプ（`DateTimePickerType`）に基づいて値を指定します。 `DATE_AND_TIME` : UTC のカレンダーの日付と時刻。たとえば、2023 年 1 月 1 日午後 12 時（UTC）を表すには、`1672574400000` を使用します。 `DATE_ONLY` : 00:00:00 UTC のカレンダーの日付。たとえば、2023 年 1 月 1 日を表すには、`1672531200000` を使用します。 `TIME_ONLY` : UTC の時刻。たとえば、午後 12 時を表すには、`43200000`（または `12 * 60 * 60 * 1000`）を使用します。
`timezoneOffsetDate`	`integer` UTC からのタイムゾーンオフセット（分単位）を表す数値。設定されている場合、`valueMsEpoch` は指定されたタイムゾーンで表示されます。設定されていない場合、値はユーザーのタイムゾーン設定にデフォルト設定されます。
`onChangeAction`	`object (Action)` ユーザーが `DateTimePicker` インターフェースで [保存] または [クリア] をクリックするとトリガーされます。

DateTimePickerType

DateTimePicker ウィジェットの日付と時刻の形式。ユーザーが日付、時刻、または日付と時刻の両方を入力できるかどうかを決定します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`DATE_AND_TIME`	ユーザーが日時を入力します。
`DATE_ONLY`	ユーザーが日付を入力します。
`TIME_ONLY`	ユーザーが時間を入力します。

Divider

この型にはフィールドがありません。

ウィジェット間の区切りを水平線として表示します。Google Chat アプリの例については、ウィジェット間に水平区切り線を追加するをご覧ください。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

たとえば、次の JSON は区切り線を作成します。

"divider": {}

グリッド

アイテムのコレクションを含むグリッドを表示します。項目にはテキストまたは画像のみを含めることができます。レスポンシブな列の場合や、テキストや画像以外のものを含める場合は、Columns を使用します。Google Chat アプリの例については、アイテムのコレクションを含むグリッドを表示するをご覧ください。

グリッドは任意の数の列とアイテムをサポートします。行数は、アイテム数を列数で割った値で決まります。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"
    }
  }
}

JSON 表現
{ "title": string, "items": [ { object (`GridItem`) } ], "borderStyle": { object (`BorderStyle`) }, "columnCount": integer, "onClick": { object (`OnClick`) } }

フィールド
`title`	`string` グリッドのヘッダーに表示されるテキスト。
`items[]`	`object (GridItem)` グリッドに表示するアイテム。
`borderStyle`	`object (BorderStyle)` 各グリッドアイテムに適用する枠線のスタイル。
`columnCount`	`integer` グリッドに表示する列の数。このフィールドが指定されていない場合はデフォルト値が使用されます。このデフォルト値は、グリッドが表示される場所（ダイアログとコンパニオン）によって異なります。
`onClick`	`object (OnClick)` このコールバックは個々のグリッドアイテムによって再利用されますが、コールバックのパラメータにはアイテムの識別子とアイテムリスト内のインデックスが追加されます。

GridItem

グリッドレイアウト内のアイテムを表します。項目には、テキスト、画像、またはテキストと画像の両方を含めることができます。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "id": string, "image": { object (`ImageComponent`) }, "title": string, "subtitle": string, "layout": enum (`GridItemLayout`) }

フィールド
`id`	`string` このグリッドアイテムのユーザー指定の識別子。この識別子は、親グリッドの `onClick` コールバックパラメータで返されます。
`image`	`object (ImageComponent)` グリッドアイテムに表示される画像。
`title`	`string` グリッドアイテムのタイトル。
`subtitle`	`string` グリッドアイテムのサブタイトル。
`layout`	`enum (GridItemLayout)` グリッドアイテムに使用するレイアウト。

ImageComponent

画像を表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "imageUri": string, "altText": string, "cropStyle": { object (`ImageCropStyle`) }, "borderStyle": { object (`BorderStyle`) } }

フィールド
`imageUri`	`string` 画像の URL。
`altText`	`string` 画像のユーザー補助ラベル。
`cropStyle`	`object (ImageCropStyle)` 画像に適用する切り抜きスタイル。
`borderStyle`	`object (BorderStyle)` 画像に適用するボーダースタイル。

ImageCropStyle

画像に適用される切り抜きスタイルを表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

たとえば、16:9 のアスペクト比を適用する方法は次のとおりです。

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

JSON 表現
{ "type": enum (`ImageCropType`), "aspectRatio": number }

フィールド

type

enum (ImageCropType)

切り抜きタイプ。

aspectRatio

number

クロップタイプが RECTANGLE_CUSTOM の場合に使用するアスペクト比。

たとえば、16:9 のアスペクト比を適用する方法は次のとおりです。

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

ImageCropType

画像に適用される切り抜きスタイルを表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`IMAGE_CROP_TYPE_UNSPECIFIED`	使用しないでください。指定なし。
`SQUARE`	デフォルト値。正方形の切り抜きを適用します。
`CIRCLE`	円形の切り抜きを適用します。
`RECTANGLE_CUSTOM`	カスタムアスペクト比で長方形の切り抜きを適用します。`aspectRatio` を使用してカスタムアスペクト比を設定します。
`RECTANGLE_4_3`	アスペクト比 4:3 の長方形の切り抜きを適用します。

BorderStyle

カードまたはウィジェットの枠線のスタイルオプション（枠線の種類や色など）。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "type": enum (`BorderType`), "strokeColor": { object (`Color`) }, "cornerRadius": integer }

フィールド

type

enum (BorderType)

枠線の種類。

strokeColor

object (Color)

タイプが BORDER_TYPE_STROKE のときに使用する色。

ストロークの色を設定するには、red、green、blue の各フィールドに値を指定します。値は RGB カラー値に基づく 0 ～ 1 の浮動小数点数でなければなりません。0（0/255）は色がないことを表し、1（255/255）は色の最大強度を表します。

たとえば、次の例では、最大強度で色を赤に設定します。

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

ストロークの色には alpha フィールドを使用できません。指定した場合、このフィールドは無視されます。

cornerRadius

integer

枠線の角の半径。

BorderType

ウィジェットに適用される枠線の種類を表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`BORDER_TYPE_UNSPECIFIED`	使用しないでください。指定なし。
`NO_BORDER`	枠線なし。
`STROKE`	デフォルト値。アウトライン。

GridItemLayout

グリッドアイテムで使用できるさまざまなレイアウトオプションを表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`GRID_ITEM_LAYOUT_UNSPECIFIED`	使用しないでください。指定なし。
`TEXT_BELOW`	タイトルとサブタイトルは、グリッドアイテムの画像の下に表示されます。
`TEXT_ABOVE`	タイトルとサブタイトルは、グリッドアイテムの画像の上に表示されます。

Columns

Columns ウィジェットは、カードまたはダイアログに最大 2 列を表示します。各列にウィジェットを追加できます。ウィジェットは指定された順序で表示されます。Google Chat アプリの例については、カードとダイアログを列に表示するをご覧ください。

各列の高さは、高い方の列によって決まります。たとえば、1 列目が 2 列目よりも高い場合、両方の列の高さは 1 列目の高さになります。各列に異なる数のウィジェットを含めることができるため、行を定義したり、列間でウィジェットを配置したりすることはできません。

列が並べて表示されます。HorizontalSizeStyle フィールドを使用して、各列の幅をカスタマイズできます。ユーザーの画面幅が狭すぎると、2 列目が 1 列目の下に折り返されます。

ウェブでは、画面の幅が 480 ピクセル以下の場合、2 列目が折り返されます。
iOS デバイスでは、画面の幅が 300 pt 以下の場合、2 列目が折り返されます。
Android デバイスでは、画面の幅が 320 dp 以下の場合、2 列目が折り返されます。

3 つ以上の列を含める場合や、行を使用する場合は、Grid ウィジェットを使用します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。列をサポートするアドオン UI は次のとおりです。

ユーザーがメールの下書きからアドオンを開いたときに表示されるダイアログ。
ユーザーが Google カレンダーの予定の [添付ファイルを追加] メニューからアドオンを開いたときに表示されるダイアログ。

JSON 表現
{ "columnItems": [ { object (`Column`) } ] }

フィールド

columnItems[]

object (Column)

列の配列。カードまたはダイアログには最大 2 列を含めることができます。

Column

列。

Google Workspace アドオンと Chat 用アプリ

JSON 表現
{ "horizontalSizeStyle": enum (`HorizontalSizeStyle`), "horizontalAlignment": enum (`HorizontalAlignment`), "verticalAlignment": enum (`VerticalAlignment`), "widgets": [ { object (`Widgets`) } ] }

フィールド
`horizontalSizeStyle`	`enum (HorizontalSizeStyle)` 列がカードの幅をどのように埋めるかを指定します。
`horizontalAlignment`	`enum (HorizontalAlignment)` ウィジェットを列の左、右、中央のいずれに配置するかを指定します。
`verticalAlignment`	`enum (VerticalAlignment)` ウィジェットを列の上、下、中央のいずれに配置するかを指定します。
`widgets[]`	`object (Widgets)` 列に含まれるウィジェットの配列。ウィジェットは指定された順序で表示されます。

HorizontalSizeStyle

列がカードの幅を埋める方法を指定します。各列の幅は、HorizontalSizeStyle と列内のウィジェットの幅の両方に依存します。

Google Workspace アドオンと Chat 用アプリ

列挙型
`HORIZONTAL_SIZE_STYLE_UNSPECIFIED`	使用しないでください。指定なし。
`FILL_AVAILABLE_SPACE`	デフォルト値。列は、カードの幅の 70% まで、利用可能なスペースを埋めます。両方の列が `FILL_AVAILABLE_SPACE` に設定されている場合、各列はスペースの 50% を占めます。
`FILL_MINIMUM_SPACE`	列は、可能な限り最小のスペースを埋め、カードの幅の 30% を超えません。

HorizontalAlignment

ウィジェットを列の左、右、中央のいずれに配置するかを指定します。

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

列挙型
`HORIZONTAL_ALIGNMENT_UNSPECIFIED`	使用しないでください。指定なし。
`START`	デフォルト値。ウィジェットを列の開始位置に配置します。左から右のレイアウトの場合、左に揃えます。右から左のレイアウトの場合、右に揃えます。
`CENTER`	ウィジェットを列の中央に配置します。
`END`	ウィジェットを列の末尾に配置します。左から右のレイアウトの場合、ウィジェットを右に配置します。右から左のレイアウトの場合、ウィジェットを左に配置します。

VerticalAlignment

ウィジェットを列の上、下、中央のいずれに配置するかを指定します。

Google Workspace アドオンと Chat 用アプリ

列挙型
`VERTICAL_ALIGNMENT_UNSPECIFIED`	使用しないでください。指定なし。
`CENTER`	デフォルト値。ウィジェットを列の中央に配置します。
`TOP`	ウィジェットを列の上部に配置します。
`BOTTOM`	ウィジェットを列の下部に配置します。

ウィジェット

列に含めることができるサポートされているウィジェット。

Google Workspace アドオンと Chat 用アプリ

JSON 表現

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

フィールド
共用体フィールド `data`。 `data` は次のいずれかになります。
`textParagraph`	`object (TextParagraph)` `TextParagraph` ウィジェット。
`image`	`object (Image)` `Image` ウィジェット。
`decoratedText`	`object (DecoratedText)` `DecoratedText` ウィジェット。
`buttonList`	`object (ButtonList)` `ButtonList` ウィジェット。
`textInput`	`object (TextInput)` `TextInput` ウィジェット。
`selectionInput`	`object (SelectionInput)` `SelectionInput` ウィジェット。
`dateTimePicker`	`object (DateTimePicker)` `DateTimePicker` ウィジェット。
`chipList`	`object (ChipList)` `ChipList` ウィジェット。

ChipList

水平方向に配置されたチップのリスト。水平方向にスクロールするか、次の行に折り返すことができます。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "layout": enum (`Layout`), "chips": [ { object (`Chip`) } ] }

フィールド

layout

enum (Layout)

指定されたチップリストレイアウト。

chips[]

object (Chip)

チップの配列。

レイアウト

チップリストのレイアウト。

列挙型
`LAYOUT_UNSPECIFIED`	使用しないでください。指定なし。
`WRAPPED`	デフォルト値。水平方向のスペースが十分でない場合、チップリストは次の行に折り返されます。
`HORIZONTAL_SCROLLABLE`	チップは、使用可能なスペースに収まらない場合は水平方向にスクロールします。

チップ

ユーザーがクリックできるテキスト、アイコン、またはテキストとアイコンのチップ。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "icon": { object (`Icon`) }, "label": string, "onClick": { object (`OnClick`) }, "enabled": boolean, "disabled": boolean, "altText": string }

フィールド
`icon`	`object (Icon)` アイコン画像。`icon` と `text` の両方が設定されている場合は、アイコンがテキストの前に表示されます。
`label`	`string` チップ内に表示されるテキスト。
`onClick`	`object (OnClick)` 省略可。ユーザーがチップをクリックしたときに実行するアクション（ハイパーリンクを開く、カスタム関数を実行するなど）。
`enabled (deprecated)`	`boolean` この項目は非推奨です。チップがアクティブな状態で、ユーザーアクションに応答するかどうか。デフォルトは `true` です。非推奨です。代わりに `disabled` を使用してください。
`disabled`	`boolean` チップが非アクティブ状態であり、ユーザーアクションを無視するかどうか。デフォルトは `false` です。
`altText`	`string` ユーザー補助機能で使用される代替テキスト。チップの機能をユーザーに知らせる説明テキストを設定します。たとえば、チップがハイパーリンクを開く場合は、「新しいブラウザタブを開き、https://developers.google.com/workspace/chat" の Google Chat デベロッパードキュメントに移動します」と記述します。

カルーセル

カルーセル（スライダーとも呼ばれます）は、ウィジェットのリストをスライドショー形式で回転させて表示し、前後のウィジェットに移動するボタンを備えています。

たとえば、次の JSON は 3 つのテキスト段落ウィジェットを含むカルーセルの表現です。

{
  "carouselCards": [
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "First text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Second text paragraph in carousel",
          }
        }
      ]
    },
    {
      "widgets": [
        {
          "textParagraph": {
            "text": "Third text paragraph in carousel",
          }
        }
      ]
    }
  ]
}

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

JSON 表現
{ "carouselCards": [ { object (`CarouselCard`) } ] }

フィールド

carouselCards[]

object (CarouselCard)

カルーセルに含まれるカードのリスト。

CarouselCard

カルーセルアイテムとして表示できるカード。

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

JSON 表現
{ "widgets": [ { object (`NestedWidget`) } ], "footerWidgets": [ { object (`NestedWidget`) } ] }

フィールド

widgets[]

object (NestedWidget)

カルーセルカードに表示されるウィジェットのリスト。ウィジェットは、指定された順序で表示されます。

footerWidgets[]

object (NestedWidget)

カルーセルカードの下部に表示されるウィジェットのリスト。ウィジェットは、指定された順序で表示されます。

NestedWidget

CarouselCard などのコンテナレイアウトに表示できるウィジェットのリスト。

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

JSON 表現

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "buttonList": {
    object (ButtonList)
  },
  "image": {
    object (Image)
  }
  // End of list of possible types for union field data.
}

フィールド
共用体フィールド `data`。 `data` は次のいずれかになります。
`textParagraph`	`object (TextParagraph)` テキスト段落ウィジェット。
`buttonList`	`object (ButtonList)` ボタンリストウィジェット。
`image`	`object (Image)` 画像ウィジェット。

CollapseControl

展開と折りたたみコントロールを表します。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "horizontalAlignment": enum (`HorizontalAlignment`), "expandButton": { object (`Button`) }, "collapseButton": { object (`Button`) } }

フィールド

horizontalAlignment

enum (HorizontalAlignment)

展開ボタンと折りたたみボタンの水平方向の配置。

expandButton

object (Button)

省略可。セクションを開くためのカスタマイズ可能なボタンを定義します。expandButton フィールドと collapseButton フィールドの両方を設定する必要があります。フィールドセットが 1 つだけの場合、有効になりません。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。

collapseButton

object (Button)

省略可。セクションを折りたたむためのカスタマイズ可能なボタンを定義します。expandButton フィールドと collapseButton フィールドの両方を設定する必要があります。フィールドセットが 1 つだけの場合、有効になりません。このフィールドが設定されていない場合、デフォルトのボタンが使用されます。

DividerStyle

カードの分割線のスタイル。現在、カードセクション間の区切り線にのみ使用されます。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

列挙型
`DIVIDER_STYLE_UNSPECIFIED`	使用しないでください。指定なし。
`SOLID_DIVIDER`	デフォルトのオプション。実線の区切り線をレンダリングします。
`NO_DIVIDER`	設定されている場合、区切り線はレンダリングされません。このスタイルでは、レイアウトから区切り線が完全に削除されます。結果は、区切り文字をまったく追加しない場合と同じになります。

CardAction

カードアクションは、カードに関連付けられたアクションです。たとえば、請求書カードには、請求書の削除、請求書のメール送信、ブラウザでの請求書のオープンなどのアクションが含まれる場合があります。

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

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

フィールド

actionLabel

string

アクションメニュー項目として表示されるラベル。

onClick

object (OnClick)

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

CardFixedFooter

カードの下部に表示される永続的な（固定された）フッター。

primaryButton または secondaryButton を指定せずに fixedFooter を設定すると、エラーが発生します。

Chat 用アプリでは、ダイアログで固定フッターを使用できますが、カードメッセージでは使用できません。Google Chat アプリの例については、永続的なフッターを追加するをご覧ください。

Google Chat 用アプリと Google Workspace アドオンで利用できます。

JSON 表現
{ "primaryButton": { object (`Button`) }, "secondaryButton": { object (`Button`) } }

フィールド

primaryButton

object (Button)

固定フッターのメインボタン。ボタンは、テキストと色が設定されたテキストボタンでなければなりません。

secondaryButton

object (Button)

固定フッターのセカンダリボタン。ボタンは、テキストと色が設定されたテキストボタンである必要があります。secondaryButton を設定する場合は、primaryButton も設定する必要があります。

DisplayStyle

Google Workspace アドオンで、カードの表示方法を指定します。

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

列挙型
`DISPLAY_STYLE_UNSPECIFIED`	使用しないでください。指定なし。
`PEEK`	カードのヘッダーはサイドバーの下部に表示され、スタックの現在の最上部のカードを部分的に覆います。ヘッダーをクリックすると、カードがカードスタックにポップアップ表示されます。カードにヘッダーがない場合は、生成されたヘッダーが代わりに使用されます。
`REPLACE`	デフォルト値。カードスタックの最上位のカードのビューを置き換えることで、カードが表示されます。

Cards v2 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

カード

CardHeader

ImageType

セクション

ウィジェット

TextParagraph

TextSyntax

画像

OnClick

アクション

ActionParameter

LoadIndicator

操作

OpenLink

OpenAs

OnClose

OverflowMenu

OverflowMenuItem

アイコン

MaterialIcon

DecoratedText

VerticalAlignment

ボタン

色

タイプ

SwitchControl

ControlType

ButtonList

TextInput

タイプ

RenderActions

アクション

ナビゲーション

候補

SuggestionItem

検証

InputType

SelectionInput

SelectionType

SelectionItem

PlatformDataSource

CommonDataSource

HostAppDataSourceMarkup

ChatClientDataSourceMarkup

SpaceDataSource

DateTimePicker

DateTimePickerType

Divider

グリッド

GridItem

ImageComponent

ImageCropStyle

ImageCropType

BorderStyle

BorderType

GridItemLayout

Columns

Column

HorizontalSizeStyle

HorizontalAlignment

VerticalAlignment

ウィジェット

ChipList

レイアウト

チップ

カルーセル

CarouselCard

NestedWidget

CollapseControl

DividerStyle

CardAction

CardFixedFooter

DisplayStyle

Cards v2