注
アダプティブ カードを利用して、Copilot、Teams、または Outlook のシナリオを構築していますか? アダプティブ カードのニーズに合った新しいワンストップ ショップであるアダプティブ カード ドキュメント ハブをご覧ください。 レスポンシブ レイアウト、アイコン、バッジ、カルーセル、グラフなど、多くの新機能に関する完全なドキュメントを含め、探しているすべてのリソースが用意されています。
入力フィールドを収集し、オプションのデータ フィールドとマージし、イベントをクライアントに送信します。 クライアントは、 adaptiveCard/action 型の Invoke アクティビティをターゲット ボットに送信することで、イベントを処理します。 収集される入力は現在のカード上のものです。ショーカードについては、親カード上のものも含まれます。 詳細については、 ユニバーサル アクション モデル のドキュメントを参照してください。
アクセシビリティに関する重要な注意事項: スキーマのバージョン 1.3 では、アクセシビリティを向上させるために、入力に ラベル プロパティを導入しました。 ターゲットとするホスト アプリで v1.3 がサポートされている場合は、次のサンプルに示すように、TextBlock の代わりにラベルを使用する必要があります。 ほとんどのホスト アプリが最新バージョンに更新されたら、それに応じてサンプルを更新します。
Action.Execute
バージョン 1.4 で導入されました
Action.Execute プロパティ
| プロパティ | タイプ | 必須 | Description | バージョン |
|---|---|---|---|---|
| type | "Action.Execute" |
イエス |
"Action.Execute"である必要があります。 |
1.4 |
| 動詞 | string |
いいえ | このアクションに関連付けられているカード作成者定義の動詞。 | 1.4 |
| データ |
string、object |
いいえ | 入力フィールドが結合される初期データ。 これらは基本的に "非表示" プロパティです。 | 1.4 |
| associatedInputs | AssociatedInputs |
いいえ。既定値: "auto" |
アクションに関連付けられている入力を制御します。 | 1.4 |
継承されたプロパティ
| プロパティ | タイプ | 必須 | Description | バージョン |
|---|---|---|---|---|
| タイトル | string |
いいえ | このアクションを表すボタンまたはリンクのラベル。 | 1.4 |
| iconUrl | uri |
いいえ | タイトルと組み合わせてアクションに表示されるオプションのアイコン。 バージョン 1.2 以降のデータ URI をサポート | 1.1 |
| ID | string |
いいえ | このアクションに関連付けられている一意の識別子。 | 1.4 |
| スタイル | ActionStyle |
いいえ | アクションのスタイルを制御します。アクションの表示方法、読み上げ方法などに影響します。 | 1.2 |
| フォールバック |
Action、FallbackOption |
いいえ | 不明な要素が検出された場合、またはこの要素またはすべての子の要求が満たされない場合の処理について説明します。 | 1.2 |
| ツールヒント | string |
いいえ | エンド ユーザーがアクションの上にマウス ポインターを置き、ナレーション ソフトウェアを使用するときに読み取るときに表示するテキストを定義します。 | 1.5 |
| isEnabled | boolean |
いいえ。既定値: true |
アクションを有効にするかどうかを決定します。 | 1.5 |
| mode | ActionMode |
いいえ。既定値: "primary" |
アクションをボタンとして表示するか、オーバーフロー メニューに表示するかを決定します。 | 1.5 |
| 必要 | Dictionary<string> |
いいえ | 項目に必要な機能と、対応する最小バージョンを示す一連のキーと値のペア。 機能が不足しているか、バージョンが不十分な場合は、フォールバックがトリガーされます。 | 1.2 |
Example
例 1: 基本的な Action.Execute
| JSON | アダプティブ カード |
|---|---|
json { "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "type": "AdaptiveCard", "version": "1.4", "body": [ { "type": "TextBlock", "text": "Present a form and submit it back to the originator" }, { "type": "Input.Text", "id": "firstName", "label": "What is your first name?" }, { "type": "Input.Text", "id": "lastName", "label": "What is your last name?" } ], "actions": [ { "type": "Action.Execute", "title": "Action.Execute", "verb": "doStuff", "data": { "x": 13 } } ] } |
[アダプティブ カードを自分で試す >] |
プロパティ
verb (バージョン 1.4)
このアクションに関連付けられているカード作成者定義の動詞。
-
型:
string - 必須: いいえ
data (バージョン 1.4)
入力フィールドが結合される初期データ。 これらは基本的に "非表示" プロパティです。
-
型:
string、object - 必須: いいえ
associatedInputs (バージョン 1.4)
アクションに関連付けられている入力を制御します。
-
型:
AssociatedInputs -
必須: いいえ、既定値:
"auto" -
使用できる値:
-
"Auto": 現在のカードと親カードの入力が検証され、このアクションに対して送信されます。 -
"None": このアクションに対して検証または送信される入力はありません。
-
title (バージョン 1.4)
このアクションを表すボタンまたはリンクのラベル。
-
型:
string - 必須: いいえ
iconUrl (バージョン 1.1)
タイトルと組み合わせてアクションに表示されるオプションのアイコン。 バージョン 1.2 以降のデータ URI をサポート
-
型:
uri - バージョン : 1.1
- 必須: いいえ
id (バージョン 1.4)
このアクションに関連付けられている一意の識別子。
-
型:
string - 必須: いいえ
style (バージョン 1.2)
アクションのスタイルを制御します。これにより、アクションの表示方法や読み上げ方法など、さまざまな面が影響を受けます。
-
型:
ActionStyle - バージョン : 1.2
- 必須: いいえ
-
使用できる値:
-
"default": アクションは通常どおりに表示されます -
"positive": アクションは正のスタイルで表示されます (通常、ボタンはアクセント カラーになります)。 -
"destructive": アクションは破壊的なスタイルで表示されます (通常、ボタンは赤になります)
-
フォールバック (バージョン 1.2)
不明な要素が検出された場合、またはこの要素またはすべての子の要求が満たされない場合の処理について説明します。
-
型:
Action、FallbackOption - バージョン : 1.2
- 必須: いいえ
-
使用できる値:
Action.ExecuteAction.OpenUrlAction.ShowCardAction.SubmitAction.ToggleVisibility-
"drop": 不明な要素が検出されると、すぐにこの要素が削除されます。 不明な要素はそれ以上バブルアップしません。
ツールヒント (バージョン 1.5)
エンド ユーザーがアクションの上にマウス ポインターを置き、ナレーション ソフトウェアを使用するときに読み取るときに表示するテキストを定義します。
| JSON | アダプティブ カード |
|---|---|
json { "type": "AdaptiveCard", "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "version": "1.5", "body": [ { "label": "Please enter your name below:", "type": "Input.Text", "id": "name" } ], "actions": [ { "type": "Action.Execute", "title": "Submit", "tooltip": "Click here to add your name to the waiting list." } ] } |
[アダプティブ カードを自分で試す >] |
-
型:
string - バージョン : 1.5
- 必須: いいえ
isEnabled (バージョン 1.5)
アクションを有効にするかどうかを決定します。
| JSON | アダプティブ カード |
|---|---|
json { "type": "AdaptiveCard", "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "version": "1.5", "body": [ { "type": "TextBlock", "text": "Disabled Execute Button", "wrap": true } ], "actions": [ { "type": "Action.Execute", "title": "Enabled" }, { "type": "Action.Execute", "title": "Disabled", "isEnabled": false } ] } |
[アダプティブ カードを自分で試す >] |
-
型:
boolean - バージョン : 1.5
-
必須: いいえ、既定値:
true
mode (バージョン 1.5)
アクションをボタンとして表示するか、オーバーフロー メニューに表示するかを決定します。
| JSON | アダプティブ カード |
|---|---|
json { "type": "AdaptiveCard", "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "version": "1.5", "body": [ { "type": "TextBlock", "text": "Please confirm your data:", "wrap": true, "style": "heading" }, { "type": "FactSet", "facts": [ { "title": "First Name", "value": "John" }, { "title": "Last Name", "value": "Smith" }, { "title": "Phone number ", "value": "(555) 555-5555" } ] } ], "actions": [ { "type": "Action.Execute", "title": "Confirm data" }, { "type": "Action.Execute", "title": "Edit data", "data": "edit", "mode": "secondary" }, { "type": "Action.Execute", "title": "Delete data", "data": "delete", "mode": "secondary" } ] } |
[アダプティブ カードを自分で試す >] |
-
型:
ActionMode - バージョン : 1.5
-
必須: いいえ、既定値:
"primary" -
使用できる値:
-
"primary": アクションがボタンとして表示されます。 -
"secondary": アクションはオーバーフロー メニュー (通常は...ボタンの下のポップアップ メニュー) に配置されます。
-
requires (バージョン 1.2)
項目に必要な機能と、対応する最小バージョンを示す一連のキーと値のペア。 機能が不足しているか、バージョンが不十分な場合は、フォールバックがトリガーされます。
-
型:
Dictionary<string> - バージョン : 1.2
- 必須: いいえ