次の方法で共有

アドインを変換して、Microsoft 365 の統合マニフェストを使用する

アドインのみのマニフェストを使用するアドインに Teams 機能または Copilot 拡張機能を追加する場合、またはアドインを将来の証拠として追加するには、Microsoft 365 の統合マニフェストを使用するように変換する必要があります。

注:

Microsoft 365 の統合マニフェストは、運用環境の Outlook アドインで使用できます。Excel、PowerPoint、Word アドインのプレビューとしてのみ使用できます。

アドイン プロジェクトをアドインのみのマニフェストから統合マニフェストに変換するには、3 つの基本的なタスクがあります。

  • マニフェストを変換する準備ができていることを確認します。
  • XML 形式のアドインのみのマニフェスト自体を、統合マニフェストの JSON 形式に変換します。
  • サイドローディングまたはデプロイのために、新しいマニフェストと 2 つのアイコン イメージ ファイル (後述) を zip ファイルにパッケージ化します。 変換されたアドインをサイドロードする方法によっては、このタスクが自動的に実行される場合があります。

注:

Microsoft 365 の統合マニフェストを使用する Office アドインを 直接 サポートするクライアントとプラットフォームについては、「Office アドイン と Microsoft 365 用統合アプリ マニフェスト」を参照してください。

注:

  • 統合マニフェストを使用するアドインは、Office バージョン 2304 (ビルド 16320.20000) 以降でのみサイドロードできます。
  • Visual Studio で作成されたプロジェクトは、Visual Studio Code とは異なりますが、現時点では変換できません。
  • Teams Toolkit または Microsoft 365 Agents Toolkit またはOffice Yeoman Generator の "統合マニフェスト" オプションを使用してプロジェクトを作成した場合は、統合マニフェストが既に使用されています。

マニフェストを変換する準備ができていることを確認する

次のセクションでは、マニフェストを変換する前に満たす必要がある条件について説明します。

アドインの既存のバージョンをアンインストールする

UI コントロール名やその他の問題との競合を回避するには、変換を行うコンピューターに既存のアドインがインストールされていないことを確認してください。 アドインのアンインストールに問題が発生した場合は、「 ゴースト アドインを削除する」を参照してください。

2 つの特別なイメージ ファイルがあることを確認する

アドインのみのマニフェストに <IconUrl> と <HighResolutionIconUrl> (その順序) 要素の両方がまだない場合は、 <Description> 要素のすぐ下に追加します。 DefaultValue 属性の値は、イメージ ファイルの完全な URL である必要があります。 イメージは、次の表に示すように、指定したサイズにする必要があります。

Office アプリケーション <IconUrl> <HighResolutionIconUrl>
Outlook 64 x 64 ピクセル 128x128 ピクセル
その他のすべての Office
アプリケーション		 32 x 32 ピクセル 64 x 64 ピクセル

次のマークアップの例を示します。

<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="MailApp">
  <Id>01234567-89ab-cdef-0123-4567-89abcdef0123</Id>
  <Version>1.0</Version>
  <ProviderName>Contoso</ProviderName>
  <DefaultLocale>en-us</DefaultLocale>
  <DisplayName DefaultValue="Great Add-in"/>
  <Description DefaultValue="A great add-in."/>
  <IconUrl DefaultValue="https://localhost:3000/assets/icon-64.png" />
  <HighResolutionIconUrl DefaultValue="https://localhost:300/assets/icon-128.png" />

  <!-- Other markup omitted -->

必要に応じてアドイン コマンドの数を減らす

統合マニフェストを使用するアドインには、20 個を超える アドイン コマンドがない場合があります。 アドインのみのマニフェストの <Action> 要素 の合計数が 20 を超える場合は、アドインを 20 以下に再設計する必要があります。

マニフェスト内のアドイン ID、バージョン、ドメイン、および関数名を更新する

  1. <ID> 要素の値を新しいランダム GUID に変更します。

  2. <Version> 要素の値を更新し、semver 標準 (MAJOR) に準拠していることを確認します。マイナー。PATCH)。 各セグメントの桁数は 5 桁以下です。 たとえば、 1.0.0.0 の値を 1.0.1 に変更します。 semver Standard のプレリリースとメタデータ バージョンの文字列拡張機能はサポートされていません。

  3. マニフェスト内のアドインの URL のドメイン セグメントが https://localhost:3000を指していることを確認します。

  4. マニフェストに <FunctionName> 要素がある場合は、その値の文字数が 65 文字未満であることを確認します。

    重要

    この要素の値は、JavaScript または TypeScript ファイルの関数にマップされているアクションの名前と Office.actions.associate 関数と完全に一致している必要があります。 マニフェストで変更する場合は、associate()にも渡されるactionId パラメーターで変更してください。

