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

Package google.apps.card.v1

索引

Action（メッセージ）
Action.ActionParameter（メッセージ）
Action.Interaction（列挙型）
Action.LoadIndicator（列挙型）
BorderStyle（メッセージ）
BorderStyle.BorderType（列挙型）
Button（メッセージ）
ButtonList（メッセージ）
Card（メッセージ）
Card.CardAction（メッセージ）
Card.CardFixedFooter（メッセージ）
Card.CardHeader（メッセージ）
Card.DisplayStyle（列挙型）
Card.DividerStyle（列挙型）
Card.Section（メッセージ）
Columns（メッセージ）
Columns.Column（メッセージ）
Columns.Column.HorizontalSizeStyle（列挙型）
Columns.Column.VerticalAlignment（列挙型）
Columns.Column.Widgets（メッセージ）
DateTimePicker（メッセージ）
DateTimePicker.DateTimePickerType（列挙型）
DecoratedText（メッセージ）
DecoratedText.SwitchControl（メッセージ）
DecoratedText.SwitchControl.ControlType（列挙型）
Divider（メッセージ）
EndNavigation（メッセージ）
EndNavigation.Action（列挙型）
GetAutocompletionResponse（メッセージ）
Grid（メッセージ）
Grid.GridItem（メッセージ）
Grid.GridItem.GridItemLayout（列挙型）
Icon（メッセージ）
Image（メッセージ）
ImageComponent（メッセージ）
ImageCropStyle（メッセージ）
ImageCropStyle.ImageCropType（列挙型）
Link（メッセージ）
LinkPreview（メッセージ）
MaterialIcon（メッセージ）
Navigation（メッセージ）
Notification（メッセージ）
OnClick（メッセージ）
OpenLink（メッセージ）
OpenLink.OnClose（列挙型）
OpenLink.OpenAs（列挙型）
RenderActions（メッセージ）
RenderActions.Action（メッセージ）
SelectionInput（メッセージ）
SelectionInput.PlatformDataSource（メッセージ）
SelectionInput.PlatformDataSource.CommonDataSource（列挙型）
SelectionInput.SelectionItem（メッセージ）
SelectionInput.SelectionType（列挙型）
SubmitFormResponse（メッセージ）
Suggestions（メッセージ）
Suggestions.SuggestionItem（メッセージ）
TextInput（メッセージ）
TextInput.Type（列挙型）
TextParagraph（メッセージ）
Widget（メッセージ）
Widget.HorizontalAlignment（列挙型）
Widget.ImageType（列挙型）

アクション

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

ActionParameter

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

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

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

key

string

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

value

string

パラメータの値。

交流

省略可。ダイアログを開くときに必要です。

ユーザーとのやり取り（カードメッセージのボタンのクリックなど）に対する応答内容。

指定しない場合、アプリは通常どおり 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 アドオンでは利用できません。

LoadIndicator

アクションの呼び出し中に表示される読み込みインジケーターを指定します。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

BorderStyle

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

フィールド
`type`	`BorderType` 枠線の種類。
`strokeColor`	`Color` タイプが `BORDER_TYPE_STROKE` の場合に使用する色。
`cornerRadius`	`int32` 枠線の角の半径です。

type

BorderType

枠線の種類。

strokeColor

Color

タイプが BORDER_TYPE_STROKE の場合に使用する色。

cornerRadius

int32

枠線の角の半径です。

BorderType

ウィジェットに適用される枠線タイプを表します。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

列挙型
`BORDER_TYPE_UNSPECIFIED`	使用しないでください。（指定なし）
`NO_BORDER`	デフォルト値。枠線なし。
`STROKE`	Outline。

ボタン

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

