Package google.apps.card.v1

インデックス

アクション

フォームが送信されたときの動作を記述するアクション。たとえば、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 アドオンでは使用不可。

requiredWidgets[]

string

省略可。このリストに、このアクションが有効な送信に必要なウィジェットの名前を入力します。

このアクションが呼び出されたときに、ここにリストされているウィジェットに値がない場合、フォームの送信は中止されます。

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

allWidgetsAreRequired

bool

省略可。これが true の場合、すべてのウィジェットがこのアクションで必須と見なされます。

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

ActionParameter

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

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

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

フィールド
key

string

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

value

string

パラメータの値。

インタラクション

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

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

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

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

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

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

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

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

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

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

LoadIndicator

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

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

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

AuthorizationError

サードパーティ サービスにアクセスするアドオンや、Google からより多くの OAuth スコープを必要とするアドオンでは、ログイン認証情報(OAuth トークンなど)が利用できない場合に、エンドユーザーに認証カードを表示する必要があります。アドオンは、承認カードをレンダリングするために AuthorizationError オブジェクトを返す必要があります。

フィールド

共用体フィールド rendering。

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

basicAuthorizationPrompt

BasicAuthorizationAction

プラットフォームで基本的な承認カードを作成できるようにします。デベロッパーは、認証 URL のみを提供する必要があります。基本アクションは、一般公開を目的としないアドオンで使用できます。

customAuthorizationPrompt

RenderActions

カスタマイズされた承認カードの手順をレンダリングします。Google Workspace Marketplace の審査プロセスでは、カスタムの承認プロンプトが適用されます。エンドユーザーには、カスタマイズされた承認カードが表示され、エンドユーザーが外部のサードパーティ サービスへのアクセスを承認していることが明確になります。

requestingGoogleScopes

RequestingGoogleScopes

バンドルされていない OAuth 同意が有効になっている場合、HTTP アドオンはより多くの Google OAuth スコープをリクエストする必要がある場合があります。アドオンは、このオブジェクトを返して承認カードをレンダリングする必要があります。詳細については、Manage granular permissions をご覧ください。

BasicAuthorizationAction

プラットフォームがエンドユーザー向けの基本的な承認カードを作成できるようにするアクション。

フィールド
authorizationUrl

string

アドオンが OAuth2 を使用してサードパーティ サービスに接続している場合、これは OAuth2 認証 URL になります。

resource

string

保護されたリソースに認可がない場合にエンドユーザーに表示されるテキスト。値の例としては、「Salesforce アカウント」や「Salesforce データ」などがあります。

BorderStyle

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

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

フィールド
type

BorderType

枠線の種類。

strokeColor

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

int32

枠線の角の丸み。

BorderType

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

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

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

ボタン

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

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

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

フィールド
text

string

ボタン内に表示されるテキスト。

icon

Icon

ボタン内に表示されるアイコン。icon と text の両方が設定されている場合、アイコンはテキストの前に表示されます。

color

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

OnClick

必須。ユーザーがボタンをクリックしたときに実行するアクション(ハイパーリンクを開く、カスタム関数を実行するなど)。

disabled

bool

true の場合、ボタンは無効な状態で表示され、ユーザー操作に反応しません。

altText

string

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

ボタンの動作をユーザーに知らせる説明テキストを設定します。たとえば、ボタンがハイパーリンクを開く場合は、「新しいブラウザタブを開き、https://developers.google.com/workspace/chat" の Google Chat デベロッパー ドキュメントに移動します」と記述します。

type

Type

省略可。ボタンのタイプ。設定しない場合、ボタンタイプはデフォルトで OUTLINED になります。color フィールドが設定されている場合、ボタンタイプは強制的に FILLED になり、このフィールドに設定された値は無視されます。

タイプ

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

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

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

ButtonList

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

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

フィールド
buttons[]

Button

ボタンの配列。

カード

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

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

カードビルダーを使用してカードを設計し、プレビューする。

カードビルダーを開く

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

注: 1 つのカードに追加できるウィジェットは 100 個までです。セクションのウィジェットによって合計数が 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"
                             }
                           ]
                         }
                       }
                     }
                   ]
                 }
               }
             ]
           }
         ]
       }
    }
  ]
}
フィールド
header

