Outlook JavaScript API の要件セット

Outlook アドインは、必要な API バージョンをマニフェストで宣言します。 マークアップは、 アドインのみのマニフェスト形式 を使用しているか、 Microsoft 365 の統合マニフェストを使用しているかによって異なります。

"extensions": [
{
  "requirements": {
    "capabilities": [
      {
        "name": "Mailbox", "minVersion": "1.1"
      }
    ]
  },
  ...
}

<Requirements>
  <Sets>
    <Set Name="Mailbox" MinVersion="1.1" />
  </Sets>
</Requirements>

すべての Outlook API は、 Mailbox要件セットに属します。 Mailbox 要件のセットにはバージョンがあります。リリースされる新しい API の各セットは、新しいバージョンのセットに属しています。 すべての Outlook クライアントが最新の API セットをサポートしているわけではありませんが、Outlook クライアントが要件セットのサポートを宣言している場合、通常は、その要件セット内のすべての API をサポートします (例外については、特定の API または機能に関するドキュメントチェックしてください)。

マニフェストで指定されている最小要件セットによって、アドインを読み込むことができる Outlook クライアントが決まります。 Outlook クライアントが少なくとも指定したバージョンをサポートしていない場合、アドインは読み込まれません。 たとえば、要件にバージョンを 1.3 に指定した場合、アドインはバージョン 1.3 以上をサポートする Outlook クライアントにのみ表示されます。

後の要件セットの 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 server サポート

次の表に、Exchange サーバーと、それらのサーバーがサポートするメールボックス要件セットを示します。 特定の Exchange 環境でホストされている Outlook でアドインを表示するには、アドインのマニフェストで最小要件として設定されているバージョンが、その環境でサポートされている必要があります。

¹ Outlook アドイン コードで Identity API セット 1.3 を要求するには、isSetSupported('IdentityAPI', '1.3') の呼び出しでサポートされているかどうかをチェックします。 Outlook アドインのマニフェストでの宣言はサポートされていません。 undefined ではないことを確認することで、API がサポートされているかどうかを判断することもできます。 詳細については、「後続の要件セットからの API の使用」を参照してください。

アドインが Exchange オンプレミス環境でサポートされていない後の要件セットの機能を実装した場合でも、マニフェストで指定された最小要件セットが Exchange オンプレミスでサポートされているものと一致していれば、アドインを Outlook クライアントに追加できます。 ただし、実装された機能は、アドインがインストールされている Outlook クライアントが、機能に必要な最小要件セットをサポートしている場合にのみ機能します。 たとえば、マニフェストで 1.5 を指定する署名アドインは、Exchange 2019 の社内環境にインストールされて読み込まれます。 ただし、要件セット 1.10 で導入された Body.setSignatureAsync の呼び出しは、アドインがインストールされている Outlook クライアントが 1.10 をサポートしている場合にのみ実行されます。

さまざまな Outlook クライアントでサポートされている要件セットを確認するには、「 Outlook クライアントのサポート」を参照してください。 例外については、特定の機能に関するドキュメントでこれを補足することをお勧めします。

Outlook クライアント サポート

アドインは、以下のプラットフォーム上の Outlook でサポートされています。

¹ アドインは、Android 版、iOS 版、オンプレミスの Exchange アカウントを使用する最新のモバイル Web 版ではサポートされていません。 従来の Outlook on the web でオンプレミスの Exchange アカウントを使用する場合、特定の iOS デバイスではアドインが引き続きサポートされます。 サポートされているブラウザーの詳細については、「Office アドインを実行するための要件」を参照してください。

² アドインは、iPhone および Android スマートフォンの最新の Outlook on the web では機能しません。 サポートされているブラウザーの詳細については、「Office アドインを実行するための要件」を参照してください。

³ Outlook アドイン コードで Identity API セット 1.3 を要求するには、isSetSupported('IdentityAPI', '1.3') の呼び出しでサポートされているかどうかをチェックします。 Outlook アドインのマニフェストでの宣言はサポートされていません。 undefined ではないことを確認することで、API がサポートされているかどうかを判断することもできます。 詳細については、「後続の要件セットからの API の使用」を参照してください。

⁴ Microsoft 365 サブスクリプションまたはリテール永続ライセンスを使用した Windows 上の従来の Outlook で最近の要件セットに対してサポートされる最小バージョンについては、「 従来の Outlook on Windows の要件セットのバージョン サポート」を参照してください。

⁵ 新しい Mac UI のサポートは、Outlook バージョン 16.38.506 から利用できます。 詳細については、「新しい Mac UI での Outlook のアドインのサポート」セクションを参照してください。

⁶ 従来の Outlook on Mac ではメールボックス要件セット 1.9 はサポートされませんが、DialogApi 1.2 要件セットはサポートされます。 サポートされる最小バージョンとビルドについては、「 ダイアログ API 要件セット」を参照してください。

⁷ 現在、モバイル クライアント用のアドインを設計および実装する場合は、さらに考慮事項があります。 詳細については、「 モバイル デバイス上の Outlook でアドイン コマンドのサポートを追加する場合のコードに関する考慮事項」を参照してください。 Android と iOS の Outlook は要件セット 1.5 までをサポートしていますが、モバイル アドインでは、後の要件セットから一部の API を実装できるようになりました。 Outlook モバイルでサポートされている API の詳細については、「 モバイル デバイスの Outlook でサポートされている JavaScript API」を参照してください。

クラシック Outlook on Windows の要件セットのバージョン サポート

次の表に、Microsoft 365 サブスクリプションまたは永続的なライセンスを使用した従来の Outlook on Windows のより新しいメールボックス要件セットのバージョン サポートを示します。

クライアントのバージョンの詳細については、 Microsoft 365 または Office 2024 の更新履歴ページ、 および Office クライアントのバージョンと更新チャネルを見つける方法を参照してください。

Office JavaScript API 運用ライブラリを参照する

番号付きの要件セットで API を使用するには、Office.js コンテンツ配信ネットワーク (CDN) で生産ライブラリを参照してください。 プレビュー API の使用方法の詳細については、「 プレビュー API のテスト」を参照してください。

テスト プレビュー API

新しい Outlook JavaScript API は最初に "プレビュー" で導入され、その後、十分なテストが行われ、ユーザー フィードバックが得られてから、番号付きの特定の要件セットの一部になります。 プレビュー API についてフィードバックを提供するには、その API が記載されている Web ページの最後にあるフィードバック メカニズムを使用してください。

プレビュー API の詳細については、「Outlook API 要件セットのプレビュー」を参照してください。