画像をクリック可能なボタンにするには、ImageComponent ではなく Image を指定し、onClick アクションを設定します。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド
`text`	`string` ボタン内に表示されるテキスト。
`icon`	`Icon` アイコン画像。`icon` と `text` の両方を設定した場合、アイコンはテキストの前に表示されます。
`color`	`Color` 設定すると、ボタンは無地の背景色で塗りつぶされ、フォントの色は背景色とのコントラストが維持されます。たとえば、背景を青色に設定すると、テキストが白になる可能性が高くなります。未設定の場合、画像の背景は白、フォントの色は青です。赤、緑、青の場合、各フィールドの値は `float` で、0 ～ 255 を 255 で割った値（153÷255）または 0 ～ 1（0.6）のいずれかで表現できます。0 は無色を表し、1 または 255/255 は RGB スケールでその色の完全な存在を表します。必要に応じて `alpha` を設定し、次の式を使用して透明度を設定します。 `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` `alpha` の場合、値 `1` は単色、値 `0` は完全に透明な色に対応します。たとえば、次の色は半透明な赤を表しています。 `"color": { "red": 1, "green": 0, "blue": 0, "alpha": 0.5 }`
`onClick`	`OnClick` 必須。ハイパーリンクを開く、カスタム関数を実行するなど、ユーザーがボタンをクリックしたときに実行するアクション。
`disabled`	`bool` `true` の場合、ボタンは非アクティブな状態で表示され、ユーザーの操作に反応しません。
`altText`	`string` ユーザー補助に使用される代替テキスト。ボタンの役割をユーザーに示す説明テキストを設定します。たとえば、ボタンによってハイパーリンクが開く場合は、「新しいブラウザタブを開き、Google Chat デベロッパー向けドキュメント（https://developers.google.com/workspace/chat"」に移動）のように記述します。

ButtonList

横方向に並べられたボタンのリスト。Google Chat アプリの例については、ボタンを追加するをご覧ください。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

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

buttons[]

Button

ボタンの配列。

カード

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

カードでは、定義済みのレイアウト、インタラクティブな UI 要素（ボタンなど）、リッチメディアなどのリッチメディアがサポートされます。カードを使用して詳細情報を表示し、ユーザーから情報を収集し、ユーザーを次のステップに導く。

カードビルダーでカードをデザインしてプレビューする。

カードビルダーを開く

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

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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}

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

CardAction

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

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

フィールド

フィールド
`actionLabel`	`string` 操作メニュー項目として表示されるラベル。
`onClick`	`OnClick` このアクションアイテムの `onClick` アクション。

actionLabel

string

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

onClick

OnClick

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

CardFixedFooter

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

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

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

フィールド
`primaryButton`	`Button` 固定フッターのメインボタン。ボタンは、テキストと色が設定されたテキストボタンであること。
`secondaryButton`	`Button` 固定フッターのサブボタン。ボタンは、テキストと色が設定されたテキストボタンであること。`secondaryButton` が設定されている場合は、`primaryButton` も設定する必要があります。

primaryButton

Button

固定フッターのメインボタン。ボタンは、テキストと色が設定されたテキストボタンであること。

secondaryButton

Button

固定フッターのサブボタン。ボタンは、テキストと色が設定されたテキストボタンであること。secondaryButton が設定されている場合は、primaryButton も設定する必要があります。

CardHeader

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

DisplayStyle

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

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

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

DividerStyle

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

列挙型
`DIVIDER_STYLE_UNSPECIFIED`	使用しないでください。（指定なし）
`SOLID_DIVIDER`	デフォルトのオプションです。セクション間は無地の分割線をレンダリングします。
`NO_DIVIDER`	設定すると、セクション間に分割線はレンダリングされません。