CardHeader

カードのヘッダー。ヘッダーには通常、先頭の画像とタイトルが含まれます。ヘッダーは常にカードの上部に表示されます。

sections[]

Section

ウィジェットのコレクションが含まれます。各セクションには、独自のオプションのヘッダーがあります。セクションは、区切り線で視覚的に区切られています。Google Chat アプリの例については、カードのセクションを定義するをご覧ください。

sectionDividerStyle

DividerStyle

ヘッダー、セクション、フッターの間の区切り線のスタイル。

cardActions[]

CardAction

カードのアクション。アクションはカードのツールバー メニューに追加されます。最大 10 個の CardAction アイテムをサポートします。

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

たとえば、次の JSON は、Settings オプションと Send Feedback オプションを含むカード操作メニューを構築します。

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "function": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]
name

string

カードの名前。カード ナビゲーションでカード識別子として使用されます。

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 アプリでは使用不可。

expressionData[]

ExpressionData

カードの式データ。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

CardAction

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

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

フィールド
actionLabel

string

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

onClick

OnClick

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

CardFixedFooter

カードの下部に表示される固定(スティッキー)フッター。

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

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

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

フィールド
primaryButton

Button

固定フッターのメインボタン。ボタンは、テキストと色が設定されたテキストボタンにする必要があります。

secondaryButton

Button

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

CardHeader

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

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

フィールド
title

string

必須。カードヘッダーのタイトル。ヘッダーの高さは固定されています。タイトルとサブタイトルの両方が指定されている場合、それぞれが 1 行を占めます。タイトルのみが指定されている場合は、両方の行が使用されます。

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 設定すると、区切り線はレンダリングされません。このスタイルでは、レイアウトから区切り線が完全に削除されます。結果は、区切り線をまったく追加しない場合と同じです。

NestedWidget

CarouselCard などのコンテナ レイアウトに表示できるウィジェットのリスト。 Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

フィールド

共用体フィールド data。

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

textParagraph

TextParagraph

テキスト段落ウィジェット。

buttonList

ButtonList

ボタンリスト ウィジェット。

image

Image

画像ウィジェット。

セクション

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

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

フィールド
header

string

セクションの上部に表示されるテキスト。シンプルな HTML 形式のテキストをサポートしています。テキストの書式設定について詳しくは、Google Chat アプリでのテキストの書式設定と Google Workspace アドオンでのテキストの書式設定をご覧ください。

widgets[]

Widget

セクション内のすべてのウィジェット。1 つ以上のウィジェットを含める必要があります。カードは、すべてのセクションで最大 100 個のウィジェットをサポートします。

collapsible

bool

このセクションを折りたたみ可能にするかどうかを示します。

折りたたみ可能なセクションでは、一部またはすべてのウィジェットが非表示になりますが、ユーザーは [もっと見る] をクリックしてセクションを開き、非表示のウィジェットを表示できます。[表示を減らす] をクリックすると、ウィジェットを再度非表示にできます。

非表示にするウィジェットを指定するには、uncollapsibleWidgetsCount を指定します。

uncollapsibleWidgetsCount

int32

セクションが折りたたまれても表示されたままになる、折りたたみ不可能なウィジェットの数。

たとえば、セクションに 5 つのウィジェットが含まれていて、uncollapsibleWidgetsCount が 2 に設定されている場合、最初の 2 つのウィジェットは常に表示され、最後の 3 つはデフォルトで折りたたまれます。uncollapsibleWidgetsCount は、collapsible が true の場合にのみ考慮されます。

id

string

セクションに割り当てられた一意の ID。変更するセクションを識別するために使用されます。ID の文字数制限は 64 文字で、[a-zA-Z0-9-]+ の形式にする必要があります。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

collapseControl

CollapseControl

省略可。セクションの展開ボタンと折りたたみボタンを定義します。このボタンは、セクションが折りたたみ可能な場合にのみ表示されます。このフィールドが設定されていない場合は、デフォルトのボタンが使用されます。

公開設定

UI 要素を表示するか非表示にするかを指定します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

列挙型
VISIBILITY_UNSPECIFIED 未指定の公開設定。使用しないでください。
VISIBLE UI 要素が表示されている。
HIDDEN UI 要素が非表示になっている。

