パブリック開発者プレビュー アプリ マニフェスト スキーマ
開発者プレビューを有効にする方法については、「Microsoft Teams のパブリック開発者プレビュー」を参照してください。
注:
Outlook および Microsoft 365 アプリで Teams 個人用タブやメッセージ拡張機能を実行するなど、開発者プレビュー機能を使用していない場合は、代わりにアプリ マニフェスト (以前は Teams アプリ マニフェスト) を使用して一般公開 (GA) 機能を使用してください。
アプリ マニフェストでは、アプリを Microsoft Teams プラットフォームに統合する方法について説明します。 アプリ マニフェストは、https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json
でホストされているスキーマに準拠している必要があります。
サンプル アプリ マニフェスト
{
"$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json",
"manifestVersion": "devPreview",
"version": "1.0.0",
"id": "%MICROSOFT-APP-ID%",
"devicePermissions": [
"geolocation",
"media"
],
"developer": {
"name": "Publisher Name",
"websiteUrl": "https://website.com/",
"privacyUrl": "https://website.com/privacy",
"termsOfUseUrl": "https://website.com/app-tos",
"mpnId": "1234567890"
},
"localizationInfo": {
"defaultLanguageTag": "es-es",
"additionalLanguages": [
{
"languageTag": "en-us",
"file": "en-us.json"
}
]
},
"name": {
"short": "Name of your app (<=30 chars)",
"full": "Full name of app, if longer than 30 characters"
},
"description": {
"short": "Short description of your app",
"full": "Full description of your app"
},
"icons": {
"outline": "%FILENAME-32x32px%",
"color": "%FILENAME-192x192px",
"color32x32": "%FILENAME-32x32px%"
},
"accentColor": "%HEX-COLOR%",
"configurableTabs": [
{
"configurationUrl": "https://contoso.com/teamstab/configure",
"canUpdateConfiguration": true,
"scopes": [
"team",
"groupchat"
],
"context": []
}
],
"staticTabs": [
{
"entityId": "idForPage",
"name": "Display name of tab",
"contentUrl": "https://contoso.com/content?host=msteams",
"contentBotId": "Specifies to the app that tab is an Adaptive Card Tab. You can either provide the contentBotId or contentUrl.",
"websiteUrl": "https://contoso.com/content",
"scopes": [
"personal"
]
}
],
"bots": [
{
"botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
"needsChannelSelector": false,
"isNotificationOnly": false,
"scopes": [
"team",
"personal",
"groupchat"
],
"supportsFiles": true,
"commandLists": [
{
"scopes": [
"team",
"groupchat"
],
"commands": [
{
"title": "Command 1",
"description": "Description of Command 1"
},
{
"title": "Command N",
"description": "Description of Command N"
}
]
},
{
"scopes": [
"personal",
"groupchat"
],
"commands": [
{
"title": "Personal command 1",
"description": "Description of Personal command 1"
},
{
"title": "Personal command N",
"description": "Description of Personal command N"
}
]
}
]
}
],
"connectors": [
{
"connectorId": "GUID-FROM-CONNECTOR-DEV-PORTAL%",
"configurationUrl": "https://contoso.com/teamsconnector/configure",
"scopes": [
"team"
]
}
],
"composeExtensions": [
{
"botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
"canUpdateConfiguration": true,
"commands": [
{
"id": "exampleCmd1",
"title": "Example Command",
"description": "Command Description; e.g., Search on the web",
"initialRun": true,
"type": "search",
"context": [
"compose",
"commandBox"
],
"parameters": [
{
"name": "keyword",
"title": "Search keywords",
"description": "Enter the keywords to search for"
}
]
},
{
"id": "exampleCmd2",
"title": "Example Command 2",
"description": "Command Description; e.g., Search for a customer",
"initialRun": true,
"type": "action",
"fetchTask": true,
"context": [
"message"
],
"parameters": [
{
"name": "custinfo",
"title": "Customer name",
"description": "Enter a customer name",
"inputType": "text"
}
]
},
{
"id": "exampleMessageHandler",
"title": "Message Handler",
"description": "Domains that will create a preview when pasted into the compose box",
"messageHandlers": [
{
"type": "link",
"value": {
"domains": [
"mysite.someplace.com",
"othersite.someplace.com"
]
}
}
]
}
]
}
],
"permissions": [
"identity",
"messageTeamMembers"
],
"validDomains": [
"contoso.com",
"mysite.someplace.com",
"othersite.someplace.com"
],
"webApplicationInfo": {
"id": "AAD App ID",
"resource": "Resource URL for acquiring auth token for SSO"
},
"authorization": {
"permissions": {
"resourceSpecific": [
{
"type": "Application",
"name": "ChannelSettings.Read.Group"
},
{
"type": "Delegated",
"name": "ChannelMeetingParticipant.Read.Group"
}
]
}
},
"configurableProperties": [
"name",
"shortDescription",
"longDescription",
"smallImageUrl",
"largeImageUrl",
"accentColor",
"developerUrl",
"privacyUrl",
"termsOfUseUrl"
],
"defaultInstallScope": "meetings",
"defaultGroupCapability": {
"meetings": "tab",
"team": "bot",
"groupchat": "bot"
},
"subscriptionOffer": {
"offerId": "publisherId.offerId"
},
"meetingExtensionDefinition": {
"scenes": [
{
"id": "9082c811-7e6a-4174-8173-6ccd57d377e6",
"name": "Getting started sample",
"file": "scenes/sceneMetadata.json",
"preview": "scenes/scenePreview.png",
"maxAudience": 15,
"seatsReservedForOrganizersOrPresenters": 0
},
{
"id": "afeaed22-f89b-48e1-98b4-46a514344e4a",
"name": "Sample-1",
"file": "scenes/sceneMetadata.json",
"preview": "scenes/scenePreview.png",
"maxAudience": 15,
"seatsReservedForOrganizersOrPresenters": 3
}
]
}
}
スキーマは次のプロパティを定義します。
$schema
省略可能ですが、推奨 – 文字列
https://
アプリ マニフェストの JSON スキーマを参照する URL。
manifestVersion
必須 – 文字列
このマニフェストで使用されているアプリ マニフェスト スキーマのバージョン。
version
必須 – 文字列
特定のアプリのバージョン。 アプリ マニフェストで何かを更新する場合は、バージョンもインクリメントする必要があります。 これにより、新しいアプリ マニフェストがインストールされると、既存のマニフェストが上書きされ、ユーザーは新しい機能を取得します。 このアプリが Microsoft Teams ストアに送信された場合は、新しいアプリ マニフェストを再送信して再検証する必要があります。 その後、このアプリのユーザーは、承認された後、数時間後に新しい更新されたアプリ マニフェストを自動的に取得します。
アプリが要求したアクセス許可が変更された場合、ユーザーはアプリのアップグレードと再同意を求められます。
このバージョン文字列は、semver 標準 (MAJOR.MINOR.PATCH) に従う必要があります。
注:
アプリに Office アドインが含まれている場合、バージョン文字列の各セグメントは最大 5 桁に制限されます。 semver Standard のプレリリースおよびメタデータ バージョンの文字列拡張機能はサポートされていません。
id
必須 – Microsoft アプリ ID
Microsoft が生成したこのアプリの一意の識別子。 ID の形式は GUID です。 Microsoft Bot Frameworkを使用してボットを登録した場合、またはタブの Web アプリが既に Microsoft にサインインしている場合は、既に ID があり、ここで入力する必要があります。 それ以外の場合は、Microsoft アプリケーション登録ポータル (マイ アプリケーション) で新しい ID を生成し、ここに入力してから、 ボットを追加するときに再利用する必要があります。
developer
必須 – オブジェクト
会社に関する情報を指定します。 Microsoft AppSource (旧称 Office Store) に送信されたアプリの場合、これらの値は AppSource エントリの情報と一致する必要があります。
名前 | 最大サイズ | 必須 | 説明 |
---|---|---|---|
name |
32 文字 | ✔️ | 開発者の表示名。 |
websiteUrl |
2048 文字 | ✔️ | 開発者の Web サイトの The https:// URL。 このリンクは、ユーザーを会社または製品固有のランディング ページに移動する必要があります。 |
privacyUrl |
2048 文字 | ✔️ | 開発者のプライバシー ポリシーの https:// URL。 |
termsOfUseUrl |
2048 文字 | ✔️ | 開発者の使用条件の https:// URL。 |
mpnId |
10 文字 | 省略可能 アプリを構築しているパートナー組織を識別するMicrosoft パートナー ネットワーク ID。 |
localizationInfo
省略可能 – オブジェクト
既定の言語の指定と、追加の言語ファイルへのポインターを許可します。 ローカリゼーションを参照してください。
名前 | 最大サイズ | 必須 | 説明 |
---|---|---|---|
defaultLanguageTag |
4 文字 | ✔️ | この最上位レベルのアプリ マニフェスト ファイル内の文字列の言語タグ。 |
localizationInfo.additionalLanguages
追加の言語翻訳を指定するオブジェクトの配列。
名前 | 最大サイズ | 必須 | 説明 |
---|---|---|---|
languageTag |
4 文字 | ✔️ | 提供されたファイルの文字列の言語タグ。 |
file |
2048 文字 | ✔️ | 翻訳された文字列を含む.json ファイルへの相対ファイル パス。 |
name
必須 – オブジェクト
Teams エクスペリエンスでユーザーに表示されるアプリ エクスペリエンスの名前。 AppSource に送信されるアプリの場合、これらの値は AppSource エントリの情報と一致する必要があります。 short
と full
の値は異なっている必要があります。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
short |
String | 30 文字 | ✔️ | アプリの短い表示名。 |
full |
String | 100 文字 | ✔️ | アプリの完全な名前。 完全なアプリ名が 30 文字を超える場合に使用されます。 |
説明
必須 – オブジェクト
アプリについてユーザーに説明します。 AppSource に送信されるアプリの場合、これらの値は AppSource エントリの情報と一致する必要があります。
説明が、あなたの経験を正確に説明し、潜在的な顧客があなたの経験が何かを理解するのに役立つ情報を提供することを確認してください。 外部アカウントを使用する必要がある場合は、完全な説明にするよう気を配る必要があります。 short
と full
の値は異なっている必要があります。 短い説明を長い説明の中で繰り返すことはできません。また、他のアプリ名を含めることはできません。
名前 | 最大サイズ | 必須 | 説明 |
---|---|---|---|
short |
80 文字 | ✔️ | スペースが限られている場合に使用される、アプリ エクスペリエンスの簡単な説明。 |
full |
4,000 文字 | ✔️ | アプリの完全な説明。 |
アイコン
必須 – オブジェクト
Teams アプリ内で使用されるアイコン。 アイコン ファイルは、アップロード パッケージの一部として含まれている必要があります。
名前 | 最大サイズ | 必須 | 説明 |
---|---|---|---|
outline |
2048 文字 | ✔️ | 透明な 32x32 PNG アウトライン アイコンへの相対ファイル パス。 罫線の色は白にする必要があります。 |
color |
2048 文字 | ✔️ | フル カラーの 192x192 PNG アイコンへの相対ファイル パス。 |
color32x32 |
2048 文字 | 透明な背景を持つフルカラーの32x32 PNGアイコンへの相対ファイルパス。 Outlook と Microsoft 365 アプリでアプリがピン留めされている場合に使用されます。 |
accentColor
必須 – 文字列
アウトライン アイコンの背景として と を使用する色。
値は、'#' で始まる有効な HTML カラー コードである必要があります (例; #4464ee
)。
configurableTabs
省略可能 – 配列
アプリ エクスペリエンスにチーム チャネル タブ エクスペリエンスがあり、追加する前に追加の構成が必要な場合に使用されます。 構成可能なタブはチーム スコープでのみサポートされており、現在、アプリごとに 1 つのタブのみがサポートされています。
オブジェクトは、型 object
のすべての要素を含む配列です。 このブロックは、構成可能なチャネル タブ ソリューションを提供するソリューションにのみ必要です。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
configurationUrl |
String | 2048 文字 | ✔️ | タブを構成するときに使用する https:// URL。 |
canUpdateConfiguration |
ブール値 | タブの構成のインスタンスを作成後にユーザーが更新できるかどうかを示す値。 既定値: true |
||
scopes |
列挙型の配列 | 2 | ✔️ | 現在、構成可能なタブは、team スコープと groupChat スコープのみをサポートしています。 |
context |
列挙型の配列 | 8 | タブがサポートされているcontextItem スコープのセット。 既定値: channelTab 、、privateChatTab 、、meetingChatTab 、meetingSidePanel meetingDetailsTab 、、personalTab meetingStage 。 |
|
sharePointPreviewImage |
String | 2048 文字 | SharePoint で使用するためのタブ プレビュー画像への相対ファイル パス。 サイズは 1024x768 です。 | |
supportedSharePointHosts |
列挙型の配列 | 2 | タブを SharePoint で使用できるようにする方法を定義します。 オプションは、 です sharePointFullPage 。 sharePointWebPart |
|
meetingSurfaces |
列挙型の配列 | 2 | タブが meetingSurfaceItem 属するスコープのセット。 既定値: sidePanel 、 stage |
|
supportedPlatform |
列挙型の配列 | 3 | タブが supportedPlatform 属するスコープのセット。 既定値: desktop 、、 mobile 。 teamsMeetingDevices |
staticTabs
省略可能 – 配列
ユーザーが手動で追加せずに、既定で "ピン留め" できるタブのセットを定義します。 personal
スコープで宣言された静的タブは、常にアプリの個人的なエクスペリエンスに固定されます。 team
スコープで宣言された静的タブは現在サポートされていません。
staticTabs ブロックで contentUrl
の代わりに contentBotId
を指定して、アダプティブ カードを使用してタブをレンダリングします。
オブジェクトは配列で (要素は最大で 16 つ)、object
タイプのすべての要素が含まれます。 このブロックは、静的タブ ソリューションを提供するソリューションにのみ必要です。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
entityId |
String | 64 文字 | ✔️ | タブが表示されるエンティティの一意の識別子。 |
name |
String | 128 文字 | ✔️ | タブの表示名。 |
contentUrl |
String | 2048 文字 | ✔️ | Teams キャンバスに表示されるエンティティ UI を指す https:// URL。 |
contentBotId |
String | Bot Framework ポータルでボットに指定された Microsoft Teams アプリ ID。 | ||
websiteUrl |
String | 2048 文字 | ユーザーがブラウザでの表示を選択した場合に示す https:// URL。 | |
scopes |
列挙型の配列 | 3 | ✔️ | 静的タブでは、team スコープgroupChat がpersonal サポートされています。つまり、個人用、グループ チャット、チャネル会議エクスペリエンスの一部としてプロビジョニングできます。 |
searchUrl |
String | 2048 文字 | ユーザーの検索クエリを指示する https:// URL。 | |
context |
列挙型の配列 | 8 | タブが contextItem 属するスコープのセット。 既定値: personalTab 、、channelTab 、privateChatTab 、、meetingChatTab 、meetingSidePanel meetingDetailsTab 、、 meetingStage teamLevelApp |
|
supportedPlatform |
列挙型の配列 | 3 | タブが supportedPlatform 属するスコープのセット。 既定値: desktop 、、 mobile 。 teamsMeetingDevices |
ボット
省略可能 – 配列
既定のコマンド プロパティなどのオプション情報とともに、ボット ソリューションを定義します。
オブジェクトは配列です (最大 1 つの要素のみ(現在、アプリごとに 1 つのボットのみが許可されています)、型 object
のすべての要素を持ちます。 このブロックは、ボット エクスペリエンスを提供するソリューションにのみ必要です。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
botId |
String | ✔️ | Bot Framework に登録された、ボット用の一意の Microsoft アプリ ID。 ID は、全体的なアプリ ID と同じにすることができます。 | |
needsChannelSelector |
ブール型 | ボットがユーザー ヒントを利用してボットを特定のチャネルに追加するかどうかを示します。 既定値: false |
||
isNotificationOnly |
Boolean | ボットが会話ボットではなく、一方向性の通知専用ボットなのかどうかを示します。 既定値: false |
||
supportsFiles |
Boolean | パーソナル チャットでのファイルのアップロード/ダウンロード機能をボットでサポートするかどうかを示します。 既定値: false |
||
scopes |
列挙型の配列 | 3 | ✔️ | ボットがエクスペリエンスを提供するのは、team 内のチャネルのコンテキスでなのか、グループ チャット (groupChat ) でなのか、あるいは個別のユーザーのみをエクスペリエンスの対象にする (personal ) のかを指定します。 これらのオプションは、排他的ではありません。 |
supportsCalling |
ブール値 | ボットが音声通話をサポートしている場所を示す値。 重要: このプロパティは現在実験中です。 試験的なプロパティは不完全であり、完全に使用可能になる前に変更が加えられる可能性があります。 このプロパティは、テストと探索の目的でのみ提供されており、本番アプリケーションで使用することはできません。 既定値: false |
||
supportsVideo |
Boolean | ボットがビデオ通話をサポートしている場所を示す値。 重要: このプロパティは現在実験中です。 試験的なプロパティは不完全であり、完全に使用可能になる前に変更が加えられる可能性があります。 このプロパティは、テストと探索の目的でのみ提供されており、本番アプリケーションで使用することはできません。 既定値: false |
||
requiresSecurityEnabledGroup |
ブール型 | チームの Office グループをセキュリティを有効にする必要があるかどうかを示す値。 既定値: false |
bots.configuration
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
team.fetchTask |
ブール型 | ✔️ | ダイアログ (TeamsJS v1.x ではタスク モジュールと呼ばれます) を動的にフェッチする必要があるかどうかを示すブール値。 既定値: false |
|
team.taskInfo.title |
String | 64 文字 | ✔️ | 最初のダイアログ タイトル。 |
team.taskInfo.width |
String | 16 | ダイアログの幅は、ピクセル単位の数値か、 などのlarge medium small 既定のレイアウトです。 |
|
team.taskInfo.height |
String | 16 | ダイアログの高さは、ピクセル単位の数値か、 などのlarge medium small 既定のレイアウトです。 |
|
team.taskInfo.url |
String | 2048 文字 | 初期 Web ビュー URL。 | |
groupChat.fetchTask |
ブール型 | ✔️ | ダイアログを動的にフェッチする必要があるかどうかを示すブール値。 既定値: false |
|
groupChat.taskInfo |
オブジェクト | フェッチ タスクが false に設定されたときに起動されるダイアログ。 既定値: false |
||
groupChat.taskInfo.title |
String | 64 文字 | ✔️ | 最初のダイアログ タイトル。 |
groupChat.taskInfo.width |
String | 16 | ダイアログの幅は、ピクセル単位の数値か、 などのlarge medium small 既定のレイアウトです。 |
|
groupChat.taskInfo.height |
String | 16 | ダイアログの高さは、ピクセル単位の数値か、 などのlarge medium small 既定のレイアウトです。 |
|
groupChat.taskInfo.url |
String | 2048 文字 | 初期 Web ビュー URL。 |
bots.commandLists
ボットがユーザーに推奨できるコマンドのオプションの一覧。 オブジェクトは、型 object
のすべての要素を持つ配列 (最大 2 つの要素) です。ボットがサポートするスコープごとに個別のコマンド リストを定義する必要があります。 詳細については、「ボット メニュー」を参照してください。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
items.scopes |
列挙型の配列 | 3 | ✔️ | コマンド リストが有効なスコープを指定します。 team 、personal 、groupChat の中から選択できます。 |
items.commands |
オブジェクトの配列 | 10 | ✔️ | ボットがサポートするコマンドの配列:title : ボット コマンドの名前 (文字列、32)。description : コマンド構文とその引数 (文字列、128) の簡単な説明または例。 |
コネクタ
省略可能 – 配列
ブロックはconnectors
、アプリのMicrosoft 365 グループ用のコネクタを定義します。
オブジェクトは配列で (要素は最大で 1 つ)、object
タイプのすべての要素が含まれます。 このブロックは、Connector を提供するソリューションにのみ必要です。 サポートされているコネクタは、アプリごとに 1 つだけです。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
configurationUrl |
String | 2048 文字 | ✔️ | インライン構成エクスペリエンスを使用してコネクタを構成するときに使用する https:// URL。 |
connectorId |
String | 64 文字 | ✔️ | コネクタ開発者ダッシュボードの ID に一致するコネクタの一意の識別子です。 |
scopes |
列挙型の配列 | 1 | ✔️ | コネクタがエクスペリエンスを提供するのは、team 内のチャネルのコンテキスでなのか、個別のユーザーのみをエクスペリエンスの対象にする (personal ) のかを指定します。 現在、team スコープだけがサポートされています。 |
composeExtensions
省略可能 – 配列
アプリのメッセージ拡張機能を定義します。
注:
機能の名前は 2017 年 11 月に "compose extension" から "message extension" に変更されましたが、既存の拡張機能が引き続き機能するように、アプリ マニフェスト名は変わりません。
オブジェクトは配列で (要素は最大で 1 つ)、object
タイプのすべての要素が含まれます。 このブロックは、メッセージ拡張機能を提供するソリューションにのみ必要です。
名前 | 種類 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
botId |
String | ボット フレームワークに登録されている、メッセージ拡張機能をサポートするボットの一意の Microsoft アプリ ID。 ID は、全体的なアプリ ID と同じにすることができます。 | ||
composeExtensionType |
String | compose 拡張機能の型。 列挙値は botBased と apiBased です。 |
||
authorization |
オブジェクト | 2 | API ベースのメッセージ拡張機能の承認に関する情報 | |
authorization.authType |
String | 可能な承認の種類の列挙型。 サポートされる値は、 none 、 apiSecretServiceAuth 、および microsoftEntra です。 |
||
authorization.microsoftEntraConfiguration |
オブジェクト | microsoftEntra 認証フローを実行するために必要なオブジェクトキャプチャの詳細。 認証の種類が である microsoftEntra 場合にのみ適用されます。 |
||
authorization.microsoftEntraConfiguration.supportsSingleSignOn |
ブール値 | シングル サインオンがアプリ用に構成されているかどうかを示す値。 | ||
authorization.apiSecretServiceAuthConfiguration |
オブジェクト | サービス認証を実行するために必要なオブジェクトキャプチャの詳細。認証の種類が である apiSecretServiceAuth 場合にのみ適用されます。 |
||
authorization.apiSecretServiceAuthConfiguration.apiSecretRegistrationId |
String | 128 文字 | 開発者が開発者ポータルを介して API キーを送信したときに返される登録 ID。 | |
apiSpecificationFile |
String | 2048 文字 | マニフェスト パッケージ内の API 仕様ファイルへの相対ファイル パス。 | |
canUpdateConfiguration |
ブール型 | メッセージ拡張機能の構成をユーザーが更新できるかどうかを示す値。 既定値: true |
||
commands |
オブジェクトの配列 | 10 | メッセージ拡張機能がサポートするコマンドの配列。 | |
messageHandlers |
オブジェクトの配列 | 5 | 特定の条件が満たされた場合にアプリを呼び出すことができるハンドラーの一覧。 ドメインも に validDomains 一覧表示する必要があります。 |
|
messageHandlers.type |
String | メッセージ ハンドラーの種類。 "link" である必要があります。 |
||
messageHandlers.value.domains |
文字列 (String) の配列 | 2048 文字 | リンク メッセージ ハンドラーが登録できるドメインの配列。 | |
messageHandlers.supportsAnonymizedPayloads |
ブール型 | アプリのリンク メッセージ ハンドラーが匿名呼び出しフローをサポートするかどうかを示すブール値。 既定値: false リンク展開のゼロ インストールを有効にするには、値を に設定する true 必要があります。 注: プロパティ supportAnonymousAccess は に supportsAnonymizedPayloads 置き換えられます。 |
||
type |
compose 拡張機能の型。 サポートされる値は または apiBased botBased です。 |
composeExtensions.commands
メッセージ拡張機能では、1 つ以上のコマンドを宣言する必要があります。 各コマンドは、UI ベースのエントリ ポイントからの潜在的な相互作用として Teams に表示されます。 最大 10 個のコマンドがあります。
各コマンド 項目は、次の構造を持つオブジェクトです。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
id |
String | 64 文字 | ✔️ | コマンドの ID。 |
type |
String | 64 文字 | コマンドの種類。 query または action のいずれか。 既定: query |
|
samplePrompts |
配列 | 5 | いいえ | プラグインでサポートされているプロンプトをユーザーに表示するために Copilot によって使用されるプロパティ。 |
samplePrompts.text |
string | 128 文字 | ✔️ | サンプル プロンプトの内容。 |
apiResponseRenderingTemplateFile |
String | 2048 文字 | 開発者の API からアダプティブ カード応答への JSON 応答の書式設定に使用される API 応答レンダリング テンプレート ファイルの相対ファイル パス。 | |
context |
文字列 (String) の配列 | 3 文字 | メッセージ拡張機能の呼び出し先を定義します。 compose 、commandBox 、message の任意の組み合わせ。 既定値: compose, commandBox |
|
title |
String | 32 文字 | ✔️ | ユーザーフレンドリーなコマンド名。 |
description |
String | 128 文字 | このコマンドの目的を示すためにユーザーに表示される説明。 | |
semanticDescription |
String | 5000 文字 | 大規模言語モデル (LLM) を使用した Copilot による使用のためのコマンドのセマンティック記述。 | |
initialRun |
ブール型 | コマンドがパラメーターなしで最初に実行されるかどうかを示すブール値。 既定値: false |
||
fetchTask |
ブール型 | ダイアログを動的にフェッチする必要があるかどうかを示すブール値。 | ||
taskInfo |
オブジェクト | メッセージ拡張コマンドを使用するときにプリロードするダイアログを指定します。 | ||
taskInfo.title |
String | 64 文字 | 最初のダイアログ タイトル。 | |
taskInfo.width |
String | ダイアログの幅 - ピクセル単位の数値、または 、medium 、または small などのlarge 既定のレイアウト。 |
||
taskInfo.height |
String | ダイアログの高さ - ピクセル単位の数値、または、medium 、、small などの既定のレイアウトlarge のいずれか。 |
||
taskInfo.url |
String | 2048 文字 | 初期 Web ビュー URL。 | |
parameters |
オブジェクトの配列 | 5 | コマンドが取得するパラメーターの一覧。 最小: 1; 最大: 5 | |
parameter.name |
String | 64 文字 | ✔️ | クライアントに表示されるパラメーターの名前。 これはユーザー要求に含まれます。 Api ベースのメッセージ拡張機能の場合、名前は OpenAPI Description 内の に parameters.name マップする必要があります。 要求本文スキーマでプロパティを参照している場合は、名前を パラメーターまたはクエリ パラメーターにマップする properties.name 必要があります。 |
parameter.title |
String | 32 文字 | ✔️ | パラメーターのユーザーフレンドリーなタイトル。 |
parameter.description |
String | 128 文字 | このパラメーターの目的を説明するユーザーフレンドリーな文字列。 | |
parameter.semanticDescription |
String | 2000 文字 | 大きな言語モデルによる使用のためのパラメーターのセマンティック記述。 | |
parameter.inputType |
String | のダイアログに表示されるコントロールの種類を fetchTask: false 定義します。 text , textarea , number , date , time , toggle , choiceset の 1 つ。 |
||
parameter.value |
String | 512 文字 | パラメーターの初期値。 | |
parameter.choices |
オブジェクトの配列 | 10 | choiceset の選択オプション。 parameter.inputType が choiceset である場合にのみ使用してください。 |
|
parameter.choices.title |
String | 128 文字 | ✔️ | 選択したタイトル。 |
parameter.choices.value |
String | 512 文字 | ✔️ | Value of the choice. |
scopeConstraints
アプリをインストールできるスレッドを指定するためにアプリに課されるスコープ制約。 制約が指定されていない場合は、特定のスコープ内のすべてのスレッドにアプリをインストールできます。
省略可能 – オブジェクト
名前 | 種類 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
teams |
配列 | 128 | アプリが制限されているチーム スレッド ID の一覧。 | |
teams.id |
String | 64 文字 | ✔️ | チームのスレッド ID。 |
groupChats |
配列 | 128 | アプリが制限されているチャット スレッド ID の一覧。 | |
groupChats.id |
String | 64 文字 | ✔️ | チャットのスレッド ID。 |
アクセス許可
省略可能 – 文字列の配列
の配列 string
。これは、アプリが要求するアクセス許可を指定します。これにより、エンド ユーザーは拡張機能の実行方法を知らせます。 次のオプションは、決定的ではありません。
identity
ユーザー ID 情報が必要です。messageTeamMembers
チーム メンバーに直接メッセージを送信するためのアクセス許可が必要です。
アプリを更新するときにこれらのアクセス許可を変更すると、ユーザーは、更新されたアプリを初めて実行するときに同意プロセスを繰り返します。
devicePermissions
省略可能 – 文字列の配列
アプリがアクセスを要求する可能性があるユーザーのデバイス上のネイティブ機能を指定します。 オプションは、次のとおりです。
geolocation
media
notifications
midi
openExternal
validDomains
省略可能、特に明記されている場合は必須を除く
アプリがコンテンツの読み込みを期待する有効なドメインのリスト。 ドメイン リストには、*.example.com
などのワイルドカードを含めることができます。 有効なドメインは、ドメインの 1 つのセグメントと正確に一致します。 a.b.example.com
と一致させる必要がある場合は、*.*.example.com
を使用してください。 タブ構成またはコンテンツ UI をタブ構成に使用する以外の他のドメインに移動する必要がある場合は、ここでそのドメインを指定する必要があります。
注:
マニフェストでプロパティを使用して extensions
構成された Office アドインは、ワイルドカードを含むドメインを無視します。 アプリに Office アドインが組み込まれている場合は、アドインがアクセスするドメインの完全なドメイン名を指定します。
ただし、アプリでサポートする ID プロバイダーのドメインを含める必要 はありません 。 たとえば、Google ID を使用して認証するには、accounts.google.com にリダイレクトする必要がありますが、 に validDomains[]
accounts.google.com を含めてはいけません。
重要
直接またはワイルドカードを使用して、制御できないドメインを追加しないでください。 たとえば、 yourapp.onmicrosoft.com
は有効ですが *.onmicrosoft.com
、無効です。
オブジェクトは、型 string
のすべての要素を含む配列です。 オブジェクトの最大項目は 16 文字、最大長は 2048 文字です。
WebApplicationInfo
省略可能 – オブジェクト
Microsoft Entraアプリ ID と Graph 情報を指定して、ユーザーがMicrosoft Entra アプリにシームレスにサインインできるようにします。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
id |
String | ✔️ | アプリのアプリケーション ID をMicrosoft Entraします。 この ID は GUID である必要があります。 | |
resource |
String | 2048 文字 | SSO の認証トークンを取得するためのアプリのリソース URL。 |
graphConnector
省略可能 – オブジェクト
アプリの Graph コネクタ構成を指定します。 これが存在する場合は、 webApplicationInfo.id も指定する必要があります。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
notificationUrl |
string | 2048 文字 | ✔️ | アプリケーションの Graph コネクタ通知を送信する必要がある https:// URL。 |
showLoadingIndicator
省略可能 – ブール値
アプリまたはタブが読み込まれているときに読み込みインジケーターを表示するかどうかを示します。
既定値: false
注:
- アプリ マニフェストで true を選択
showLoadingIndicator
した場合、ページを正しく読み込むには、「 ネイティブ読み込みインジケーター ドキュメントを表示する」の説明に従って、タブとダイアログのコンテンツ ページを変更します。 - タブのコンテンツ ページを変更しない場合、タブ アプリは読み込まず、エラー が表示されます
There was a problem reaching this app
。
IsFullScreen
省略可能 – ブール値
個人用アプリがタブ ヘッダー バーの有無にかかわらずレンダリングされる場所を示します。
既定値: false
注:
isFullScreen
は、組織に発行されたアプリでのみ機能します。
activities
省略可能 – オブジェクト
アプリがユーザー アクティビティ フィードを投稿するために使用するプロパティを定義します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
activityTypes |
オブジェクトの配列 | 128 項目 | アプリがユーザーのアクティビティ フィードに投稿できるアクティビティの種類を提供します。 アクティビティの systemDefault 種類は予約済みで無効な文字列です。 |
activity.activityTypes
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
type |
String | 32 文字 | ✔️ | 通知の種類。 以下を参照してください。 |
description |
String | 128 文字 | ✔️ | 通知の簡単な説明。 以下を参照してください。 |
templateText |
String | 128 文字 | ✔️ | 例: "あなたに {actor} が作成したタスク {taskId}" |
{
"activities":{
"activityTypes":[
{
"type":"taskCreated",
"description":"Task Created Activity",
"templateText":"{actor} created task {taskId} for you"
},
{
"type":"teamMention",
"description":"Team Mention Activity",
"templateText":"{actor} mentioned team"
},
{
"type":"channelMention",
"description":"Channel Mention Activity",
"templateText":"{actor} mentioned channel"
},
{
"type":"userMention",
"description":"Personal Mention Activity",
"templateText":"{actor} mentioned user"
},
{
"type":"calendarForward",
"description":"Forwarding a Calendar Event",
"templateText":"{actor} sent user an invite on behalf of {eventOwner}"
},
{
"type":"calendarForward",
"description":"Forwarding a Calendar Event",
"templateText":"{actor} sent user an invite on behalf of {eventOwner}"
},
{
"type":"creatorTaskCreated",
"description":"Created Task Created",
"templateText":"The Creator created task {taskId} for you"
}
]
}
}
configurableProperties
省略可能 – 配列
configurableProperties
ブロックは、チーム管理者がカスタマイズできるアプリのプロパティを定義します。 詳細については、「アプリのカスタマイズを有効にする」を参照してください。
注:
少なくとも 1 つのプロパティを定義する必要があります。 このブロックでは、最大 9 つのプロパティを定義できます。
次のプロパティを定義できます。
name
: アプリの表示名。shortDescription
: アプリの簡単な説明。longDescription
: アプリの詳細な説明。smallImageUrl
: アプリのアウトライン アイコン。largeImageUrl
: アプリの色アイコン。accentColor
: アウトライン アイコンの背景として と で使用する色。developerUrl
: 開発者の Web サイトの HTTPS URL。privacyUrl
: 開発者のプライバシー ポリシーの HTTPS URL。termsOfUseUrl
: 開発者の使用条件の HTTPS URL。
supportedChannelTypes
省略可能 – 配列
標準以外のチャネルでアプリを有効にします。 アプリがチーム スコープをサポートしていて、このプロパティが定義されている場合、Teams ではそれに応じてそれぞれの種類のチャネルでアプリが有効になります。 現時点では、プライベート チャネルと共有チャネルがサポートされています。
注:
- アプリがチーム スコープをサポートしている場合、このプロパティで定義されている値に関係なく、標準チャネルで機能します。
- アプリは、それぞれの種類のチャネルの一意のプロパティを考慮して、適切に機能することができます。 プライベート チャネルと共有チャネルのタブを有効にするには、「プライベート チャネルでコンテキストを取得し、共有チャネルでコンテキストを取得する」を参照してください。
defaultBlockUntilAdminAction
省略可能 – ブール値
管理者が許可するまでアプリが既定でブロックされているかどうかを示す値。
既定値: false
publisherDocsUrl
省略可能 – 文字列
管理者に追加のアプリ情報を提供するページへの https:// URL。 文字列の最大長は 2048 文字です。
defaultInstallScope
省略可能 – 文字列
このアプリに既定で定義されているインストール スコープを指定します。 定義されたスコープは、ユーザーがアプリを追加しようとしたときにボタンに表示されるオプションです。 オプションは、次のとおりです。
personal
team
groupChat
meetings
defaultGroupCapability
省略可能 – オブジェクト
グループインストールスコープを選択すると、ユーザーがアプリをインストールするときの既定の機能が定義されます。 オプションは、次のとおりです。
team
groupchat
meetings
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
team |
String | 選択したインストール スコープが team の場合、このフィールドは使用可能な既定の機能を指定します。 オプション: tab 、bot 、または connector 。 |
||
groupchat |
String | 選択したインストール スコープが groupchat の場合、このフィールドは使用可能な既定の機能を指定します。 オプション: tab 、bot 、または connector 。 |
||
meetings |
String | 選択したインストール スコープが meetings の場合、このフィールドは使用可能な既定の機能を指定します。 オプション: tab 、bot 、または connector 。 |
subscriptionOffer
省略可能 – オブジェクト
アプリに関連付けられている SaaS オファーを指定します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
offerId |
string | 2,048 文字 | ✔️ | パートナー センターで見つけることができるパブリッシャー ID とオファー ID を含む一意の識別子。 文字列を publisherId.offerId として書式設定する必要があります。 |
meetingExtensionDefinition
省略可能 – オブジェクト
会議拡張機能の定義を指定します。 詳細については、「Teams のカスタム Together Mode シーン」を参照してください。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
scenes |
オブジェクトの配列 | 5 個の項目 | 会議でサポートされているシーン。 | |
supportsStreaming |
ブール型 | アプリが会議のオーディオとビデオのコンテンツをリアルタイム会議プロトコル (RTMP) エンドポイントにストリーミングできるかどうかを示すブール値。 既定値: false |
||
videoFiltersConfigurationUrl |
String | 2048 文字 | ビデオ フィルターを構成するための https:// URL。 | |
supportsAnonymousGuestUsers |
ブール型 | アプリが匿名ゲスト ユーザーによるアクセスをサポートするかどうかを示すブール値。 既定値: false |
meetingExtensionDefinition.scenes
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
id |
String | ✔️ | シーンの一意の識別子。 この ID は GUID である必要があります。 | |
name |
String | 128 文字 | ✔️ | シーンの名前。 |
file |
String | 2048 文字 | ✔️ | シーンの metadata json ファイルへの相対ファイル パス。 |
preview |
String | 2048 文字 | ✔️ | シーンの PNG プレビュー アイコンへの相対ファイル パス。 |
maxAudience |
整数 | 50 | ✔️ | シーンでサポートされている対象ユーザーの最大数。 |
seatsReservedForOrganizersOrPresenters |
整数 | 50 | ✔️ | 開催者または発表者用に予約されたシートの数。 |
meetingExtensionDefinition.videoFilters
このオブジェクトは、会議でサポートされているビデオ フィルターを示します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
id |
String | ✔️ | ビデオ フィルターの一意識別子。 この ID は GUID である必要があります。 | |
name |
String | 128 文字 | ✔️ | ビデオ フィルターの名前。 |
thumbnail |
String | 2048 文字 | ✔️ | ビデオ フィルターのサムネイルへの相対ファイル パス。 |
承認
省略可能 – オブジェクト
注:
authorization
は、アプリ マニフェスト バージョン 1.12 以降でのみサポートされています。
アプリの承認に関する情報を指定して統合します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
permissions |
オブジェクト | アプリを実行する必要があるアクセス許可の一覧。 |
authorization.permissions
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
resourceSpecific |
オブジェクトの配列 | 16 項目 | リソース インスタンス レベルでのデータ アクセスを保護するアクセス許可。 |
authorization.permissions.resourceSpecific
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
type |
String | ✔️ | リソース固有の同意 (RSC) アクセス許可の種類。 オプション: Application と Delegated 。 |
|
name |
String | 128 文字 | ✔️ | RSC アクセス許可の名前。 詳細については、「RSC アプリケーションのアクセス許可」と「RSC 委任されたアクセス許可」を参照してください。 |
RSC アプリケーションのアクセス許可
アプリケーションのアクセス許可により、アプリはサインインしたユーザーなしでデータにアクセスできます。 アプリケーションのアクセス許可の詳細については、「 Microsoft Graph と Microsoft BotSDK の RSC アクセス許可」を参照してください。
RSC 委任されたアクセス許可
委任されたアクセス許可を使用すると、アプリはサインインしているユーザーの代わりにデータにアクセスできます。
チームの RSC 委任されたアクセス許可
名前 説明 ChannelMeetingParticipant.Read.Group
サインインしたユーザーの代理で、このチームに関連付けられたチャネル会議の名前、役割、ID、参加時間と退会時間などの参加者情報を読み取ることができるようにします。 ChannelMeetingIncomingAudio.Detect.Group
アプリがチームに関連付けられているチャネル会議で受信オーディオを検出できるようにします。 ChannelMeetingActiveSpeaker.Read.Group
チームに関連付けられているチャネル会議に現在オーディオを送信している参加者をアプリで読み取ることができます。 ChannelMeetingAudioVideo.Stream.Group
アプリがチームに関連付けられているチャネル会議からオーディオ ビデオ コンテンツをストリーミングできるようにします。 InAppPurchase.Allow.Group
サインインしているユーザーの代わりに、アプリがチーム内のユーザーにマーケットプレース オファーを表示し、アプリ内で購入を完了できるようにします。 ChannelMeetingStage.Write.Group
サインインしているユーザーの代わりに、チームに関連付けられているチャネル会議の会議ステージのコンテンツをアプリに表示できるようにします。 LiveShareSession.ReadWrite.Group
アプリがチームに関連付けられている会議の Live Share セッションを作成および同期できるようにします。 サインインしているユーザーの代わりに、メンバーの会議ロールなど、会議の名簿に関するアクセス関連情報を提供します。 MeetingParticipantReaction.Read.Group
アプリがチームに関連付けられているチャネル会議の参加者の反応を読み取ることができます。 チャットまたは会議の RSC 委任されたアクセス許可
名前 説明 InAppPurchase.Allow.Chat
アプリがチャット内のユーザーと関連する会議に Marketplace オファーを表示し、サインインしているユーザーに代わってアプリ内で購入を完了できるようにします。 MeetingStage.Write.Chat
アプリで、サインインしているユーザーの代わりに、チャットに関連付けられている会議の会議ステージのコンテンツを表示できるようにします。 OnlineMeetingParticipant.Read.Chat
アプリは、サインインしているユーザーの代わりに、チャットに関連付けられている会議の名前、ロール、ID、参加済み、および退席時刻などの参加者情報を読み取ることができます。 OnlineMeetingParticipant.ToggleIncomingAudio.Chat
アプリで、サインインしているユーザーの代わりに、チャットに関連付けられている会議の参加者の受信オーディオを切り替えることができます。 LiveShareSession.ReadWrite.Chat
アプリがチャットに関連付けられている会議の Live Share セッションを作成および同期できるようにします。 サインインしているユーザーの代わりに、メンバーの会議ロールなど、会議の名簿に関するアクセス関連情報を提供します。 MeetingParticipantReaction.Read.Chat
アプリがチャットに関連付けられている会議の参加者の反応を読み取ることができます。 OnlineMeetingIncomingAudio.Detect.Chat
サインインしているユーザーの代わりに、チャットに関連付けられている会議での受信オーディオの状態の変更をアプリで検出できるようにします。 OnlineMeetingActiveSpeaker.Read.Chat
チャットに関連付けられている会議に現在オーディオを送信している参加者をアプリで読み取ることができます。 OnlineMeetingAudioVideo.Stream.Chat
アプリがチャットに関連付けられている会議のオーディオ ビデオ コンテンツをストリーミングできるようにします。 ユーザーの RSC 委任されたアクセス許可
名前 説明 CameraStream.Read.User
アプリがユーザーのカメラ ストリームを読み取ることができます。 InAppPurchase.Allow.User
サインインしているユーザーの代わりに、アプリでユーザー マーケットプレース オファーを表示し、アプリ内でユーザーの購入を完了できるようにします。 OutgoingVideoStream.Write.User
アプリがユーザーの送信ビデオを変更できるようにします。 MicrophoneStream.Read.User
アプリがユーザーのマイク ストリームを読み取ることができます。 MeetingParticipantReaction.Read.User
アプリが会議に参加している間にユーザーの反応を読み取ることができます。
extensions
省略可能 – オブジェクト
プロパティは extensions
、アプリ マニフェスト内の Outlook アドインを指定し、Microsoft 365 エコシステム全体での配布と取得を簡略化します。 各アプリでは、1 つの拡張機能のみがサポートされます。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
requirements |
オブジェクト | 拡張機能のクライアントまたはホストの要件のセットを指定します。 | ||
runtimes |
配列 | 各拡張ポイントで使用できるランタイムとアクションのセットを構成します。 詳細については、「 Office アドインのランタイム」を参照してください。 | ||
ribbons |
配列 | リボンの延長ポイントを定義します。 | ||
autoRunEvents |
配列 | イベント ベースのアクティブ化拡張ポイントを定義します。 | ||
alternates |
配列 | 既存の Microsoft 365 ソリューションを代替する関係を指定します。 これは、機能が重複している同じ発行元のアドインを非表示または優先順位付けするために使用されます。 | ||
audienceClaimUrl |
String | 2048 文字 | 拡張機能の URL を指定し、Exchange ユーザー ID トークンの検証に使用します。 詳細については、Exchange ID トークン内を参照してください。 |
詳細については、「 Microsoft 365 用 Office アドイン マニフェスト」を参照してください。
extensions.requirements
オブジェクトは extensions.requirements
、アドインをインストールするために Office クライアントでサポートする必要があるスコープ、フォーム ファクター、および Office JavaScript ライブラリ要件セットを指定します。 要件は、アドインの一部の機能を選択的に除外するための "リボン"、"ランタイム"、"代替"、および "autoRunEvents" 子プロパティでもサポートされています。 詳細については、「 Microsoft 365 の統合マニフェストで Office アドインの要件を指定する」を参照してください。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
requirements.capabilities |
配列 | 要件セットを識別します。 オプション: name (必須)、 minVersion 、、 maxVersion |
||
requirements.capabilities.name |
String | ✔️ | 要件セットの名前を識別します。 | |
requirements.capabilities.minVersion |
String | 要件セットの最小バージョンを識別します。 | ||
requirements.capabilities.maxVersion |
String | 要件セットの最大バージョンを識別します。 | ||
requirements.scopes |
列挙型の配列 | 1 | アドインを実行できるスコープを識別し、拡張機能を実行できる Microsoft 365 アプリケーションを定義します。 たとえば、 mail (Outlook)。 サポートされる値: mail |
|
requirements.formFactors |
列挙型の配列 | アドインをサポートするフォーム ファクターを識別します。 サポートされる値: mobile 、 desktop |
extensions.runtimes
配列は extensions.runtimes
、各拡張ポイントで使用できるランタイムとアクションのセットを構成します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
id |
String | 64 文字 | ✔️ | ランタイムの ID を指定します。 |
type |
文字列列挙型 | ✔️ | ランタイムの種類を指定します。 ブラウザー ベースのランタイムでサポートされている列挙値は ですgeneral 。 |
|
code |
オブジェクト | ✔️ | ランタイムのコードの場所を指定します。 に runtime.type 基づいて、アドインは JavaScript ファイルまたは JavaScript ファイルの URL を指定する埋め込み script タグを持つ HTML ページを使用できます。 が不確実な状況では、両方の runtime.type URL が必要です。 |
|
code.page |
URL | ✔️ | 埋め込み script タグを含む Web ページの URL を指定します。これは、JavaScript ファイルの URL ( ブラウザー ベースのランタイムに読み込まれる) を指定します。 |
|
code.script |
URL | JavaScript 専用ランタイムに読み込む JavaScript ファイルの URL を指定します。 | ||
lifetime |
文字列列挙型 | ランタイムの有効期間を指定します。 有効期間を持 short つランタイムは、実行間で状態を保持しませんが、有効期間を持つランタイムは状態を long 保持しません。 詳細については、「 Office アドインのランタイム」を参照してください。 |
||
actions |
配列 | ランタイムでサポートされるアクションのセットを指定します。 アクションは、JavaScript 関数を実行するか、作業ウィンドウなどのビューを開くことです。 | ||
actions.id |
String | 64 文字 | ✔️ | コード ファイルに渡されるアクションの ID を指定します。 |
actions.type |
String | ✔️ | アクションの種類を指定します。 型は executeFunction 、完了を待たずに JavaScript 関数を実行し、型は特定の openPage ビューでページを開きます。 |
|
actions.displayName |
String | 64 文字 | アクションの表示名を指定します。これは、アクションを呼び出すボタンやメニュー項目のラベルではありません (で構成されています tabs.groups.controls.label )。 |
|
actions.pinnable |
ブール型 | 作業ウィンドウがピン留めをサポートすることを指定します。これにより、ユーザーが選択を変更したときも作業ウィンドウが開いたままになります。 既定値: false |
||
actions.view |
String | 64 文字 | ページを開く必要があるビューを指定します。 が の場合actions.type openPage にのみ使用されます。 |
|
actions.multiselect |
ブール型 | エンド ユーザーが複数のメール メッセージなど、複数のアイテムを選択し、それらのすべてにアクションを適用できるかどうかを指定します。 | ||
actions.supportsNoItemContext |
ブール型 | 閲覧ウィンドウが有効になっていないか、メッセージが選択されていない状態で作業ウィンドウ アドインをアクティブ化できるようにします。 | ||
requirements |
オブジェクト | ランタイムをアドインに含めるために Office クライアントでサポートする必要があるスコープ、formFactors、および Office JavaScript ライブラリの要件セットを指定します。 詳細については、「 Microsoft 365 の統合マニフェストで Office アドインの要件を指定する」を参照してください。 | ||
requirements.capabilities |
配列 | 要件セットを識別します。 オプション: name (必須)、 minVersion 、、 maxVersion |
||
requirements.capabilities.name |
String | ✔️ | 要件セットの名前を識別します。 | |
requirements.capabilities.minVersion |
String | 要件セットの最小バージョンを識別します。 | ||
requirements.capabilities.maxVersion |
String | 要件セットの最大バージョンを識別します。 | ||
requirements.scopes |
列挙型の配列 | 1 | アドインを実行できるスコープを識別し、拡張機能を実行できる Microsoft 365 アプリケーションを定義します。 たとえば、 mail (Outlook)。 サポートされる値: mail |
|
requirements.formFactors |
列挙型の配列 | アドインをサポートするフォーム ファクターを識別します。 サポートされる値: mobile 、 desktop |
を使用 extensions.runtimes
するには、「 アドイン コマンドの作成」を参照し、 作業ウィンドウのランタイムを構成し、 関数コマンドのランタイムを構成します。
extensions.ribbons
プロパティを extensions.ribbons
使用すると、 アドイン コマンド (ボタンとメニュー項目) を Microsoft 365 アプリケーションのリボンに追加できます。 リボン定義は、要件と最初の順序に基づいて配列から選択されます。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
contexts |
配列 | 7 | リボンのカスタマイズをユーザーが使用できる Microsoft 365 アプリケーション ウィンドウを指定します。 配列内の各項目は、文字列配列のメンバーです。 サポートされる値: mailRead 、、 mailCompose 、 meetingDetailsOrganizer 、 meetingDetailsAttendee 、 onlineMeetingDetailsOrganizer 、 logEventMeetingDetailsAttendee 、 default |
|
requirements |
オブジェクト | リボンのカスタマイズを表示するために Office クライアントでサポートする必要があるスコープ、formFactors、および Office JavaScript ライブラリの要件セットを指定します。 詳細については、「 Microsoft 365 の統合マニフェストで Office アドインの要件を指定する」を参照してください。 | ||
requirements.capabilities |
配列 | 要件セットを識別します。 オプション: name (必須)、 minVersion 、、 maxVersion |
||
requirements.capabilities.name |
String | ✔️ | 要件セットの名前を識別します。 | |
requirements.capabilities.minVersion |
String | 要件セットの最小バージョンを識別します。 | ||
requirements.capabilities.maxVersion |
String | 要件セットの最大バージョンを識別します。 | ||
requirements.scopes |
列挙型の配列 | 1 | アドインを実行できるスコープを識別し、拡張機能を実行できる Microsoft 365 アプリケーションを定義します。 たとえば、 mail (Outlook)。 サポートされる値: mail |
|
requirements.formFactors |
列挙型の配列 | アドインをサポートするフォーム ファクターを識別します。 サポートされる値: mobile 、 desktop |
||
tabs |
配列 | ✔️ | Microsoft 365 アプリケーション リボンのカスタム タブを構成します。 | |
tabs.id |
String | 64 文字 | アプリ内のタブの ID を指定します。 | |
tabs.builtinTabId |
String | 64 文字 | 組み込みの Office リボン タブの ID を指定します。使用可能な値は、Office ホスト アプリケーションによって異なります。 現時点では、Outlook アドインのみがサポートされており、Outlook で許可される値は "TabDefault" のみです。 既定のタブは、"extensions.ribbons.contexts" プロパティで決定される Outlook アドインの表示場所によって異なります。 メイン Outlook ウィンドウでは、[ホーム] タブ、メッセージ ウィンドウでは [メッセージ] タブ、会議ウィンドウでは [会議] タブです。 | |
tabs.label |
String | 64 文字 | タブに表示されるテキストを指定します。 | |
tabs.position |
オブジェクト | リボン上の他のタブに対するカスタム タブの位置を構成します。 | ||
tabs.position.builtinTabId |
String | 64 文字 | ✔️ | カスタム タブの横に配置する組み込みタブの ID を指定します。 詳細については、「 コントロールとコントロール グループの ID を見つける」を参照してください。 |
tabs.position.align |
文字列列挙型 | ✔️ | 指定した組み込みタブに対するカスタム タブの配置を定義します。 サポートされる値: after 、 before |
|
tabs.groups |
配列 | モバイル 以外のデバイスのリボン タブ上のコントロールのグループを定義します。 モバイル デバイスについては、以下を参照してください tabs.customMobileRibbonGroups 。 |
||
tabs.groups.id |
String | 64 文字 | アプリ内のタブ グループの ID を指定します。 Microsoft 365 アプリケーション内の組み込みグループ ID やその他のカスタム グループとは異なる必要があります。 | |
tabs.groups.label |
String | 64 文字 | グループに表示されるテキストを指定します。 | |
tabs.groups.icons |
配列 | グループに表示されるアイコンを指定します。 | ||
tabs.groups.icons.size |
番号 | ✔️ | アイコンのサイズをピクセル単位で指定します。これは、、20 、24 32 、40 、48 、64 80 として16 列挙されます。 必要なイメージ サイズ: 16 、、32 80 。 |
|
tabs.groups.icons.url |
URL | ✔️ | アイコンの絶対 URL を指定します。 | |
tabs.groups.controls |
配列 | グループ内のボタンとメニューを構成します。 | ||
tabs.groups.controls.id |
String | 64 文字 | ✔️ | アプリ内のコントロールの ID を指定します。 これは、Microsoft 365 アプリケーションの組み込みコントロール ID やその他のカスタム コントロールとは異なる必要があります。 |
tabs.groups.controls.items |
配列 | メニュー コントロールの項目を構成します。 | ||
tabs.groups.controls.items.id |
String | ✔️ | アプリ内の項目の ID を指定します。 | |
tabs.groups.controls.items.type |
文字列列挙型 | ✔️ | コントロール項目の種類を定義します。 サポートされる値: menu 、 button |
|
tabs.groups.controls.items.label |
String | 64 文字 | ✔️ | 項目に表示されるテキストを指定します。 |
tabs.groups.controls.items.icons |
配列 | カスタム 項目のアイコンを構成します。 | ||
tabs.groups.controls.items.icons.size |
番号 | ✔️ | アイコンのサイズをピクセル単位で指定します。これは、、20 、24 32 、40 、48 、64 80 として16 列挙されます。 必要なイメージ サイズ: 16 、、32 80 。 |
|
tabs.groups.controls.items.icons.url |
URL | ✔️ | アイコンの絶対 URL を指定します。 | |
tabs.groups.controls.items.supertip |
✔️ | カスタム項目のスーパーヒントを構成します。 スーパーヒントは、コントロールの上にカーソルを置いたときに、コントロールに関するヘルプ情報の簡単なボックスを表示する UI 機能です。 ボックスには複数行のテキストが含まれている場合があります。 | ||
tabs.groups.controls.items.supertip.title |
String | 64 文字 | ✔️ | ヒントのタイトル テキストを指定します。 |
tabs.groups.controls.items.supertip.description |
String | 128 文字 | ✔️ | ヒントの説明を指定します。 |
tabs.groups.controls.items.actionId |
String | 64 文字 | ✔️ | ユーザーがコントロールまたはメニュー項目を選択したときに実行されるアクションの ID を指定します。 は actionId と runtime.actions.id 一致する必要があります。 |
tabs.groups.controls.items.enabled |
ブール型 | コントロールが最初に有効になっているかどうかを示します。 既定値: true |
||
tabs.groups.controls.items.overriddenByRibbonApi |
ブール型 | リボンにカスタム コンテキスト タブをインストールする API (Office.ribbon.requestCreateControls) をサポートする、アプリケーションとプラットフォームの組み合わせでグループ、ボタン、メニュー、またはメニュー項目を非表示にするかどうかを指定します。 既定値: false |
||
tabs.groups.controls.type |
String | ✔️ | コントロールの種類を定義します。 サポートされる値: button 、 menu |
|
tabs.groups.controls.builtinControlId |
String | 64 文字 | ✔️ | 既存の Microsoft 365 コントロールの ID を指定します。 詳細については、「 コントロールとコントロール グループの ID を見つける」を参照してください。 |
tabs.groups.controls.label |
String | 64 文字 | ✔️ | コントロールに表示されるテキストを指定します。 |
tabs.groups.controls.icons |
配列 | ✔️ | コントロールのアイコンを定義します。 少なくとも 3 つの子オブジェクトが必要です。、、および 80 ピクセルの16 32 プロパティを持つ size 1 つ。 |
|
tabs.groups.controls.icons.size |
番号 | ✔️ | アイコンのサイズをピクセル単位で指定します。これは、、20 、24 32 、40 、48 、64 80 として16 列挙されます。 必要なイメージ サイズ: 16 、、 32 。 80 |
|
tabs.groups.controls.icons.url |
URL | アイコンの絶対 URL を指定します。 | ||
tabs.groups.controls.supertip |
オブジェクト | ✔️ | コントロールのスーパーヒントを構成します。 | |
tabs.groups.controls.supertip.title |
String | 64 文字 | ✔️ | ヒントのタイトル テキストを指定します。 |
tabs.groups.controls.supertip.description |
String | 128 文字 | ✔️ | ヒントの説明を指定します。 |
tabs.groups.controls.actionId |
String | 64 文字 | コントロールの種類が の場合は必須です button 。 コントロールの種類が の場合は menu 使用しないでください。 ユーザーがコントロールを選択したときに実行されるアクションの ID を指定します。 は actionId 、 オブジェクト内 runtime.actions.id のアクションのプロパティと一致する runtimes 必要があります。 |
|
tabs.groups.controls.enabled |
ブール型 | コントロールが最初に有効になっているかどうかを示します。 既定値: true |
||
tabs.groups.controls.overriddenByRibbonApi |
ブール型 | リボンにカスタム コンテキスト タブをインストールする API (Office.ribbon.requestCreateControls) をサポートするアプリケーションとプラットフォームの組み合わせで、グループ、ボタン、メニュー、またはメニュー項目を非表示にするかどうかを指定します。 既定値: false |
||
tabs.groups.builtinGroupId |
String | 64 文字 | 組み込みグループの ID を指定します。 詳細については、「 コントロールとコントロール グループの ID を見つける」を参照してください。 | |
tabs.customMobileRibbonGroups |
配列 | 10 | モバイル デバイスのリボンの既定のタブでコントロールのグループを定義します。 この配列プロパティは、"DefaultTab" に設定されたプロパティを tabs.builtinTabId 持つタブ オブジェクトにのみ存在できます。 モバイル 以外のデバイスについては、上記を参照してください tabs.groups 。 |
|
tabs.customMobileRibbonGroups.id |
String | 250 文字 | ✔️ | グループの ID を指定します。 Microsoft 365 アプリケーション内の組み込みグループ ID やその他のカスタム グループとは異なる必要があります。 |
tabs.customMobileRibbonGroups.label |
String | 32 文字 | ✔️ | グループのラベルを指定します。 |
tabs.customMobileRibbonGroups.controls |
配列 | 20 | ✔️ | グループ内のコントロールを定義します。 モバイル ボタンのみがサポートされています。 |
tabs.customMobileRibbonGroups.controls.id |
String | 250 文字 | ✔️ | "msgReadFunctionButton" などのコントロールの ID を指定します。 |
tabs.customMobileRibbonGroups.controls.type |
文字列列挙型 | ✔️ | コントロールの種類を指定します。 現在、"MobileButton" のみがサポートされています。 | |
tabs.customMobileRibbonGroups.controls.label |
String | 32 文字 | ✔️ | コントロールのラベルを指定します。 |
tabs.customMobileRibbonGroups.controls.actionId |
String | 64 文字 | ✔️ | ユーザーがコントロールを選択したときに実行されるアクションの ID を指定します。 は actionId 、 オブジェクト内 runtime.actions.id のアクションのプロパティと一致する runtimes 必要があります。 |
tabs.customMobileRibbonGroups.controls.icons |
配列 | 9 | ✔️ | モバイル デバイス画面のサイズと DPI に応じてコントロールに表示されるアイコンを指定します。 9 つのアイコンが正確に存在する必要があります。 |
tabs.customMobileRibbonGroups.controls.icons.size |
数値列挙型 | ✔️ | アイコンのサイズ (ピクセル単位)。 使用可能なサイズは 25、32、および 48 です。 アイコン scale のプロパティの使用可能な値ごとに、各サイズの 1 つを正確に指定する必要があります。 |
|
tabs.customMobileRibbonGroups.controls.icons.url |
String | 2048 文字 | ✔️ | アイコンのイメージ ファイルの完全な絶対 URL。 |
tabs.customMobileRibbonGroups.controls.icons.scale |
数値列挙型 | ✔️ | iOS デバイスの UIScreen.scale プロパティを指定します。 使用可能な値は 1、2、および 3 です。 アイコン size のプロパティの使用可能な値ごとに、各値の 1 つを正確に指定する必要があります。 |
を使用 extensions.ribbons
するには、「 アドイン コマンドの作成」を参照し、 作業ウィンドウ コマンドの UI を構成し、 関数コマンドの UI を構成します。
extensions.autoRunEvents
プロパティは extensions.autoRunEvents
、イベント ベースのアクティブ化拡張ポイントを定義します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
events |
配列 | 20 | ✔️ | Outlook アドインのアクションが自動的に実行されるイベントを構成します。 たとえば、 Outlook アドインでスマート アラートと イベント OnMessageSend と OnAppointmentSend イベントを使用する方法に関するページを参照してください。 |
events.type |
String | 64 文字 | イベントの種類を指定します。 サポートされている種類については、 サポートされているイベントに関するページを参照してください。 | |
events.actionId |
String | 64 文字 | イベントが発生したときに実行されるアクションを識別します。 は actionId と runtime.actions.id 一致する必要があります。 |
|
events.options |
オブジェクト | Outlook がイベントに応答する方法を構成します。 | ||
events.options.sendMode |
String | ✔️ | メール送信アクション中に実行するアクションを指定します。 サポートされる値: promptUser 、、block softBlock 。 詳細については、 使用可能な送信モード オプションに関するページを参照してください。 |
|
requirements |
オブジェクト | イベント処理コードを実行するために Office クライアントでサポートする必要があるスコープ、formFactors、および Office JavaScript ライブラリの要件セットを指定します。 詳細については、「 Microsoft 365 の統合マニフェストで Office アドインの要件を指定する」を参照してください。 | ||
requirements.capabilities |
配列 | 要件セットを識別します。 オプション: name (必須)、 minVersion 、、 maxVersion |
||
requirements.capabilities.name |
String | ✔️ | 要件セットの名前を識別します。 | |
requirements.capabilities.minVersion |
String | 要件セットの最小バージョンを識別します。 | ||
requirements.capabilities.maxVersion |
String | 要件セットの最大バージョンを識別します。 | ||
requirements.scopes |
列挙型の配列 | 1 | アドインを実行できるスコープを識別し、拡張機能を実行できる Microsoft 365 アプリケーションを定義します。 たとえば、 mail (Outlook)。 サポートされる値: mail |
|
requirements.formFactors |
列挙型の配列 | アドインをサポートするフォーム ファクターを識別します。 サポートされる値: mobile 、 desktop |
extensions.alternates
プロパティは extensions.alternates
、機能が重複する複数のアドインを発行した場合に、特定の市場内アドインを非表示または優先順位付けするために使用されます。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
prefer |
オブジェクト | 同等の COM アドイン、XLL アドイン、またはその両方との下位互換性を指定します。 | ||
prefer.comAddin |
オブジェクト | Windows 用 Microsoft 365 Web アドインの代わりに使用する必要がある COM アドインを指定します。 | ||
prefer.comAddin.progId |
String | 64 文字 | ✔️ | 拡張機能を実行できるアプリケーションの種類を識別します。 |
hide |
オブジェクト | アドインがインストールされるたびに発行した別のアドインを非表示にする方法を構成し、ユーザーが Microsoft 365 UI に両方を表示しないようにします。 たとえば、古い XML アプリ マニフェストを使用するアドインを以前に発行し、それを新しい JSON アプリ マニフェストを使用するバージョンに置き換える場合は、このプロパティを使用します。 | ||
hide.storeOfficeAddin |
オブジェクト | Microsoft AppSource で使用できる Microsoft 365 アドインを指定します。 | ||
hide.storeOfficeAddin.officeAddinId |
String | 64 文字 | ✔️ | 非表示にする市場内アドインの ID を指定します。 市場内アドインが JSON アプリ マニフェスト id を使用している場合、GUID はアプリ マニフェスト プロパティから取得されます。 市場内アドインが XML アプリ マニフェストを <Id> 使用している場合、GUID は 要素から取得されます。 |
hide.storeOfficeAddin.assetId |
String | 64 文字 | ✔️ | 非表示にする市場内アドインの AppSource 資産 ID を指定します。 |
hide.customOfficeAddin |
オブジェクト | AppSource を介して配布されていない市場内アドインを非表示にする方法を構成します。 | ||
hide.customOfficeAddin.officeAddinId |
String | 64 文字 | ✔️ | 非表示にする市場内アドインの ID を指定します。 市場内アドインが JSON アプリ マニフェスト id を使用している場合、GUID はアプリ マニフェスト プロパティから取得されます。 市場内アドインが XML アプリ マニフェストを <Id> 使用している場合、GUID は 要素から取得されます。 |
requirements |
オブジェクト | "hide"、"prefer"、または "alternateIcons" プロパティを有効にするために Office クライアントでサポートする必要があるスコープ、formFactors、および Office JavaScript ライブラリの要件セットを指定します。 詳細については、「 Microsoft 365 の統合マニフェストで Office アドインの要件を指定する」を参照してください。 | ||
requirements.capabilities |
配列 | 要件セットを識別します。 オプション: name (必須)、 minVersion 、、 maxVersion |
||
requirements.capabilities.name |
String | ✔️ | 要件セットの名前を識別します。 | |
requirements.capabilities.minVersion |
String | 要件セットの最小バージョンを識別します。 | ||
requirements.capabilities.maxVersion |
String | 要件セットの最大バージョンを識別します。 | ||
requirements.scopes |
列挙型の配列 | 1 | アドインを実行できるスコープを識別し、拡張機能を実行できる Microsoft 365 アプリケーションを定義します。 たとえば、 mail (Outlook)。 サポートされる値: mail |
|
requirements.formFactors |
列挙型の配列 | アドインをサポートするフォーム ファクターを識別します。 サポートされる値: mobile 、 desktop |
||
alternateIcons |
オブジェクト | 古いバージョンの Office のアドインを表すために使用されるメインアイコンを指定します。 このプロパティは、Office アドインを Office on Mac、永続的な Office ライセンス、および 2304 (ビルド 16320.00000) より前の Windows 上の Office の Microsoft 365 サブスクリプション バージョンにインストールできる場合に 必要 です。 | ||
alternateIcons.icon |
オブジェクト | ✔️ | アドインを表すために使用するイメージ ファイルのプロパティを指定します。 | |
alternateIcons.icon.size |
数値列挙型 | ✔️ | このプロパティは、将来使用するために予約されています。 値は 64 である必要があります。 | |
alternateIcons.icon.url |
String | 2048 文字 | ✔️ | アドインを表すために使用されるイメージ ファイルの完全な絶対 URL を指定します。 アイコン画像は 64 x 64 ピクセルで、GIF、JPG、PNG、EXIF、BMP、TIFF のいずれかのファイル形式を使用する必要があります。 |
alternateIcons.highResolutionIcon |
オブジェクト | ✔️ | 高 DPI 画面でアドインを表すために使用するイメージ ファイルのプロパティを指定します。 | |
alternateIcons.highResolutionIcon.size |
数値列挙型 | ✔️ | このプロパティは、将来使用するために予約されています。 値は 64 である必要があります (128 ではありません)。 | |
alternateIcons.highResolutionIcon.url |
String | 2048 文字 | ✔️ | 高 DPI 画面でアドインを表すために使用されるイメージ ファイルの完全な絶対 URL を指定します。 アイコン画像は 128 x 128 ピクセルで、GIF、JPG、PNG、EXIF、BMP、TIFF のいずれかのファイル形式を使用する必要があります。 |
actions
注:
Microsoft 365 のアクションは、 パブリック開発者プレビューで利用できます。
アクションは、Web およびデスクトップ用の Microsoft 365 (Office) アプリでサポートされています。
オブジェクトは、アクション オブジェクトの配列です。 このブロックは、Actions を提供するソリューションにのみ必要です。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
id |
String | 64 文字 | ✔️ | アクションのカタログ化に使用される既定のロケールの識別子文字列。 このアプリのすべてのアクションで一意である必要があります。 たとえば、openDocInContoso などです。 |
displayName |
String | 64 文字 | ✔️ | アクションの表示名。 先頭文字とブランド名を大文字にします。 たとえば、サプライヤーへの追加、Contoso で開く、署名の要求などです。 |
description |
String | ✔️ | アクションの説明を指定します。 | |
intent |
文字列列挙型 | ✔️ | 意図の種類を指定します。 サポートされている列挙型の値は、 open 、 addTo 、および custom です。 |
|
handlers |
オブジェクトの配列 | ✔️ | ハンドラー オブジェクトの配列は、Actions の管理方法を定義します。 現在のパブリック プレビューで、アクションごとに 1 つのハンドラーを追加します。 |
actions.handlers
Action のハンドラーを定義します。 ハンドラーはハンドラー オブジェクトの配列です。 各アクションには、少なくとも 1 つのハンドラーが必要です。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
supportedObjects |
オブジェクト | このアクションをトリガーできるオブジェクトを定義するオブジェクト。 | ||
type |
文字列列挙型 | ✔️ | Actions のハンドラーの種類を指定します。 サポートされている列挙型の値は です openPage 。 |
|
pageInfo |
オブジェクト | ハンドラーの種類が の場合は必須です openPage 。 開くページのメタデータを含むオブジェクト。 |
actions.handlers.supportedObjects
このアクションをトリガーできるサポートされているオブジェクトの種類。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
file |
オブジェクト | サポートされているファイルの種類。 | ||
file.extensions |
文字列の配列 | 文字列の配列。 アクションがトリガーできるファイルの種類のファイル拡張子。 たとえば、pdf と docx です。 |
actions.handlers.pageInfo
ハンドラーの種類が の場合は必須です openPage
。 開くページのメタデータを含むオブジェクト。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
PageId |
String | EntityId 静的タブの にマップします。 |
||
SubPageId |
String | SubEntityId 静的タブの にマップします。 |
dashboardCards
省略可能 – 配列
アプリ情報の概要ビューを提供するために、Microsoft Viva Connectionsなどのダッシュボードにピン留めできるカードの一覧を定義します。 Viva Connections ダッシュボードのカードの作成の詳細については、「Bot Powered Adaptive Card Extensions の概要」を参照してください。
プロパティは dashboardCards
、 型 object
の要素の配列です。
dashboardCards.dashboardCard
1 つのダッシュボード カードとそのプロパティを定義します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
id |
String | ✔️ | このダッシュボードの一意識別子カード。 ID は GUID である必要があります。 | |
displayName |
String | 255 文字 | ✔️ | カードの表示名。 |
description |
String | 255 文字 | ✔️ | カードの説明。 |
pickerGroupId |
String | ✔️ | カード ピッカーのグループの ID。 ID は GUID である必要があります。 | |
icon |
オブジェクト | カードのアイコンを指定します。 | ||
contentSource |
オブジェクト | ✔️ | カードのコンテンツのソースを指定します | |
defaultSize |
String | ✔️ | ダッシュボード カードのレンダリング サイズ。 オプション: medium または large 。 |
dashboardCards.dashboardCard.icon
特定のダッシュボード カードのアイコン プロパティを定義します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
iconUrl |
String | 2048 文字 | ツールボックスとカード バーに表示されるカードのアイコンの場所。 | |
officeUIFabricIconName |
String | 255 文字 | カードの Office UI Fabricまたは Fluent UI アイコンのフレンドリ名。 この値は、 iconUrl が指定されていない場合に使用されます。 |
dashboardCards.dashboardCard.contentSource
特定のダッシュボード カードのコンテンツ ソースを定義します。
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
sourceType |
String | カードのコンテンツのソースを表します。 オプション: bot 。 |
||
botConfiguration |
オブジェクト | ボット ソースの構成。 が sourceType に bot 設定されている場合は必須です。 |
dashboardCards.dashboardCard.contentSource.botConfiguration
名前 | 型 | 最大サイズ | 必須 | 説明 |
---|---|---|---|---|
botId |
String | Bot Framework に登録された、ボット用の一意の Microsoft アプリ ID。 ID は GUID である必要があります。 |
関連項目
Platform Docs
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示