セクション

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド
`header`	`string` セクションの上部に表示されるテキスト。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
`widgets[]`	`Widget` セクションのすべてのウィジェット。ウィジェットを 1 つ以上含める必要があります。
`collapsible`	`bool` このセクションが折りたたみ可能かどうかを示します。折りたたみ可能なセクションでは、一部またはすべてのウィジェットが非表示になりますが、[もっと見る] をクリックしてセクションを展開すると、非表示のウィジェットを表示できます。[一部を表示] をクリックすると、ウィジェットを再度非表示にできます。非表示にするウィジェットを特定するには、`uncollapsibleWidgetsCount` を指定します。
`uncollapsibleWidgetsCount`	`int32` セクションを折りたたんだ状態でも表示されたままになる、折りたたみできないウィジェットの数です。たとえば、セクションに 5 つのウィジェットがあり、`uncollapsibleWidgetsCount` が `2` に設定されている場合、最初の 2 つのウィジェットは常に表示され、残りの 3 つのウィジェットはデフォルトでは折りたたまれます。`uncollapsibleWidgetsCount` は、`collapsible` が `true` の場合にのみ考慮されます。

表示項目

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

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

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

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

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

フィールド
`columnItems[]`	`Column` 列の配列。カードまたはダイアログには最大 2 列を含めることができます。

columnItems[]

Column

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

列

列。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

HorizontalSizeStyle

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

VerticalAlignment

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

ウィジェット

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

DateTimePicker

ユーザーは日付、時刻、またはその両方を入力できます。Google Chat アプリの例については、ユーザーが日時を選択できるようにするをご覧ください。

ユーザーはテキストを入力するか、選択ツールを使用して日付と時刻を選択できます。ユーザーが無効な日時を入力すると、選択ツールにエラーが表示され、情報を正しく入力するよう求められます。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド
`name`	`string` フォーム入力イベントで `DateTimePicker` が識別される名前。フォーム入力の操作について詳しくは、フォームデータを受信するをご覧ください。
`label`	`string` 日付、時刻、または日時の入力をユーザーに促すテキスト。たとえば、ユーザーが予約をスケジュールしている場合は、`Appointment date` や `Appointment date and time` などのラベルを使用します。
`type`	`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`	`int32` UTC からのタイムゾーンオフセットを表す数値（分単位）。設定すると、`value_ms_epoch` は指定されたタイムゾーンで表示されます。設定しない場合、値はデフォルトでユーザーのタイムゾーン設定になります。
`onChangeAction`	`Action` ユーザーが `DateTimePicker` インターフェースで [保存] または [消去] をクリックするとトリガーされます。

DateTimePickerType

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

DecoratedText

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド
`icon (deprecated)`	`Icon` この項目は非推奨です。 `startIcon` に置き換えられたため、非推奨となりました。
`startIcon`	`Icon` テキストの前に表示されるアイコン。
`topLabel`	`string` `text` の上に表示されるテキスト。常に切り捨てられます。
`text`	`string` 必須。プライマリテキスト。シンプルな書式をサポートします。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。
`wrapText`	`bool` テキストの折り返しの設定。`true` の場合、テキストは折り返して複数行に表示されます。それ以外の場合、テキストは切り捨てられます。 `text` にのみ適用され、`topLabel` と `bottomLabel` には適用されません。
`bottomLabel`	`string` `text` の下に表示されるテキスト。常に折り返します。
`onClick`	`OnClick` この操作は、ユーザーが `topLabel` または `bottomLabel` をクリックするとトリガーされます。
共用体フィールド `control`。`decoratedText` ウィジェットでテキストの右側に表示されるボタン、スイッチ、チェックボックス、画像。`control` は次のいずれかになります。
`button`	`Button` ユーザーがクリックしてアクションをトリガーできるボタン。
`switchControl`	`SwitchControl` ユーザーがクリックして状態を変更し、アクションをトリガーできる切り替えウィジェット。
`endIcon`	`Icon` テキストの後に表示されるアイコン。組み込みアイコンとカスタムアイコンをサポートします。

SwitchControl

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

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

ControlType

ユーザーインターフェースにスイッチがどのように表示されるか。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

