Google Chat アプリのインタラクション イベント。
インタラクション イベントについて詳しくは、Google Chat アプリでのインタラクションの受信と応答をご覧ください。イベントの種類やイベント ペイロードなどについて詳しくは、Google Chat アプリインタラクション イベントの種類をご覧ください。
Chat アプリは、ユーザーとのやり取りからイベントを受け取るだけでなく、スペースの変更(スペースに新しいメンバーが追加されたときなど)のイベントも受信できます。スペースのイベントについて詳しくは、Google Chat から予定を操作するをご覧ください。
JSON 表現 |
---|
{ "type": enum ( |
フィールド | |
---|---|
type |
インタラクション イベントのタイプ。詳しくは、Google Chat アプリ操作イベントの種類をご覧ください。 |
eventTime |
インタラクション イベントが発生した時間を示すタイムスタンプ。 |
token |
以前の Chat アプリで Google からのリクエストかどうかを確認するために使用できるシークレットの値。Google がトークンをランダムに生成し、その値は静的なままです。トークンの取得、取り消し、再生成は、Google Cloud コンソールの Chat API 構成ページで行えます。 最近の Chat アプリではこのフィールドを使用しません。API レスポンスと Chat API 構成ページにはありません。 |
threadKey |
インタラクション イベントに関連するスレッドの、Chat アプリで定義されるキー。詳しくは、 |
message |
インタラクション イベントをトリガーしたメッセージ(該当する場合)。 |
user |
インタラクション イベントをトリガーしたユーザー。 |
space |
インタラクション イベントが発生したスペース。 |
action |
|
configCompleteRedirectUrl |
ユーザーが Google Chat の外部で認可または設定フローを完了したら、Chat アプリがユーザーをリダイレクトする URL。詳しくは、Chat アプリを他のサービスやツールに接続するをご覧ください。 |
isDialogEvent |
|
dialogEventType |
受信したダイアログ インタラクション イベントのタイプ。 |
common |
言語 / 地域、ホストアプリ、プラットフォームなど、ユーザーのクライアントに関する情報を表します。チャットアプリの場合、 |
CommonEventObject
言語 / 地域、ホストアプリ、プラットフォームなど、ユーザーのクライアントに関する情報を表します。チャットアプリの場合、CommonEventObject
には、ダイアログで入力したデータなど、カードの操作によって送信されたデータが含まれます。
JSON 表現 |
---|
{ "userLocale": string, "hostApp": enum ( |
フィールド | |
---|---|
userLocale |
[ISO 639 言語コード]-[ISO 3166 国/地域コード] の形式の完全な |
hostApp |
アドオンの呼び出し元アプリを示す hostApp 列挙型。Chat アプリでは常に |
platform |
イベントが発生したプラットフォームを示すプラットフォームの列挙型( |
timeZone |
タイムゾーン ID と、協定世界時(UTC)からのオフセット。イベントタイプ |
formInputs |
ユーザーがカードまたはダイアログからウィジェットに入力した値を含むマップ。マップキーは各ウィジェットに割り当てられた文字列 ID で、値はウィジェットへの入力を表します。 詳しくは、ユーザーが入力したプロセス情報をご覧ください。 |
parameters |
呼び出される関数に渡されるカスタム パラメータ。キーと値はどちらも文字列にする必要があります。 |
invokedFunction |
ウィジェットに関連付けられている、呼び出される関数の名前。Chat アプリに対してのみ設定されます。 |
TimeZone
タイムゾーン ID と、協定世界時(UTC)からのオフセット。イベントタイプ CARD_CLICKED
と SUBMIT_DIALOG
でのみサポートされています。
JSON 表現 |
---|
{ "id": string, "offset": integer } |
フィールド | |
---|---|
id |
IANA TZ タイムゾーン データベース コード(「America/Toronto」など)。 |
offset |
協定世界時(UTC)からのユーザーのタイムゾーン オフセット(ミリ秒単位)。 |
入力
ユーザーがカードやダイアログに入力できるデータの種類。入力タイプは、ウィジェットが受け入れる値のタイプによって異なります。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド
|
|
stringInputs |
ユーザーがウィジェットに入力した値を表す文字列のリスト。 ウィジェットが 1 つの値のみを受け入れる場合( |
dateTimeInput |
日付と時刻の両方を受け入れる |
dateInput |
日付値のみを受け入れる |
timeInput |
時間値のみを受け入れる |
StringInputs
通常のウィジェットの入力パラメータ。単一値ウィジェットの場合は単一値リストです。複数の値を持つウィジェット(チェックボックスなど)の場合は、すべての値が表示されます。
JSON 表現 |
---|
{ "value": [ string ] } |
フィールド | |
---|---|
value[] |
ユーザーが入力した文字列のリスト。 |
DateTimeInput
日付と時刻の入力値。
JSON 表現 |
---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
フィールド | |
---|---|
msSinceEpoch |
エポック時刻からの経過時間(ミリ秒)。 |
hasDate |
|
hasTime |
|
DateInput
日付入力値。
JSON 表現 |
---|
{ "msSinceEpoch": string } |
フィールド | |
---|---|
msSinceEpoch |
エポック時刻からの経過時間(ミリ秒)。 |
TimeInput
時間入力値。
JSON 表現 |
---|
{ "hours": integer, "minutes": integer } |
フィールド | |
---|---|
hours |
24 時間制の時間。 |
minutes |
1 時間後の分数。有効な値は 0 ~ 59 です。 |