Outlook JavaScript API の要件セット
Outlook アドインは、マニフェストで必要な API バージョンを宣言します。 マークアップは、 アドインのみのマニフェスト形式 を使用しているか、 Microsoft 365 の統合マニフェストを使用しているかによって異なります。
API バージョンは、"extensions.requirements.capabilities" プロパティによって指定されます。 "capabilities.name" プロパティを "Mailbox" に設定し、"capabilities.minVersion" プロパティを、アドインのシナリオをサポートする最小 API 要件セットに設定します。
たとえば、次のマニフェストのスニペットは、最小要件セットの 1.1 を表します。
"extensions": [
{
"requirements": {
"capabilities": [
{
"name": "Mailbox", "minVersion": "1.1"
}
]
},
...
}
すべての Outlook API は要件セットにMailbox属しています。
Mailbox 要件のセットにはバージョンがあります。リリースされる新しい API の各セットは、新しいバージョンのセットに属しています。 すべての Outlook クライアントが最新の API セットをサポートしているわけではありませんが、Outlook クライアントが要件セットのサポートを宣言した場合、通常、その要件セット内のすべての API がサポートされます (例外については、特定の API または機能に関するドキュメントをチェック)。
マニフェスト コントロールで、アドインが表示される Outlook クライアントの最小要件セット バージョンを設定します。 クライアントが最小要件セットをサポートしていない場合、アドインは読み込まれません。 たとえば、要件セットのバージョン 1.3 が指定されている場合、1.3 以上をサポートしていない Outlook クライアントには表示されません。
注:
Outlook on Android および iOS では、要件セット 1.5 までサポートされていますが、モバイル アドインでは、後の要件セットの一部の API を実装できるようになりました。 Outlook モバイルでサポートされる API の詳細については、「モバイル デバイス上の Outlook でサポートされる Outlook JavaScript API」を参照してください。
後の要件セットの API を使用する
要件セットを設定しても、アドインで使用できる API は制限されません。 たとえば、アドインで要件セット "Mailbox 1.1" が指定されていても、"Mailbox 1.3" をサポートする Outlook クライアントで実行されている場合、アドインは要件セット "Mailbox 1.3" の API を使用できます。
より新しい API を使用するために、開発者は次の操作を行うことによって、特定のアプリケーションが要件セットをサポートしているかどうかをチェックできます。
if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
// Perform actions.
}
else {
// Provide alternate flow/logic.
}
または、開発者は標準の JavaScript の技法を使用することで、新しい API の有無をチェックできます。
if (item.somePropertyOrMethod !== undefined) {
// Use item.somePropertyOrMethod.
item.somePropertyOrMethod;
}
このようなチェックは、マニフェストで指定された要件セット バージョンに存在する API には必要ありません。
最小要件セットを選択する
開発者は、アドインを使用するために必要な、シナリオで必須の API のセットが含まれている初期の要件セットを使用する必要があります。
Exchange サーバーと Outlook クライアントでサポートされる要件セット
このセクションでは、Exchange サーバーと Outlook クライアントでサポートされる一連の要件セットについて説明します。 Outlook アドインを実行するためのサーバーおよびクライアントの要件の詳細については、「Outlook アドインの要件」を参照してください。
重要
ターゲットとなる Exchange サーバーと Outlook クライアントが異なる要件セットをサポートしている場合、低い方の要件セットの範囲に制限されます。 たとえば、Windows 上の Outlook 2019 でアドインが実行されている場合 (最高要件セット: 1.6)、Exchange 2016 (最高要件セット: 1.5) に対して、アドインは要件セット 1.5 に制限される場合があります。
Exchange server サポート
以下のサーバーは、Outlook のアドインをサポートしています。
| 製品 | Exchange のメジャー バージョン | サポートされる API の要件セット |
|---|---|---|
| Exchange Online | 最新のビルド |
1.1、1.2、1.3、1.4、1.5、1.6、1.7、1.8、1.9、1.10、1.11、1.12、1.13、1.14 IdentityAPI 1.31 |
| Exchange オンプレミス2 | 2019 | 1.1、1.2、1.3、1.4、1.5 |
| 2016 | 1.1、1.2、1.3、1.4、1.5 |
注:
1 Outlook アドイン コードで Identity API セット 1.3 を要求するには、 を呼び出isSetSupported('IdentityAPI', '1.3')すことによってサポートされているかどうかをチェックします。 Outlook アドインのマニフェストでの宣言はサポートされていません。
undefined ではないことを確認することで、API がサポートされているかどうかを判断することもできます。 詳細については、「後続の要件セットからの API の使用」を参照してください。
2 アドインが Exchange オンプレミス環境でサポートされていない要件セットの機能を実装している場合でも、マニフェストで指定された要件セットが Exchange オンプレミスでサポートされているものと一致している限り、Outlook クライアントに追加できます。 ただし、実装された機能は、アドインがインストールされている Outlook クライアントが機能に必要な最小要件セットをサポートしている場合にのみ機能します。 さまざまな Outlook クライアントでサポートされる要件セットを特定するには、「 Outlook クライアントのサポート」を参照してください。 例外については、特定の機能に関するドキュメントでこれを補足することをお勧めします。
Outlook クライアント サポート
アドインは、以下のプラットフォーム上の Outlook でサポートされています。
注:
1 アドインは、Outlook on Android、iOS、およびオンプレミスの Exchange アカウントを使用した最新のモバイル Web ではサポートされていません。 一部の iOS デバイスでは、従来のOutlook on the webでオンプレミスの Exchange アカウントを使用する場合でもアドインがサポートされます。 サポートされているブラウザーの詳細については、「Office アドインを実行するための要件」を参照してください。
2 アドインは、iPhone と Android スマートフォンの最新のOutlook on the webでは機能しません。 サポートされているブラウザーの詳細については、「Office アドインを実行するための要件」を参照してください。
3 Outlook アドイン コードで Identity API セット 1.3 を要求するには、 を呼び出isSetSupported('IdentityAPI', '1.3')すことによってサポートされている場合にチェックします。 Outlook アドインのマニフェストでの宣言はサポートされていません。
undefined ではないことを確認することで、API がサポートされているかどうかを判断することもできます。 詳細については、「後続の要件セットからの API の使用」を参照してください。
4 Microsoft 365 サブスクリプションまたはリテール 永続的ライセンスを持つ従来の Outlook on Windows の最新の要件セットでサポートされる最小バージョンについては、「 従来の Outlook on Windows での要件セットのバージョン サポート」を参照してください。
52018 年 7 月 3 日の Office 2016 (KB4022223) の更新プログラムの一環として、ボリューム ライセンスの永続的なOutlook 2016での 1.4 のサポートが追加されました。
6 新しい Mac UI のサポートは、Outlook バージョン 16.38.506 から入手できます。 詳細については、「新しい Mac UI での Outlook のアドインのサポート」セクションを参照してください。
7 従来の Outlook on Mac では、メールボックス要件セット 1.9 はサポートされていませんが、DialogApi 1.2 要件セットがサポートされています。 サポートされている最小バージョンとビルドについては、「 Dialog API 要件セット」を参照してください。
8 現在、モバイル クライアント用のアドインを設計および実装する際には、追加の考慮事項があります。 詳細については、「 モバイル デバイス上の Outlook でアドイン コマンドのサポートを追加するときのコードに関する考慮事項」を参照してください。 Outlook on Android および iOS では、要件セット 1.5 までサポートされていますが、モバイル アドインでは、後の要件セットの一部の API を実装できるようになりました。 Outlook モバイルでサポートされる API の詳細については、「モバイル デバイス上の Outlook でサポートされる Outlook JavaScript API」を参照してください。
ヒント
メールボックスのツールバーを確認することで、Web ブラウザーでの Outlook がモダンかクラシックかを区別できます。
モダン
クラシック
従来の Outlook on Windows での要件セットのバージョン サポート
次の表に、Microsoft 365 サブスクリプションまたはリテール 永続的ライセンスを使用した従来の Outlook on Windows の最新のメールボックス要件セットのバージョン サポートを示します。
| 要件セット | バージョン |
|---|---|
| 1.8 | バージョン 1910 (ビルド 12130.20272) |
| 1.9 | バージョン 2008 (ビルド 13127.20296) |
| 1.10 | バージョン 2104 (ビルド 13929.20296) |
| 1.11 | バージョン 2110 (ビルド 14527.20226) |
| 1.12 | バージョン 2206 (ビルド 15330.20196) |
| 1.13 | バージョン 2304 (ビルド 16327.20248) |
| 1.14 | バージョン 2404 (ビルド 17530.15000) |
クライアントのバージョンの詳細については、 Microsoft 365 または Office 2024 の更新履歴ページと、 Office クライアントのバージョンと更新プログラム チャネルを見つける方法に関するページを参照してください。
Office JavaScript API 運用ライブラリを参照する
番号付きの要件セットで API を使用するには、Office.js コンテンツ配信ネットワーク (CDN) で生産ライブラリを参照してください。 プレビュー API の使用方法については、「プレビュー API の テスト」を参照してください。
プレビュー API のテスト
新しい Outlook JavaScript API は最初に "プレビュー" で導入され、その後、十分なテストが行われ、ユーザー フィードバックが得られてから、番号付きの特定の要件セットの一部になります。 プレビュー API についてフィードバックを提供するには、その API が記載されている Web ページの最後にあるフィードバック メカニズムを使用してください。
注:
プレビュー API は変更される可能性があり、運用環境での使用を目的としたものではありません。
プレビュー API の詳細については、「Outlook API 要件セットのプレビュー」を参照してください。
Office Add-ins