列挙型
`SWITCH`	切り替え式のスイッチ。
`CHECKBOX`	`CHECK_BOX` に置き換えられたため、非推奨となりました。
`CHECK_BOX`	チェックボックス。

分割線

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

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

たとえば、次の JSON は分割線を作成します。

"divider": {}

EndNavigation

ダイアログフローアクション。

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

フィールド

action

Action

クライアントがダイアログフローを終了するためのレンダリングアクション。

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

アクション

クライアントがダイアログフローを終了するためのレンダリングアクションタイプ。

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

列挙型
`ACTION_UNSPECIFIED`	アクションが指定されていません。
`CLOSE_DIALOG`	ダイアログフローを閉じます。
`CLOSE_DIALOG_AND_EXECUTE`	ダイアログフローを閉じて、ダイアログフローを開いたカードを更新します。

GetAutocompletionResponse

予測入力コンテナの取得に対するレスポンス。このコンテナには、テキストフィールドに予測入力項目を表示するために必要な要素が含まれています。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。次に例を示します。

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

フィールド

フィールド
`autoComplete`	`Suggestions`
`schema`	`string` これは、構文チェックのためにマークアップに存在する可能性がある NoOps スキーマフィールドです。

autoComplete

Suggestions

schema

string

これは、構文チェックのためにマークアップに存在する可能性がある NoOps スキーマフィールドです。

グリッド

アイテムのコレクションを含むグリッドを表示します。アイテムにはテキストまたは画像のみを含めることができます。列をレスポンシブにする場合や、テキストや画像以外の列を含める場合は、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"
    }
  }
}

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

GridItem

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

GridItemLayout

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

Icon

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

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド
`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`	`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`	`MaterialIcon` Google マテリアルアイコンのいずれかを表示します。たとえば、チェックボックスアイコンを表示するには、次のコマンドを使用します。 `"materialIcon": { "name": "check_box" }` Google Chat アプリで利用でき、Google Workspace アドオンでは利用できません。

画像

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

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

imageUrl

string

イメージをホストする HTTPS URL。

次に例を示します。

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

onClick

OnClick

ユーザーが画像をクリックすると、この操作がトリガーされます。

altText

string

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

ImageComponent

画像を表します。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

ImageCropStyle

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

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

フィールド

フィールド
`type`	`ImageCropType` 切り抜きの種類。
`aspectRatio`	`double` 切り抜きタイプが `RECTANGLE_CUSTOM` の場合に使用するアスペクト比。たとえば、アスペクト比 16:9 を適用する方法は次のとおりです。 `cropStyle { "type": "RECTANGLE_CUSTOM", "aspectRatio": 16/9 }`

type

ImageCropType

切り抜きの種類。

aspectRatio

double

切り抜きタイプが 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 の長方形の切り抜きを適用します。

リンク

アドオンに返されるサードパーティリソースのリンクオブジェクト。詳細については、@ メニューからサードパーティのリソースを作成するをご覧ください。

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

フィールド

フィールド
`url`	`string` アドオンに戻るリンクの URL。
`title`	`string` アドオンに返すリンクのタイトル。

url

string

アドオンに戻るリンクの URL。

title

string

アドオンに返すリンクのタイトル。

LinkPreview

カードとスマートチップを表示してサードパーティのリンクをプレビューするカードアクション。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

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

たとえば、次の JSON は、リンクプレビューとそのスマートチップの一意のタイトルと、ヘッダーとテキストによる説明を含むプレビューカードを返します。

