統合マニフェストを使用して Office アプリケーションと API の要件を指定する

注:

アドインのみのマニフェストで要件を指定する方法については、「アドインのみのマニフェストを使用して Office ホストと API の要件を指定する」を参照してください。

Office アドインは、特定の Office アプリケーション (Office ホストとも呼ばれます) または Office JavaScript ライブラリ (office.js) の特定のメンバーに依存する場合があります。たとえば、次のようなアドインがあります。

1 つの Office アプリケーション (例: Word または Excel)、またはいくつかのアプリケーションで実行します。
一部のバージョンの Office でのみ使用できる Office JavaScript API を使用します。たとえば、ボリュームライセンスの永続的なバージョンのExcel 2016では、Office JavaScript ライブラリ内のすべての Excel 関連 API がサポートされているわけではありません。
モバイルフォームファクターでのみ使用するように設計されています。

このような状況では、アドインが実行できない Office アプリケーションまたは Office バージョンにインストールされないようにする必要があります。

また、Office アプリケーションと Office のバージョンに基づいて、アドインのどの機能をユーザーに表示するかを制御するシナリオもあります。 3 つの例を次に示します。

アドインには、テキスト操作などのWordとPowerPointの両方で役立つ機能がありますが、スライド管理機能など、PowerPointでのみ意味を持つ追加機能がいくつかあります。アドインがWordで実行されている場合は、PowerPoint専用機能を非表示にする必要があります。
アドインには、Office アプリケーションの一部のバージョン (Microsoft 365 サブスクリプション Excel など) でサポートされているが、ボリュームライセンスの永続的なExcel 2016など、他のバージョンではサポートされていない Office JavaScript API メソッドが必要な機能があります。ただし、アドインには、ボリュームライセンスの永続的なExcel 2016でサポートされている Office JavaScript API メソッドのみを必要とする他の機能があります。このシナリオでは、そのバージョンのExcel 2016にアドインをインストールできる必要がありますが、サポートされていない方法を必要とする機能は、それらのユーザーには表示しないようにする必要があります。
アドインには、デスクトップ Office でサポートされている機能がありますが、モバイル Office ではサポートされていない機能があります。

この記事は、アドインが期待どおりに動作し、可能な限り幅広い対象ユーザーに到達する方法を理解するのに役立ちます。

注:

Office アドインが現在サポートされている場所の概要については、「Office アドインの Office クライアントアプリケーションとプラットフォームの可用性」ページを参照してください。

ヒント

この記事で説明するタスクの多くは、Office アドインの Yeoman ジェネレーターや Visual Studio の Office アドインテンプレートの 1 つなど、ツールを使用してアドインプロジェクトを作成するときに、全体または一部で実行されます。このような場合は、タスクが完了したことを確認する必要があることを意味として解釈してください。

アドインをホストできる Office アプリケーションを指定する

アドインをインストールできる Office アプリケーションを指定するには、 "extensions.requirements.scopes" 配列を使用します。 "mail"、"workbook"、"document"、"presentation"のサブセットを指定します。次の表に、これらの値に対応する Office アプリケーションとプラットフォームの組み合わせを示します。また、スコープごとにインストールできるアドインの種類も示します。

Name	Office クライアントアプリケーション	使用可能なアドインの種類
document	Web、Windows、Mac、iPad 上のWord	作業ウィンドウ
mail	Outlook on the web、Windows (新規およびクラシック)、Android、iOS	メール
プレゼンテーション	PowerPoint on the web、Windows、Mac、iPad	作業ウィンドウ、コンテンツ
workbook	Excel on the web、Windows、Mac、iPad	作業ウィンドウ、コンテンツ

注:

コンテンツアドインには、 "extensions.contentRuntimes" プロパティがあります。 "extensions.runtimes" プロパティを持つことができないため、作業ウィンドウまたはメールアドインと組み合わせることはできません。コンテンツアドインの詳細については、「 Content Office アドイン」を参照してください。

たとえば、次の JSON は、アドインが Excel の任意のリリースにインストールできることを指定します。これには、Excel on the web、Windows、iPad が含まれますが、他の Office アプリケーションにはインストールできません。

"extensions": [
    {
        "requirements": {
            "scopes": [ "workbook" ],
        },
        ...
    }
]

注:

Office アプリケーションは、さまざまなプラットフォームでサポートされ、デスクトップ、Web ブラウザー、タブレット、モバイルデバイスで実行されます。通常、アドインの実行に使用できるプラットフォームを指定することはできません。たとえば、"workbook"を指定した場合、Excel on the webと Windows の両方を使用してアドインを実行できます。ただし、 "mail"を指定した場合、モバイル拡張機能ポイントを定義しない限り、アドインは Outlook モバイルクライアントで実行されません。

アドインで必要な Office API を指定する

Office のバージョンとビルド、またはアドインをインストール可能にするプラットフォームを明示的に指定することはできません。また、アドインで使用するアドイン機能のサポートが新しいバージョンまたはプラットフォームに拡張されるたびにマニフェストを変更する必要があるため、必要ありません。代わりに、アドインに必要な API をマニフェストで指定します。 Office では、API をサポートしていない Office バージョンとプラットフォームの組み合わせにアドインがインストールされないようにし、アドインが マイアドインに表示されないようにします。

重要

