Outlook JavaScript API の要件セットOutlook JavaScript API requirement sets

Outlook アドインは、マニフェスト要件要素を使用して、必要な API のバージョンを宣言します。Outlook アドインには、Name 属性が Mailbox に設定され、MinVersion 属性がアドインのシナリオをサポートする最小 API 要件セットに設定された設定要素が常に含まれます。Outlook add-ins declare what API versions they require by using the Requirements element in their manifest. Outlook add-ins always include a Set element with a Name attribute set to Mailbox and a MinVersion attribute set to the minimum API requirement set that supports the add-in's scenarios.

たとえば、次のマニフェストのスニペットは、最小要件セットの 1.1 を表します。For example, the following manifest snippet indicates a minimum requirement set of 1.1.

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

すべての Outlook API は、Mailbox要件セットに属しています。Mailbox 要件セットには複数のバージョンがあり、リリースされる API の新しいセットはそれぞれのセットの上位バージョンに属します。すべての Outlook クライアントが最新の API のセットをサポートするわけではありませんが、Outlook クライアントが要件セットのサポートを宣言する場合は、その要件セットのすべての API がサポートされます。All Outlook APIs belong to the Mailbox requirement set. The Mailbox requirement set has versions, and each new set of APIs that we release belongs to a higher version of the set. Not all Outlook clients support the newest set of APIs, but if an Outlook client declares support for a requirement set, it supports all of the APIs in that requirement set.

マニフェストに要件セットの最小バージョンを設定することで、アドインが表示される Outlook クライアントをコントロールできます。クライアントが最小要件セットをサポートしない場合、アドインはロードされません。たとえば、要件セットのバージョン 1.3 が指定されている場合、1.3 以上をサポートしていない Outlook クライアントには表示されません。Setting a minimum requirement set version in the manifest controls which Outlook client the add-in will appear in. If a client does not support the minimum requirement set, it does not load the add-in. For example, if requirement set version 1.3 is specified, this means the add-in will not show up in any Outlook client that doesn't support at least 1.3.

注意

番号付きの要件セットで API を使用するには、CDN: https://appsforoffice.microsoft.com/lib/1/hosted/office.js) で実稼働ライブラリを参照してください。To use APIs in any of the numbered requirement sets, you should reference the production library on the CDN (https://appsforoffice.microsoft.com/lib/1/hosted/office.js).

プレビューの API の使用に関する詳細については、この記事の「プレビュー API の使用」セクションを参照してください。For information about using preview APIs, see the Using preview APIs section later in this article.

後続の要件セットからの API の使用Using APIs from later requirement sets

要件セットを設定しても、アドインで使用できる API は制限されません。Setting a requirement set does not limit the available APIs that the add-in can use. たとえば、アドインでは要件セット「Mailbox 1.1」が指定されていて、「Mailbox 1.3」をサポートしている Outlook クライアントで実行されている場合、アドインは要件セット「Mailbox 1.3」の API を使用できます。For example, if the add-in specifies requirement set "Mailbox 1.1", but it is running in an Outlook client which supports "Mailbox 1.3", the add-in can use APIs from requirement set "Mailbox 1.3".

より新しい API を使用するために、開発者は次の操作を行うことによって、特定のホストが要件セットをサポートしているかどうかをチェックできます。To use a newer API, developers can check if a particular host supports the requirement set by doing the following.

if (Office.context.requirements.isSetSupported('Mailbox', '1.3')) {
  // Perform actions.
}
else {
  // Provide alternate flow/logic.
}

または、開発者は標準の JavaScript の技法を使用することで、新しい API の有無をチェックできます。Alternatively, developers can check for the existence of a newer API by using standard JavaScript technique.

if (item.somePropertyOrFunction !== undefined) {
  // Use item.somePropertyOrFunction.
  item.somePropertyOrFunction;
}

このようなチェックは、マニフェストで指定された要件セット バージョンに存在する API には必要ありません。No such checks are necessary for any APIs which are present in the requirement set version specified in the manifest.

最小要件セットの選択Choosing a minimum requirement set

開発者は、アドインを使用するために必要な、シナリオで必須の API のセットが含まれている初期の要件セットを使用する必要があります。Developers should use the earliest requirement set that contains the critical set of APIs for their scenario, without which the add-in won't work.

Exchange サーバーと Outlook クライアントでサポートされる要件セットRequirement sets supported by Exchange servers and Outlook clients

このセクションでは、Exchange サーバーと Outlook クライアントでサポートされる一連の要件セットについて説明します。In this section, we note the range of requirement sets supported by Exchange server and Outlook clients.

重要

ターゲットとなる Exchange サーバーと Outlook クライアントが異なる要件セットをサポートしている場合、低い要件セットの範囲に制限されます。If your target Exchange server and Outlook client support different requirement sets, then you're restricted to the lower requirement set range. たとえば、アドインが Exchange 2013 (最高要件セット: 1.1) に対して Mac 上の Outlook 2016 (最高要件セット: 1.6) で実行されている場合、アドインは要件セット 1.1 に制限されます。For example, if an add-in is running in Outlook 2016 on Mac (highest requirement set: 1.6) against Exchange 2013 (highest requirement set: 1.1), your add-in is limited to requirement set 1.1.