カルーセル カードのリストをスライドショー形式で回転させて表示します。前のカードまたは次のカードに移動するボタンがあります。

たとえば、次の 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 アドオンでは使用不可。

フィールド
carouselCards[]

CarouselCard

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

CarouselCard

カルーセル アイテムとして表示できるカード。 Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

フィールド
widgets[]

NestedWidget

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

footerWidgets[]

NestedWidget

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

チップ

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

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

フィールド
icon

Icon

アイコン画像。icon と label の両方を設定すると、アイコンがラベルの前に表示されます。

label

string

チップ内に表示されるテキスト。

onClick

OnClick

省略可。ユーザーがチップをクリックしたときに実行するアクション(ハイパーリンクを開く、カスタム関数を実行するなど)。

enabled
(deprecated)

bool

非推奨: 代わりに、disabled を使用してください。

チップがアクティブな状態にあり、ユーザー アクションに応答するかどうか。

disabled

bool

チップが無効な状態にあり、ユーザー操作を無視するかどうか。デフォルトは false です。

altText

string

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

チップの機能をユーザーに知らせる説明テキストを設定します。たとえば、チップがハイパーリンクを開く場合は、「新しいブラウザタブを開き、https://developers.google.com/workspace/chat" の Google Chat デベロッパー ドキュメントに移動します」と記述します。

ChipList

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

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

フィールド
layout

Layout

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

chips[]

Chip

チップの配列。

レイアウト

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

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

CollapseControl

開閉コントロールを表します。

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

フィールド
horizontalAlignment

HorizontalAlignment

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

expandButton

Button

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

collapseButton

Button

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

列

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 カレンダーの予定の [添付ファイルを追加] メニューからアドオンを開いたときに表示されるダイアログ。
フィールド
columnItems[]

Column

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

列

列。

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

フィールド
horizontalSizeStyle

HorizontalSizeStyle

列がカードの幅をどのように埋めるかを指定します。

horizontalAlignment

HorizontalAlignment

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

verticalAlignment

VerticalAlignment

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

widgets[]

Widgets

列に含まれるウィジェットの配列。ウィジェットは指定された順序で表示されます。

HorizontalSizeStyle

列がカードの幅をどのように埋めるかを指定します。各列の幅は、HorizontalSizeStyle と列内のウィジェットの幅の両方によって決まります。

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

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

VerticalAlignment

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

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

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

ウィジェット

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

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

フィールド

共用体フィールド data。

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

textParagraph

TextParagraph

TextParagraphウィジェットです。

image

Image

Imageウィジェットです。

decoratedText

DecoratedText

DecoratedTextウィジェットです。

buttonList

ButtonList

ButtonListウィジェットです。

textInput

TextInput

TextInputウィジェットです。

selectionInput

SelectionInput

SelectionInputウィジェットです。

dateTimePicker

DateTimePicker

DateTimePickerウィジェットです。

chipList

ChipList

ChipListウィジェットです。

条件

アクションをトリガーするために使用できる条件を表します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

フィールド
actionRuleId

string

ActionRule の固有識別子。

共用体フィールド condition。条件。condition は次のいずれかになります。
expressionDataCondition

ExpressionDataCondition

式データによって決定される条件。

ExpressionDataCondition

CEL を使用して評価される条件を表します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

フィールド
conditionType

ConditionType

条件のタイプ。

ConditionType

条件のタイプ。

列挙型
CONDITION_TYPE_UNSPECIFIED 未指定の条件タイプ。
EXPRESSION_EVALUATION_SUCCESS 式の評価が成功しました。
EXPRESSION_EVALUATION_FAILURE 式の評価に失敗しました。

DataActions

Google Workspace データを更新するアドオン アクション。

フィールド
hostAppDataAction

HostAppDataActionMarkup

Google Workspace データの更新方法を定義します。

DataSourceConfig

ウィジェットのデータソースの構成に役立つ構成オブジェクト。

Google Workspace Studio を拡張する Google Chat アプリと Google Workspace アドオンで使用できます。

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

Action

データはリモート データ プロバイダから取得されます。

platformDataSource

PlatformDataSource

データは Google Workspace アプリケーションからのものです。