アドインが重要な値である必要がある API メンバーを指定するには、"extensions" の直接の子である "requirements" プロパティのみを使用します。アドインで一部の機能に API を使用しているが、API を必要としないその他の便利な機能がある場合は、API をサポートしていないが、それらの組み合わせでエクスペリエンスが低下するプラットフォームと Office のバージョンの組み合わせにインストールできるようにアドインを設計する必要があります。このためには、"extensions"の直接の子ではない"requirements"プロパティを使用します。詳細については、「代替エクスペリエンスの設計」を参照してください。

要件セット

アドインで必要な API を指定するプロセスを簡略化するために、Office はほとんどの API を要件セットにまとめます。共通 API オブジェクトモデルの API は、サポートされている開発機能によってグループ化されます。たとえば、テーブルバインドに接続されているすべての API は、"TableBindings 1.1" という要件セット内にあります。アプリケーション固有のオブジェクトモデルの API は、運用環境のアドインで使用するためにリリースされたときによってグループ化されます。

要件セットはバージョン管理されます。たとえば、ダイアログボックスをサポートする API は、要件セット DialogApi 1.1 にあります。作業ウィンドウからダイアログへのメッセージングを有効にする追加の API がリリースされると、DialogApi 1.1 のすべての API と共に DialogApi 1.2 にグループ化されました。 要件セットの各バージョンは、以前のすべてのバージョンのスーパーセットです。

要件セットのサポートは、Office アプリケーション、Office アプリケーションのバージョン、および実行されているプラットフォームによって異なります。たとえば、ExcelApi 1.17 は、Office 2024 より前のボリュームライセンスの永続的なバージョンの Office ではサポートされていませんが、ExcelApi 1.14 はOffice 2021に戻ってサポートされています。使用する API をサポートするプラットフォームと Office バージョンのすべての組み合わせにアドインをインストールできるようにする必要があるため、必ずマニフェストで、アドインに必要な各要件セットの最小バージョンを指定する必要があります。これを行う方法の詳細については、この記事の後半で説明します。

ヒント

要件セットのバージョン管理の詳細については、「 Office 要件セットの可用性」を参照し、要件セットの完全な一覧と各 API に関する情報については、 Office アドイン要件セットから始めます。ほとんどの Office.js API のリファレンストピックでは、所属する要件セット (存在する場合) も指定します。

extensions.requirements.capabilities プロパティ

"requirements.capabilities" プロパティを使用して、アドインをインストールするために Office アプリケーションでサポートする必要がある最小要件セットを指定します。 Office アプリケーションまたはプラットフォームが、 "requirements.capabilities" プロパティで指定された要件セットまたは API メンバーをサポートしていない場合、アドインはそのアプリケーションまたはプラットフォームで実行されないため、 マイアドインには表示されません。

ヒント

アプリケーション固有のモデル内のすべての API は要件セットに含まれていますが、共通 API モデル内の API の一部は含まれません。アドインで要件セットに含まれていない API が必要な場合は、API の可用性を確保するためのランタイムチェックを実装し、サポートされていない場合はアドインのユーザーにメッセージを表示できます。詳細については、「実行時に API の可用性を確認する」を参照してください。

次のコード例は、次をサポートするすべての Office アプリケーションとプラットフォームの組み合わせにインストール可能なアドインを構成する方法を示しています。

TableBindings 要件セット。最小バージョンは "1.1" です。
OOXML 要件セット。最小バージョンは "1.1" です。

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

ヒント

"extensions.requirements" プロパティの使用方法の詳細と別の例については、「Microsoft 365 の統合マニフェストで Office アドインの要件を指定する」の「"extensions.requirements"」セクションを参照してください。

アドインをインストールできるフォームファクターを指定する

Outlook アドインの場合、アドインをデスクトップ (タブレットを含む) またはモバイルフォームファクターにインストールできるようにする必要があるかどうかを指定できます。これを構成するには、 "extensions.requirements.formFactors" プロパティを使用します。次の例では、Outlook アドインを両方のフォームファクターにインストールできるようにする方法を示します。

"extensions": [
    {
        "requirements": {
            ...
            "formFactors": [
                "desktop",
                "mobile"
            ]
        },
        ...
    }
]

代替エクスペリエンスの設計

Office アドインプラットフォームが提供する機能拡張機能は、次の 3 種類に分けることができます。

アドインのインストール直後に使用できる機能拡張機能。この種の機能の例としては、カスタムリボンボタンとメニューであるアドインコマンドがあります。
アドインが実行されていて、Office.js JavaScript API で実装されている場合にのみ使用できる機能拡張機能。たとえば、ダイアログボックスです。
実行時にのみ使用できるが、Office.js JavaScript とマニフェスト構成の組み合わせで実装される機能拡張機能。これらの例としては、 Excel カスタム関数、シングルサインオン、カスタムコンテキストタブなどがあります。

アドインで機能の一部に特定の機能拡張機能を使用しているが、機能拡張機能を必要としないその他の便利な機能がある場合は、拡張機能機能をサポートしていないプラットフォームと Office のバージョンの組み合わせにインストールできるようにアドインを設計する必要があります。これらの組み合わせに関する貴重な、減少したエクスペリエンスを提供できます。

この設計は、機能拡張機能の実装方法に応じて異なる方法で実装します。

JavaScript で完全に実装される機能については、「実行時に API の可用性を確認する」を参照してください。
マニフェストを構成する必要がある機能については、「 Microsoft 365 の統合マニフェストで Office アドインの要件を指定する」の「フィルター機能」セクションを参照してください。

フィードバック

このページはお役に立ちましたか?

Last updated on 2025-02-14

次の方法で共有

統合マニフェストを使用して Office アプリケーションと API の要件を指定する

最新の Office JavaScript API ライブラリを使用する