{
  "action": {
    "linkPreview": {
      "title": "Smart chip title",
      "linkPreviewTitle": "Link preview title",
      "previewCard": {
        "header": {
          "title": "Preview card header",
        },
        "sections": [
          {
            "widgets": [
              {
                "textParagraph": {
                  "text": "Description of the link."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

この例では、次のリンクプレビューが返されます。

リンクのプレビューの例

フィールド

フィールド
`previewCard`	`Card` サードパーティサービスからのリンクに関する情報を表示するカード。
`title`	`string` リンクのプレビューのスマートチップに表示されるタイトル。未設定のままにした場合、スマートチップには `preview_card` のヘッダーが表示されます。
`linkPreviewTitle`	`string` リンクプレビューに表示されるタイトル。未設定の場合、リンクプレビューには `preview_card` のヘッダーが表示されます。

previewCard

Card

サードパーティサービスからのリンクに関する情報を表示するカード。

title

string

リンクのプレビューのスマートチップに表示されるタイトル。未設定のままにした場合、スマートチップには preview_card のヘッダーが表示されます。

linkPreviewTitle

string

リンクプレビューに表示されるタイトル。未設定の場合、リンクプレビューには preview_card のヘッダーが表示されます。

MaterialIcon

Google マテリアルアイコン: 2, 500 以上のオプションが含まれています。

たとえば、カスタマイズした体重と成績を含むチェックボックスアイコンを表示するには、次のように記述します。

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

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

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

カードスタックを操作するカードアクション。

次に例を示します。

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

 navigations : {
    pushCard : CARD
  }

2）スタックの一番上でカードを更新します（インプレースアップデート）。

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

  navigations : {
    popCard : true,
  }, {
    pushCard : CARD
  }

3）更新せずに 1 つ前のステップに戻ります。

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

  navigations : {
    popCard : true,
  }

4）複数の手順に戻ってカードを更新します。

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

  navigations : {
    popCard : true,
  }, ... {
    pushCard : CARD
  }

5）複数のステップを定義した CARD_NAME に戻る。

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

  navigations : {
    popToCardName : CARD_NAME,
  }, {
    pushCard : CARD
  }

6）ルートに戻り、カードを更新します。

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

  navigations : {
    popToRoot : true
  }, {
    pushCard : CARD
  }

7）指定したカードにポップします。そのカードもポップします。

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

navigations : { popToCardName : CARD_NAME }, { popCard : true, }

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

  navigations : {
    updateCard : CARD
  }

フィールド
共用体フィールド `navigate_action`。 `navigate_action` は次のいずれかになります。
`popToRoot`	`bool` カードスタックで、ルートカードを除くすべてのカードがポップオフします。
`pop`	`bool` カードのスタックで 1 枚のカードがポップされます。
`popToCard`	`string` カードスタックは、指定されたカード名を持つ指定されたカードの上にあるすべてのカードをポップします。
`pushCard`	`Card` カードスタックは、カードをカードスタックにプッシュします。
`updateCard`	`Card` カードスタックでは、一番上のカードが新しいカードで更新され、入力されたフォームフィールドの値が保持されます。同等でないフィールドの場合、値は破棄されます。
`endNavigation`	`EndNavigation` ダイアログフローによるナビゲーションアクションの終了。詳細については、アプリのホームカードメッセージのダイアログに応答するをご覧ください。 Google Chat アプリで利用でき、Google Workspace アドオンでは利用できません。

通知

ホストアプリに通知を表示するカードアクション。

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

フィールド

フィールド
`text`	`string` 通知に表示する書式なしテキスト（HTML タグなし）。

text

string

通知に表示する書式なしテキスト（HTML タグなし）。

OnClick

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

OpenLink

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

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

url

string

開く URL。

openAs

OpenAs

リンクの開き方。

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

onClose

OnClose

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

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

OnClose

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

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

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

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

列挙型

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

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

RELOAD

子ウィンドウが閉じた後に、カードを再読み込みする。

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

OpenAs

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

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

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

RenderActions

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

フィールド
`action`	`Action`
`hostAppAction`	`HostAppActionMarkup` 個々のホストアプリで処理されるアクション。
`schema`	`string` これは、構文チェックのためにマークアップに存在する可能性がある NoOps スキーマフィールドです。

action

Action

hostAppAction

HostAppActionMarkup

個々のホストアプリで処理されるアクション。

schema

string

これは、構文チェックのためにマークアップに存在する可能性がある NoOps スキーマフィールドです。

アクション

フィールド
`navigations[]`	`Navigation` 表示されたカードのプッシュ、ポップ、更新を行います。
`link`	`OpenLink` 直ちに新しいタブまたはポップアップでターゲットリンクを開きます。
`notification`	`Notification` エンドユーザーに通知を表示します。
`linkPreview`	`LinkPreview` リンクのプレビューをエンドユーザーに表示します。
`links[]`	`Link` Google Workspace アプリケーション内で作成されたサードパーティリソースへのリンク。1 つの項目を含むオブジェクトの配列としてフォーマットされます。詳細については、@ メニューからサードパーティのリソースを作成するをご覧ください。

SelectionInput

ユーザーが選択できる 1 つ以上の UI アイテムを作成するウィジェット。たとえば、プルダウンメニューやチェックボックスなどです。このウィジェットを使用して、予測や列挙が可能なデータを収集できます。Google Chat アプリの例については、選択可能な UI 要素を追加するをご覧ください。

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

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

PlatformDataSource

複数選択メニューを使用する SelectionInput ウィジェットの場合は、Google Workspace のデータソースです。複数選択メニューのアイテムを入力するために使用されます。

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

フィールド

フィールド
共用体フィールド `data_source`。データソース。`data_source` は次のいずれかになります。
`commonDataSource`	`CommonDataSource` Google Workspace 組織内のユーザーなど、すべての Google Workspace アプリケーションで共有されるデータソース。
`hostAppDataSource`	`HostAppDataSourceMarkup` Google Workspace ホストアプリケーションに固有のデータソース（Google Chat のスペースなど）。

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

commonDataSource

CommonDataSource

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

hostAppDataSource

HostAppDataSourceMarkup

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

CommonDataSource

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

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

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

SelectionItem

チェックボックスやスイッチなど、ユーザーが選択入力で選択できる項目。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

SelectionType

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

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

列挙型
`CHECK_BOX`	チェックボックスのセット。ユーザーは 1 つ以上のチェックボックスを選択できます。
`RADIO_BUTTON`	ラジオボタンのセット。ユーザーはラジオボタンを 1 つ選択できます。
`SWITCH`	スイッチのセット。ユーザーはスイッチを 1 つ以上有効にできます。
`DROPDOWN`	プルダウンメニュー。メニューから 1 つのアイテムを選択できます。
`MULTI_SELECT`	静的データと動的データの複数選択メニュー。ユーザーはメニューバーから 1 つ以上のアイテムを選択します。ユーザーは値を入力して動的データを取り込むこともできます。たとえば、ユーザーが Google Chat スペースの名前の入力を開始すると、ウィジェットがスペースを自動的に提案します。複数選択メニューのアイテムを入力するには、次のいずれかのタイプのデータソースを使用します。静的データ: アイテムはウィジェットで `SelectionItem` オブジェクトとして指定されます。アイテム数の上限は 100 個です。 Google Workspace のデータ: アイテムは、Google Workspace ユーザー、Google Chat スペースなどの Google Workspace のデータを使用して入力されます。外部データ: アイテムは、Google Workspace の外部の外部データソースから入力されます。複数選択メニューを実装する方法の例については、複数選択メニューを追加するをご覧ください。 Google Chat アプリと Google Workspace アドオンでご利用いただけます。Google Workspace アドオンの複数選択はデベロッパープレビューの段階です。

SubmitFormResponse

フォーム送信に対するレスポンス（予測入力コンテナの取得を除く）。これには、カードが実行する必要があるアクション、アドオンホストアプリが実行する必要があるアクション、カードの状態が変更されたかどうかが含まれます。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。次に例を示します。

{
  "renderActions": {
    "action": {
      "notification": {
        "text": "Email address is added: salam.heba@example.com"
      }
    },
    "hostAppAction": {
      "gmailAction": {
        "openCreatedDraftAction": {
          "draftId": "msg-a:r-79766936926021702",
          "threadServerPermId": "thread-f:15700999851086004"
        }
      }
    }
  }
}

フィールド

renderActions

RenderActions

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

stateChanged

bool

カードの状態が変更され、既存のカードのデータが古くなっているかどうか。

schema

string

これは、構文チェックのためにマークアップに存在する可能性がある NoOps スキーマフィールドです。

候補

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

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

候補値により、アプリが理解できる値をユーザーが入力しやすくなります。JavaScript を参照する場合、ユーザーが「javascript」と入力し、別のユーザーが「java script」と入力することがあります。JavaScript を提案することで、ユーザーによるアプリの操作方法を標準化できます。

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

items[]

SuggestionItem

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

SuggestionItem

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

共用体フィールド content。

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

text

string

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

TextInput

ユーザーがテキストを入力できるフィールド。提案と変更時のアクションをサポートします。Google Chat アプリの例については、ユーザーがテキストを入力できるフィールドを追加するをご覧ください。

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

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

タイプ

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

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

TextParagraph

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

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

フィールド

text

string

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

フィールド
`horizontalAlignment`	`HorizontalAlignment` ウィジェットの配置を、左、右、中央のいずれにするかを指定します。
共用体フィールド `data`。ウィジェットには、以下のアイテムのうち 1 つのみを含めることができます。複数のウィジェットフィールドを使用して、さらにアイテムを表示できます。`data` は次のいずれかになります。
`textParagraph`	`TextParagraph` 段落テキストを表示します。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。たとえば、次の JSON は太字のテキストを作成します。 `"textParagraph": { "text": " <b>bold text</b>" }`
`image`	`Image` 画像を表示します。たとえば、次の JSON は代替テキストを含む画像を作成します。 `"image": { "imageUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png", "altText": "Chat app avatar" }`
`decoratedText`	`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`	`ButtonList` ボタンのリスト。たとえば、次の JSON は 2 つのボタンを作成します。1 つ目は青色のテキストボタン、2 つ目はリンクを開く画像ボタンです。 `"buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, "alpha": 1 }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] }`
`textInput`	`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`	`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`	`DateTimePicker` ユーザーが日付、時刻、または日時を入力できるウィジェットを表示します。たとえば、次の JSON は、予約をスケジュールする日時選択ツールを作成します。 `"dateTimePicker": { "name": "appointment_time", "label": "Book your appointment at:", "type": "DATE_AND_TIME", "valueMsEpoch": "796435200000" }`
`divider`	`Divider` ウィジェット間に水平の線分割を表示します。たとえば、次の JSON は分割線を作成します。 `"divider": { }`
`grid`	`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`	`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" } } ] } ] }`

HorizontalAlignment

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

ImageType

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

Package google.apps.card.v1

索引

アクション

ActionParameter

交流

LoadIndicator

BorderStyle

BorderType

ボタン

ButtonList

カード

CardAction

CardFixedFooter

CardHeader

DisplayStyle

DividerStyle

セクション

表示項目

列

HorizontalSizeStyle

VerticalAlignment

ウィジェット

DateTimePicker

DateTimePickerType

DecoratedText

SwitchControl

ControlType

分割線

EndNavigation

アクション

GetAutocompletionResponse

グリッド

GridItem

GridItemLayout

Icon

画像

ImageComponent

ImageCropStyle

ImageCropType

リンク

LinkPreview

MaterialIcon

ナビゲーション

通知

OnClick

OpenLink

OnClose

OpenAs

RenderActions

アクション

SelectionInput

PlatformDataSource

CommonDataSource

SelectionItem

SelectionType

SubmitFormResponse

候補

SuggestionItem

TextInput

タイプ

TextParagraph

ウィジェット

HorizontalAlignment

ImageType