minCharactersTrigger

int32

このデータ プロバイダがトリガーされる(つまり、結果を返し始める)前にユーザーが入力する必要がある最小文字数。

DateTimePicker

ユーザーが日付、時刻、または日付と時刻の両方を入力できるようにします。フォーム送信の検証をサポートします。Action.all_widgets_are_required が true に設定されている場合、またはこのウィジェットが Action.required_widgets で指定されている場合、値が選択されない限り、送信アクションはブロックされます。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 は指定したタイムゾーンで表示されます。設定しない場合、デフォルトでユーザーのタイムゾーンの設定の値が使用されます。

注: このフィールドは分単位ですが、ユーザー インタラクション イベントのペイロードでは通常、タイムゾーン オフセットがミリ秒単位で提供されます(変換するには 60000 で割ります)。

onChangeAction

Action

ユーザーが DateTimePicker インターフェースで [保存] または [クリア] をクリックしたときにトリガーされます。

共用体フィールド data_source。日時を表すために指定されたデータソース。data_source は次のいずれかになります。
hostAppDataSource

HostAppDataSourceMarkup

Gmail のメール、Google カレンダーの予定、Google Chat のメッセージなど、Google Workspace ホスト アプリケーションに固有のデータソース。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

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

テキストの前に表示されるアイコン。

startIconVerticalAlignment

VerticalAlignment

省略可。開始アイコンの垂直方向の配置。設定しない場合、アイコンは垂直方向に中央揃えされます。

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

topLabel

string

text の上に表示されるテキスト。常に切り捨てられます。

topLabelText

TextParagraph

TextParagraph は top_label と同等です。常に切り捨てられます。top_label よりも複雑な書式設定が可能です。

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

text

string

必須。メインテキスト。

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

contentText

TextParagraph

TextParagraph は text と同等です。text よりも複雑な書式設定が可能です。

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

wrapText

bool

テキストの折り返し設定。true の場合、テキストは折り返されて複数行に表示されます。それ以外の場合、テキストは切り捨てられます。

text にのみ適用されます。topLabel と bottomLabel には適用されません。

bottomLabel

string

text の下に表示されるテキスト。常に折り返されます。

bottomLabelText

TextParagraph

TextParagraph は bottom_label と同等です。常に折り返されます。bottom_label よりも複雑な書式設定が可能です。

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

onClick

OnClick

このアクションは、ユーザーが DecoratedText ウィジェットの任意の場所(text、top_label、bottom_label、アイコンなど)をクリックしたときにトリガーされます。ただし、別のインタラクティブ コントロール(button または switch_control)をクリックした場合は除きます。

共用体フィールド control。decoratedText ウィジェットのテキストの右側に表示されるボタン、スイッチ、チェックボックス、または画像。control は次のいずれかになります。
button

Button

ユーザーがクリックしてアクションをトリガーできるボタン。

switchControl

SwitchControl

ユーザーがクリックして状態を変更し、アクションをトリガーできるスイッチ ウィジェット。

endIcon

Icon

テキストの後に表示されるアイコン。

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

SwitchControl

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

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

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

フィールド
name

string

フォーム入力イベントでスイッチ ウィジェットを識別する名前(CommonEventObject.form_inputs のキー)。

フォーム入力の操作の詳細については、フォームデータを受信するをご覧ください。

value

string

スイッチが選択されている場合に CommonEventObject.form_inputs[name].string_inputs で返される値(selected が true)。selected が true で、value が設定されていない場合、string_inputs.value で空の文字列("")が返されます。selected が false の場合、この値は string_inputs.value から省略されます。

フォーム入力の操作の詳細については、フォームデータを受信するをご覧ください。

selected

bool

true の場合、スイッチが選択され、その value が CommonEventObject.form_inputs[name].string_inputs.value に含まれます。

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 のアドオンの場合、ダイアログを閉じます。

フィールド
action

Action

Google Chat のアドオンの場合、ダイアログを閉じるアクション。

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

アクション

Google Chat のアドオンの場合、ダイアログを閉じるアクション。

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

EventAction

UI 要素に対して実行できるアクションを表します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

フィールド
actionRuleId

string

ActionRule の固有識別子。

postEventTriggers[]

