Office アドイン マニフェスト

  • [アーティクル]

すべての Office アドインにはマニフェストがあります。 マニフェストには次の 2 種類があります。

  • XML マニフェスト: これは、運用環境アドインで現在サポートされているマニフェストの唯一の種類です。名前が示すように、XML 形式です。 この種類のマニフェストは、アドインと他の種類の Teams アプリを組み合わせたアプリには使用できません。つまり、Microsoft 365 プラットフォームの他の種類の拡張機能です。
  • Microsoft 365 の統合マニフェスト: これは、Teams Apps のマニフェストとして何年も使用されてきた JSON 形式のマニフェストです。 現在はプレビューとしてのみ、Outlook for Windows でのみアドインでサポートされています。 運用環境のアドインでは使用しないでください。 一般提供にリリースされる場合、このマニフェストを使用するアドインは、ユニット全体としてインストールできる 1 つのアプリ内の他の種類の Teams アプリと組み合わせることができます。

この記事の残りの部分は、両方の種類のマニフェストに適用されます。

ヒント

Office アドインのマニフェスト ファイルには、エンド ユーザーが Office ドキュメントやアプリケーションと共にアドインをインストールして使用するときに、アドインをアクティブ化する方法が記述されています。

マニフェスト ファイルを使用すると、Office アドインで次の操作を実行できます。

  • ID、バージョン、説明、表示名、および既定のロケールを指定することで、アプリ自体について説明する。

  • アドインのブランド化に使用するイメージと、Office アプリ リボンでアドイン コマンドに使用する画像を指定する。

  • アドインを Office に統合する方法を指定する。アドインによって作成されるカスタム UI (リボンのボタンなど) の統合も含む。

  • コンテンツ アドインに必要な既定のサイズ、および Outlook アドインに必要な高さを指定する。

  • ドキュメントの読み取り、書き込みなど、Office アドインに必要なアクセス許可を宣言する。

注:

アドインを AppSource に 公開 し、Office エクスペリエンス内で利用できるようにする場合は、商用マーケットプレイスの認定ポリシー に準拠していることを確認してください。 たとえば、検証に合格するには、アドインは、定義したメソッドをサポートするすべてのプラットフォーム全体で機能する必要があります (詳細については、セクション 1120.3 と「Office アドイン アプリケーションと可用性」のページを参照してください)。

ホストするための要件

アドイン コマンドに使用されるすべてのイメージ URI は、運用環境でのキャッシュをサポートする必要があります。 イメージをホストしているサーバーは、HTTP 応答で 、no-store、または同様のCache-Controlオプションを指定するno-cacheヘッダーを返すべきではありません。 ただし、アドインを開発し、イメージ ファイルに変更を加える場合、キャッシュによって変更が表示されない可能性があるため、開発ではヘッダーを使用 Cache-Control することをお勧めします。

アドイン内のコードまたはコンテンツ ファイルに対するすべての URL は 、SSL で保護された (HTTPS) である必要があります。 すべてのアドインのシナリオで厳密に求められるわけではないものの、アドインに対して HTTPS エンドポイントを使用することを強くお勧めします。 SSL で保護されている (HTTPS) のではないアドインは、使用中に、保護されていないコンテンツの警告やエラーを生成します。 アドインをOffice on the web実行する場合、またはアドインを AppSource に発行する場合は、SSL で保護されている必要があります。 アドインが外部データやサービスにアクセスする場合、アドインを SSL で保護して送信中のデータを保護する必要があります。 自己署名証明書がローカル マシンで信頼されている限り、この証明書は開発とテストに使用できます。

AppSource に提出するためのベスト プラクティス

アドイン ID が有効で、一意の GUID であることを確認してください。 Web 上で、一意の GUID を作成するために使用できるさまざまな GUID ジェネレーター ツールを利用できます。

AppSource に送信されるアドインには、マニフェストにサポート URL も含める必要があります。 詳細については、「AppSource に提出されたアプリとアドインの検証ポリシー」をご覧ください。

アドイン ウィンドウで開くドメインの指定

Office on the web で実行している場合、作業ウィンドウは任意の URL に移動できます。 ただし、デスクトップ プラットフォームでは、アドインが (マニフェスト ファイルで指定されているように) スタート ページをホストするドメイン以外のドメインの URL に移動しようとすると、その URL は Office アプリケーションのアドイン ウィンドウの外側の新しいブラウザー ウィンドウで開きます。

この (デスクトップ Office) の動作をオーバーライドするには、マニフェストのアドイン ウィンドウで開く各ドメインを指定します。 アドインがこの一覧にあるドメインの URL に移動しようとすると、Office on the web とデスクトップの Office の両方の作業ウィンドウで開きます。 この一覧にない URL に移動しようとすると、その URL はデスクトップの Office 新しいブラウザー ウィンドウ (アドイン ウィンドウとは別のウィンドウ) で開きます。

注:

この動作に対する例外は 2 つあります。

  • これは、アドインのルート ウィンドウに対してのみ適用されます。 アドイン ページに iframe が埋め込まれている場合、iframe は、デスクトップ Office でも、マニフェストに一覧表示されているかどうかに関係なく、任意の URL に転送できます。
  • displayDialogAsync API を使用してダイアログを開くと、メソッドに渡される URL はアドインと同じドメインに存在する必要がありますが、ダイアログは、マニフェストに表示されているかどうかに関係なく、デスクトップ Office でも任意の URL に転送できます。

Office.js API 呼び出しが行われるドメインを指定する

アドインは、マニフェスト ファイルで参照されている広告インのドメインから api 呼び出しをOffice.jsできます。 アドイン内に、Office.js API にアクセスする必要がある他の iframe がある場合は、そのソース URL のドメインをマニフェスト ファイルに追加します。 マニフェストに一覧にないソースを持つ iframe がOffice.js API 呼び出しを試行した場合、アドインは アクセス許可拒否エラーを受け取ります。

関連項目