Exchange server サポートExchange server support

以下のサーバーは、Outlook のアドインをサポートしています。The following servers support Outlook add-ins.

製品Product Exchange のメジャー バージョンMajor Exchange version サポートされる API の要件セットSupported API requirement sets
Exchange OnlineExchange Online 最新のビルドLatest build 1.11.21.31.41.51.61.71.81.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
オンプレミスの ExchangeExchange on-premises 20192019 1.11.21.31.41.51.1, 1.2, 1.3, 1.4, 1.5
20162016 1.11.21.31.41.51.1, 1.2, 1.3, 1.4, 1.5
20132013 1.11.1

Outlook クライアント サポートOutlook client support

アドインは、以下のプラットフォーム上の Outlook でサポートされています。Add-ins are supported in Outlook on the following platforms.

プラットフォームPlatform Office/Outlook のメジャー バージョンMajor Office/Outlook version サブスクリプションまたは 1 回限りの購入 ?Subscription or one-time purchase? サポートされる API の要件セットSupported API requirement sets
WindowsWindows 最新のビルドLatest builds
(月次チャネル)(monthly channel)
Office 365 サブスクリプションOffice 365 subscription 1.11.21.31.41.51.61.71.81.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
20192019 1 回限りの購入one-time purchase 1.11.21.31.41.51.61.71.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7
20162016 1 回限りの購入one-time purchase 1.11.21.31.41.1, 1.2, 1.3, 1.4
20132013 1 回限りの購入one-time purchase 1.11.21.31.41.1, 1.2, 1.3, 1.4
MacMac 最新のビルドLatest builds
(月次チャネル)(monthly channel)
Office 365 サブスクリプションOffice 365 subscription 1.11.21.31.41.51.61.71.81.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
20192019 1 回限りの購入one-time purchase 1.11.21.31.41.51.61.1, 1.2, 1.3, 1.4, 1.5, 1.6
20162016 1 回限りの購入one-time purchase 1.11.21.31.41.51.61.1, 1.2, 1.3, 1.4, 1.5, 1.6
iOSiOS 最新のビルドLatest builds
(月次チャネル)(monthly channel)
Office 365 サブスクリプションOffice 365 subscription 1.11.21.31.41.51.1, 1.2, 1.3, 1.4, 1.5
AndroidAndroid 最新のビルドLatest builds
(月次チャネル)(monthly channel)
Office 365 サブスクリプションOffice 365 subscription 1.11.21.31.41.51.1, 1.2, 1.3, 1.4, 1.5
Web ブラウザーWeb browser 最新modern Exchange Online: Office 365 サブスクリプション、Outlook.comExchange Online: Office 365 subscription, Outlook.com 1.11.21.31.41.51.61.71.81.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8
クラシックclassic オンプレミスの ExchangeExchange on-premises 1.11.21.31.41.51.61.1, 1.2, 1.3, 1.4, 1.5, 1.6

注意

Outlook 2013 での 1.3 のサポートは、「2015 年 12 月 8 日付、Outlook 2013 用更新プログラム (KB3114349)」の一部として追加されました。Support for 1.3 in Outlook 2013 was added as part of the December 8, 2015, update for Outlook 2013 (KB3114349). Outlook 2013 での 1.4 のサポートは、「MS16-107: Outlook 2013 セキュリティ更新プログラムについて 2016 年 9 月 13 日」の一部として追加されました。Support for 1.4 in Outlook 2013 was added as part of the September 13, 2016, update for Outlook 2013 (KB3118280). Outlook 2016 (MSI) での 1.4 のサポートは、「2018 年 7 月 3 日更新プログラム Office 2016 (KB4022223)」の一部として追加されました。Support for 1.4 in Outlook 2016 (MSI) was added as part of the July 3, 2018, update for Office 2016 (KB4022223).

ヒント

メールボックスのツールバーを確認することで、Web ブラウザーでの Outlook がモダンかクラシックかを区別できます。You can distinguish between classic and modern Outlook in a web browser by checking your mailbox toolbar.

モダンmodern

Outlook ツールバー (モダン) の部分的なスクリーンショット

クラシックclassic

Outlook ツールバー (クラシック) の部分的なスクリーンショット

プレビュー API の使用Using preview APIs

新しい Outlook JavaScript API は最初に "プレビュー" で導入され、その後、十分なテストが行われ、ユーザー フィードバックが得られてから、番号付きの特定の要件セットの一部になります。New Outlook JavaScript APIs are first introduced in "preview" and later become part of a specific, numbered requirement set after sufficient testing occurs and user feedback is acquired. プレビュー API についてフィードバックを提供するには、その API が記載されている Web ページの最後にあるフィードバック メカニズムを使用してください。To provide feedback about a preview API, please use the feedback mechanism at the end of the web page where the API is documented.

注意

プレビュー API は変更されることがあります。運用環境での使用は意図されていません。Preview APIs are subject to change and are not intended for use in a production environment.

プレビュー API の詳細については、「Outlook API 要件セットのプレビュー」を参照してください。For more details about the preview APIs, see Outlook API Preview requirement set.