Trigger

EventAction の実行後にトリガーされるトリガーのリスト。

共用体フィールド action。実行するアクション。action は次のいずれかになります。
commonWidgetAction

CommonWidgetAction

一般的なウィジェット アクション。

CommonWidgetAction

ウィジェットに固有ではないアクションを表します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

フィールド
共用体フィールド action。実行するアクション。action は次のいずれかになります。
updateVisibilityAction

UpdateVisibilityAction

ウィジェットの公開設定を更新するアクション。

UpdateVisibilityAction

ウィジェットの表示 / 非表示を更新するアクションを表します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

フィールド
visibility

Visibility

新しい公開設定。

ExpressionData

式の評価に使用されるデータを表します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

フィールド
id

string

ExpressionData の固有識別子。

expression

string

コンパイルされていない式。

conditions[]

Condition

式の評価結果によって決定される条件のリスト。

eventActions[]

EventAction

ExpressionData を使用できるアクションのリスト。

GetAutocompletionResponse

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

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。次に例を示します。

{
  "autoComplete": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}
フィールド
autoComplete

Suggestions

schema

string

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

グリッド

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

このコールバックは、個々のグリッド アイテムによって再利用されますが、アイテムの識別子がコールバックのパラメータ(キー "grid_item_identifier" の下)に追加されます。

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 タイトルとサブタイトルは、グリッド アイテムの画像の上に表示されます。

アイコン

カードのウィジェットに表示されるアイコン。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

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

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
}

ImageCropType

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

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

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

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

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

linkPreviewTitle

string

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

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 に移動し、[Customize] で設定を調整します。

weight

int32

アイコンのストロークの太さ。{100、200、300、400、500、600、700} から選択します。指定しない場合、デフォルト値は 400 です。他の値が指定されている場合は、デフォルト値が使用されます。

さまざまなアイコン設定をプレビューするには、Google Font Icons に移動し、[Customize] で設定を調整します。

grade

int32

ウェイトとグレードはシンボルの太さに影響します。グレードの調整はウェイトの調整よりもきめ細かく、シンボルのサイズに与える影響は小さくなります。{-25, 0, 200} から選択します。指定しない場合、デフォルト値は 0 です。他の値が指定されている場合は、デフォルト値が使用されます。

さまざまなアイコン設定をプレビューするには、Google Font Icons に移動し、[Customize] で設定を調整します。

ModifyCard

Google Chat のアドオンの場合、ユーザー操作に基づいてカードを更新します。配列に含めることができるオブジェクトは 1 つだけです。

フィールド
共用体フィールド operation。実行するオペレーション。operation は次のいずれかになります。
updateWidget

UpdateWidget

Google Chat のアドオンの場合、カードまたはダイアログのウィジェットを更新します。

UpdateWidget

Google Chat のアドオンの場合、カードまたはダイアログのウィジェットを更新します。ユーザーが入力ボックスに入力したときに、予測入力の候補を表示するために使用されます。詳しくは、複数選択アイテムを提案するをご覧ください。

フィールド
共用体フィールド updated_widget。ウィジェットの更新。updated_widget は次のいずれかになります。
selectionInputWidgetSuggestions

SelectionInputWidgetSuggestions

selectionInput ウィジェットの場合、複数選択メニューの候補アイテムの配列。複数選択メニューで外部データソースを使用して項目を入力する場合、ウィジェットは、メニューに入力された内容に基づいて候補を動的に入力できます。詳しくは、Google Chat ユーザーから情報を収集するをご覧ください。

SelectionInputWidgetSuggestions

複数選択メニューを使用する selectionInput ウィジェットの場合、外部の動的データソースから選択項目を返します。

フィールド
suggestions[]

SelectionItem

ユーザーが複数選択メニューに入力した後に表示される、選択可能なアイテムの配列。

カードスタック内のカードを更新またはカード間を移動します。

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

次に例を示します。

1)新しいカードを返す(次に進む)。

 navigations : {
    pushCard : CARD
  }

2)スタックの一番上のカードを更新する(インプレース更新)。

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

3)更新せずに 1 つ前のステップに戻る。

  navigations : {
    popCard : true,
  }

4) 複数のステップを戻って、そのカードを更新する。

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