必要に応じて文字列値を短縮する

必要に応じて、変換の次の効果に照らしてマニフェスト値を確認して変更します。

  • <DisplayName>の最初の 30 文字は、統合マニフェストの"name.short"の値になります。
  • <DisplayName>の最初の 100 文字は、統合マニフェストの"name.full"の値になります。
  • <Description>の最初の 250 文字は、統合マニフェストの"description.short"の値になります。
  • <Description>の最初の 4,000 文字は、統合マニフェストの"description.full"の値になります。
  • <ProviderName>の最初の 32 文字は、統合マニフェストの"developer.name"の値になります。

変更されたアドインのみのマニフェストが機能することを確認する

  1. 変更されたアドインのみのマニフェストを検証します。 「Office アドインのマニフェストを検証する」を参照してください。

  2. アドインをサイドロードして実行できることを確認します。 テストについては、「 Office アドインのサイドロード」を参照してください。

プロジェクトの変換を試みる前に、問題を解決します。

変換ツールとオプション

残りのタスクは、プロジェクトに使用する IDE やその他のツール、およびプロジェクトの作成に使用したツールに応じて、いくつかの方法で実行できます。

注:

マニフェストの変換は、ツールキットのインポート機能を使用してアドイン プロジェクトを Agents Toolkit にインポートする効果の 1 つです。 詳細については、「Agent Toolkit へのアドイン プロジェクトのインポート」を参照してください。

Office アドイン用 Yeoman ジェネレーターを使用して作成されたプロジェクトを変換する (別名"Yo Office")

プロジェクトが Office アドイン用 Yeoman ジェネレーターを使用して作成された場合は、次の手順に従って変換します。

  1. プロジェクトのルートで、コマンド プロンプトまたは bash シェルを開き、次のコマンドを実行します。 これにより、マニフェストが変換され、package.jsonが更新され、現在のツール パッケージが指定されます。 新しい統合マニフェストはプロジェクトのルートにあり、古いアドインのみのマニフェストは backup.zip ファイルにあります。 このコマンドの詳細については、「 Office-Addin-Project」を参照してください。

    npx office-addin-project convert -m <relative-path-to-XML-manifest>

  2. npm install を実行します。

  3. アドインをサイドロードするには、「 Office アドイン用 Yeoman ジェネレーターを使用して作成されたアドインをサイドロードする (Yo Office)」を参照してください。

Office アドイン用 Yeoman ジェネレーターを使用して作成されていない NodeJS プロジェクトと npm プロジェクトを変換する (Yo Office)

Yo Office でプロジェクトが作成されていない場合は、office-addin-manifest-converter ツールを使用します。

プロジェクトのルートで、コマンド プロンプトまたは bash シェルを開き、次のコマンドを実行します。 このコマンドは、元のアドインのみのマニフェストのファイル名の幹と同じ名前のサブフォルダーに統合マニフェストを配置します。 たとえば、マニフェストの名前が MyManifest.xmlの場合、統合マニフェストは .\MyManifest\MyManifest.json に作成されます。 このコマンドの詳細については、「 Office-Addin-Manifest-Converter」を参照してください。

npx office-addin-manifest-converter convert <relative-path-to-XML-manifest>

統合マニフェストを作成したら、zip ファイルを作成してサイドロードする 2 つの方法があります。 詳細については、「他の NodeJS プロジェクトと npm プロジェクトをサイドロードする」を参照してください。

注:

元のアドインのみのマニフェストで <Override> 要素を使用してマニフェスト内の文字列をローカライズした場合、変換プロセスはローカライズされた言語ごとに JSON 文字列ファイルを生成します。 これらのファイルは zip ファイルにも含まれている必要があり、 "localizationInfo.additionalLanguages.file" プロパティに示されている相対パスにある必要があります。

次の手順

アドインの古いバージョンと新しいバージョンの両方を維持するかどうかを検討します。 「 統合マニフェストとアドインのみのマニフェスト バージョンの Office アドインの両方を管理する」を参照してください。