Button

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

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

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

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

string

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

icon

object (Icon)

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

color

object (Color)

省略可。ボタンの色。設定すると、ボタン type が FILLED に設定され、text フィールドと icon フィールドの色が、読みやすさを考慮して対照的な色に設定されます。たとえば、ボタンの色が青に設定されている場合、ボタン内のテキストやアイコンは白に設定されます。

ボタンの色を設定するには、red、green、blue の各フィールドに値を指定します。値は、RGB 色値に基づく 0 ~ 1 の浮動小数点数にする必要があります。0(0/255)は色がないことを表し、1(255/255)は色の最大強度を表します。

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

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

ボタンの色に alpha フィールドは使用できません。指定した場合、このフィールドは無視されます。

onClick

object (OnClick)

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

disabled

boolean

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

altText

string

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

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

type

enum (Type)

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

タイプ

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

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

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