5)定義済みの CARD_NAME に複数のステップを戻します。

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

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

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

7)指定されたカードをポップし、そのカードもポップします。

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

8)一番上のカードを新しいカードに交換します。

  navigations : {
    updateCard : CARD
  }
フィールド

共用体フィールド navigate_action。

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

popToRoot

bool

ルートカードを除くすべてのカードをポップします。

pop

bool

1 枚のカードをポップします。

popToCard

string

指定されたカード名を持つ指定されたカードより上のすべてのカードをポップします。

pushCard

Card

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

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

updateCard

Card

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

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

endNavigation

EndNavigation

Google Chat のアドオンの場合、ダイアログを閉じます。

通知

ユーザーがカードを操作したときに、ホストの Google Workspace アプリケーションに通知を表示するアクション。

Google Chat のアドオンの場合、ユーザーがダイアログを送信して閉じると、通知が表示されます。

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

フィールド
text

string

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

OnClick

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

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

フィールド

共用体フィールド data。

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

action

Action

指定すると、この onClick によってアクションがトリガーされます。

openDynamicLinkAction

Action

アドオンは、アクションでリンクを開く必要がある場合に、このアクションをトリガーします。これは、リンクを取得するためにサーバーと通信する必要があるという点で、上記の open_link とは異なります。そのため、ウェブ クライアントは、リンクを開くアクションのレスポンスが返される前に、いくつかの準備作業を行う必要があります。

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

card

Card

指定されている場合、クリック後に新しいカードがカードスタックにプッシュされます。

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

overflowMenu

OverflowMenu

指定すると、この onClick によってオーバーフロー メニューが開きます。

OnClose

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

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

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

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

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

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

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

OpenAs

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

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

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

OverflowMenu

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

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

フィールド
items[]

OverflowMenuItem

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

OverflowMenuItem

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

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

フィールド
startIcon

Icon

テキストの前に表示されるアイコン。

text

string

必須。ユーザーにアイテムを識別または説明するテキスト。

onClick

OnClick

必須。メニュー オプションが選択されたときに呼び出されるアクション。この OnClick に OverflowMenu を含めることはできません。指定された OverflowMenu はすべて削除され、メニュー項目は無効になります。

disabled

bool

メニュー オプションが無効かどうか。デフォルトは false です。

RenderActions

ホステッド アプリケーションに、カードのレンダリング方法や、ユーザー操作に応じたアクションの実行方法を指示する一連のレンダリング指示。

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

フィールド
action

Action

アドオンが UI の更新に使用できるアクション。

Google Chat のアドオン

hostAppAction

HostAppActionMarkup

個々のホストアプリによって処理されるアクション。

schema

string

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

アクション

アドオンがカードまたはホステッド アプリケーションで使用できるアクション。

Google Workspace アドオンで使用可能。Google Chat アプリでは使用不可。

フィールド
navigations[]

Navigation

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

Google Chat のアドオン

notification

Notification

ユーザーがカードを操作したときに、ホストの Google Workspace アプリケーションに通知を表示します。

Google Chat のアドオンの場合、ユーザーがダイアログを送信して閉じると、通知が表示されます。

linkPreview

LinkPreview

Google ドキュメント、Google スプレッドシート、Google スライドで利用できます。スマートチップとカードを使用してリンクをプレビューします。詳しくは、スマートチップを使用してリンクをプレビューするをご覧ください。

modifyOperations[]

ModifyCard

Google Chat のアドオンの場合、ユーザー操作に基づいてカードを更新します。配列に含めることができるオブジェクトは 1 つだけです。

RequestingGoogleScopes

バンドルされていない OAuth 同意が有効になっている場合、HTTP アドオンはより多くの Google OAuth スコープをリクエストする必要がある場合があります。アドオンは、このオブジェクトを返して承認カードをレンダリングする必要があります。詳細については、Manage granular permissions をご覧ください。

フィールド
scopes[]

string

アドオンがリクエストしているスコープ。

allScopes

bool

true の場合、アドオンはマニフェストからすべてのスコープをリクエストしています。この場合、scopes フィールドは空にする必要があります。

SelectionInput

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

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

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

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

フィールド
name

string

必須。フォーム入力イベントで選択入力を識別する名前。

フォーム入力の操作の詳細については、フォームデータを受信するをご覧ください。

label

string

ユーザー インターフェースの選択入力フィールドの上に表示されるテキスト。

アプリに必要な情報をユーザーが入力するのに役立つテキストを指定します。たとえば、ユーザーがプルダウン メニューから作業チケットの緊急度を選択する場合、ラベルは「緊急度」または「緊急度を選択」になります。

type

SelectionType

SelectionInput ウィジェットでユーザーに表示されるアイテムのタイプ。選択タイプは、さまざまなタイプのインタラクションをサポートしています。たとえば、ユーザーは複数のチェックボックスを選択できますが、プルダウン メニューから選択できる値は 1 つだけです。

items[]

SelectionItem

選択可能なアイテムの配列。たとえば、ラジオボタンやチェックボックスの配列です。最大 100 個のアイテムをサポートします。

onChangeAction

Action

指定すると、選択内容が変更されたときにフォームが送信されます。指定しない場合は、フォームを送信する別のボタンを指定する必要があります。

フォーム入力の操作の詳細については、フォームデータを受信するをご覧ください。

multiSelectMinQueryLength

int32

複数選択メニューの場合、メニューが選択項目の候補を返す前にユーザーが入力するテキスト文字数。

設定しない場合、複数選択メニューでは次のデフォルト値が使用されます。

  • メニューで SelectionInput 項目の静的配列を使用する場合、デフォルトは 0 文字で、配列から項目がすぐに挿入されます。
  • メニューで動的データソース(multi_select_data_source)を使用している場合、デフォルトでは 3 文字入力するとデータソースがクエリされ、候補アイテムが返されます。
dataSourceConfigs[]

DataSourceConfig

省略可。選択コントロールのデータソース構成。このフィールドを使用すると、データソースをより細かく制御できます。

指定すると、multi_select_max_selected_items フィールド、multi_select_min_query_length フィールド、external_data_source フィールド、platform_data_source フィールドは無視されます。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。

Google Chat アプリの Dropdown widget で利用できます。Google Chat アプリの Dropdown ウィジェットでは、1 つの DataSourceConfig のみがサポートされています。複数の DataSourceConfig が設定されている場合は、最初の のみが使用されます。

multiSelectMaxSelectedItems

int32

複数選択メニューの場合、ユーザーが選択できるアイテムの最大数。最小値は 1 アイテムです。指定しない場合のデフォルトは 3 項目です。

hintText

string

省略可。選択入力フィールドの下に表示されるテキスト。ユーザーに特定の値を入力するよう促すことで、ユーザーを支援することを目的としています。このテキストは常に表示されます。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

共用体フィールド 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 のスペースなど)。

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

CommonDataSource

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

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

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

SelectionItem

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

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

フィールド
text

string

ユーザーにアイテムを識別または説明するテキスト。

value

string

このアイテムに関連付けられた値。クライアントは、これをフォーム入力値として使用する必要があります。

フォーム入力の操作の詳細については、フォームデータを受信するをご覧ください。

selected

bool

デフォルトでアイテムが選択されているかどうか。選択入力で 1 つの値のみを受け入れる場合(ラジオボタンやプルダウン メニューなど)、このフィールドは 1 つの項目にのみ設定します。

bottomText

string

複数選択メニューの場合、アイテムの text フィールドの下に表示されるテキストの説明またはラベル。

共用体フィールド startIcon。複数選択メニューの場合、アイテムの text フィールドの横に表示されるアイコンの URL。PNG ファイルと JPEG ファイルをサポートしています。HTTPS URL を指定する必要があります。たとえば、https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png のようにします。startIcon は次のいずれかになります。
startIconUri

string

SelectionType

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

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

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

列挙型
CHECK_BOX 一連のチェックボックス。ユーザーは複数のチェックボックスをオンにできます。
RADIO_BUTTON ラジオボタンのセット。ユーザーはラジオボタンを 1 つ選択できます。
SWITCH スイッチのセット。ユーザーは 1 つ以上のスイッチをオンにできます。
DROPDOWN

プルダウン メニュー。ユーザーはメニューから 1 つのアイテムを選択できます。

Google Chat 用アプリでは、動的データソースを使用してアイテムを入力し、ユーザーがメニューに入力するとアイテムを自動的に提案できます。たとえば、ユーザーが Google Chat スペースの名前を入力し始めると、ウィジェットがスペースを自動的に提案します。プルダウン メニューの項目を動的に入力するには、次のいずれかのタイプのデータソースを使用します。

  • Google Workspace データ: Google Workspace ユーザーや Google Chat スペースなど、Google Workspace のデータを使用してアイテムが入力されます。
  • 外部データ: Google Workspace の外部にある外部データソースからアイテムが入力されます。

Chat アプリにプルダウン メニューを実装する方法の例については、プルダウン メニューを追加するとプルダウン メニューを動的に入力するをご覧ください。

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

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 アドオンで使用できます。

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

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

候補

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

たとえば、プログラミング言語のテキスト入力フィールドでは、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

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

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

フィールド

共用体フィールド content。

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

text

string

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

TextInput

ユーザーがテキストを入力できるフィールド。候補と変更時のアクションをサポートします。フォーム送信の検証をサポートします。Action.all_widgets_are_required が true に設定されている場合、またはこのウィジェットが Action.required_widgets で指定されている場合、値が入力されない限り、送信アクションはブロックされます。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 アプリでは使用不可。

validation

Validation

このテキスト フィールドに必要な入力形式の検証を指定します。

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

placeholderText

string

テキスト入力フィールドが空の場合に表示されるテキスト。このテキストを使用して、ユーザーに値の入力を促します。例: Enter a number from 0 to 100

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

共用体フィールド data_source。

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

hostAppDataSource

HostAppDataSourceMarkup

Gmail のメール、Google カレンダーの予定、Google Chat のメッセージなど、Google Workspace ホスト アプリケーションに固有のデータソース。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

タイプ

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

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

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

TextParagraph

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

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

フィールド
text

string

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

maxLines

int32

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

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

textSyntax

TextSyntax

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

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

TextSyntax

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

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

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

トリガー

トリガーを表します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

フィールド
actionRuleId

string

ActionRule の固有識別子。

検証

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

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

フィールド
characterLimit

int32

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

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

inputType

InputType

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

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

InputType

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

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

ウィジェット

各カードはウィジェットで構成されています。

ウィジェットは、テキスト、画像、ボタン、その他のオブジェクト タイプのいずれかを表すことができる複合オブジェクトです。

フィールド
horizontalAlignment

HorizontalAlignment

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

id

string

変更するウィジェットを識別するために使用される、ウィジェットに割り当てられた一意の ID。ID の文字数制限は 64 文字で、[a-zA-Z0-9-]+ の形式にする必要があります。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

visibility

Visibility

ウィジェットを表示するか非表示にするかを指定します。デフォルト値は VISIBLE です。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

eventActions[]

EventAction

ウィジェットで実行できるイベント アクションを指定します。

Google Workspace Studio を拡張する Google Workspace アドオンで使用できます。Google Chat アプリでは使用できません。

共用体フィールド data。ウィジェットに含めることができるのは、次のいずれかのアイテムのみです。複数のウィジェット フィールドを使用して、より多くのアイテムを表示できます。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": {
  "startIcon": {
    "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": "CHECK_BOX"
  }
}
buttonList

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

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

Carousel

CarouselCard アイテムのコレクションが含まれます。各アイテムにはネストされたウィジェットが含まれます。たとえば、次の JSON 表現は、2 つのカルーセル カードを含むカルーセルを表しています。各カードにはテキスト段落が含まれています。

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

ChipList

チップのリスト。

たとえば、次の JSON では 2 つのチップが作成されます。1 つ目はテキストチップ、2 つ目はリンクを開くアイコンチップです。

"chipList": {
  "chips": [
    {
      "label": "Edit",
      "disabled": true
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

HorizontalAlignment

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

Google Chat アプリで使用可能、Google Workspace アドオンでは使用不可。

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

ImageType

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

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

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

VerticalAlignment

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

列挙型
VERTICAL_ALIGNMENT_UNSPECIFIED タイプの指定なし。使用しないでください。
TOP 上部への配置。
MIDDLE 中央揃え。
BOTTOM 下揃え。