次の方法で共有

Microsoft 365 の統合マニフェストを使用する Office アドインをサイドロードする

Microsoft 365 の統合マニフェストを使用するアドインをサイドローディングするプロセスは、使用するツールとアドイン プロジェクトの作成方法によって異なります。

注:

統合マニフェストを使用するアドインは、Office on Windows バージョン 2304 (ビルド 16320.20000) 以降でサイドロードできます。 Windows でのサイドローディングは、Office on the webへのサイドローディングの効果もあります。 現時点では、Mac または iPad ではサイドロードできません。

Office アドイン用 Yeoman ジェネレーターを使用して作成されたサイドロード アドイン (Yo Office)

「サイドロード」で説明されているプロセス を、システム プロンプト、bash シェル、またはターミナルで使用します。

Microsoft 365 エージェント ツールキットを使用したサイドロード

  1. まず、 サイドロードする Office デスクトップ アプリケーションが閉じられていることを確認します。

  2. Visual Studio Code で、[エージェント ツールキット] を開きます。

  3. Outlook にのみ必要: [ACCOUNTS ] セクションで、Microsoft 365 にサインインしていることを確認します。

  4. Visual Studio Code で [表示 | Run] を 選択します。 [ 実行とデバッグ ] ドロップダウン メニューで、アドインに必要に応じてこれらのオプションのいずれかを選択します。

    • Excel Desktop (Edge Chromium)
    • Outlook Desktop (Edge Chromium)
    • PowerPoint デスクトップ (Edge Chromium)
    • Word デスクトップ (Edge Chromium)

  5. F5 キーを押します。 プロジェクトがビルドされ、Node dev-server ウィンドウが開きます。 このプロセスには数分かかる場合があり、選択した Office アプリケーションのデスクトップ バージョンが開きます。 これで、アドインを操作できるようになりました。 Outlook アドインの場合は、Microsoft 365 アカウント ID の受信トレイで作業していることを確認してください。

  6. デバッグを停止してアドインをアンインストールするには、[Visual Studio Code で 実行 | Stop デバッグ ] を選択します。 サーバー ウィンドウを閉じてもサーバーが確実に停止せず、Office アプリケーションを閉じても、Office がアドインの取得を解除する可能性は確実にありません。

    注:

    前の手順で効果が見つからない場合は、Visual Studio Code で TERMINAL を 開いてアドインをアンインストールし、セクションの 最後 の手順であるアンインストール手順 ( サイドロード) をシステム プロンプト、bash シェル、またはターミナルで完了します。

システム プロンプト、bash シェル、またはターミナルを使用したサイドロード

  1. まず、 サイドロードする Office デスクトップ アプリケーションが閉じられていることを確認します。
  2. システム プロンプト、bash シェル、または Visual Studio Code TERMINAL を開き、プロジェクトのルートに移動します。
  3. アドインをサイドロードするコマンドは、プロジェクトがいつ作成されたかによって異なります。 プロジェクトのpackage.json ファイルの "scripts" セクションに "start:desktop" スクリプトがある場合は、 npm run start:desktopを実行します。それ以外の場合は、 npm run startを実行します。 プロジェクトがビルドされ、Node dev-server ウィンドウが開きます。 このプロセスには数分かかることがあります。その後、Office ホスト アプリケーション (Excel、Outlook、PowerPoint、またはWord) デスクトップが開きます。
  4. 一部のバージョンの Office では、アドインが完全にアクティブ化されない場合があります。 たとえば、アドインのボタンがリボンに表示されない場合があります。 その場合は、[ホーム] リボンの [アドイン] ボタンを選択します。 開いたポップアップで、アドインを選択します。 これでインストールが完了します。
  5. これで、アドインを操作できるようになりました。
  6. アドインの操作が完了したら、コマンド npm run stopを実行してください。 サーバー ウィンドウを閉じてもサーバーが確実に停止せず、Office アプリケーションを閉じても、Office がアドインの取得を解除する可能性は確実にありません。

他の NodeJS プロジェクトと npm プロジェクトをサイドロードする

サイドロードに使用できるツールは 2 つあります。

Office-Addin-Debugging ツールを使用したサイドロード

  1. アドインをサイドロードするには、次のコマンドを実行します。 このコマンドは、マニフェストの "icons" プロパティで参照されている統合マニフェストと 2 つのアイコン イメージ ファイルを zip ファイルに配置し、Office アプリケーションにサイドロードします。 また、別の NodeJS ウィンドウでサーバーを起動し、localhost でアドイン ファイルをホストします。 このコマンドの詳細については、「 Office-Addin-Debugging」を参照してください。

    npx office-addin-debugging start <relative-path-to-unified-manifest> desktop

  2. office-addin-debugging を使用してアドインを開始する場合は、 常に次のコマンドを使用してセッションを停止します。 サーバー ウィンドウを閉じてもサーバーが確実に停止せず、Office アプリケーションを閉じても、Office がアドインの取得を解除する可能性は確実にありません。

    npx office-addin-debugging stop <relative-path-to-unified-manifest>

Microsoft 365 Agents Toolkit CLI を使用したサイドロード (コマンド ライン インターフェイス)

  1. zip パッケージを作成します。 「 アドイン パッケージ ファイルを手動で作成する」を参照してください。

  2. プロジェクトのルートで、コマンド プロンプトまたは bash シェルを開き、次のコマンドを実行して Agents Toolkit CLI をインストールします。

    npm install -g @microsoft/m365agentstoolkit-cli

  3. 次のコマンドを実行して、アドインをサイドロードします。

    atk install --file-path <relative-path-to-zip-file>

    重要

    このコマンドは、次の例に示すように自動生成されたタイトル ID を含むアドインに関する情報を返します。

    コマンド 'atk install --file-path manifests/contoso/contoso.zip' と、ユーザーのアカウント名、タイトル ID GUID、アプリ ID GUID などのシステム応答。

    サイドローディングとデバッグ セッションを終了するには、このタイトル ID が必要です。 これは、次のレジストリ キーで Windows コンピューターに記録されます。

    HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\OutlookSideloadManifestPath\TitleId

    "Outlook" という文字列は、履歴上の理由からキー名に含まれていますが、エージェント ツールキット CLI でインストールされているアドインに適用されます。

    CLI でインストールされた最新のアドインのみが記録されます。 CLI でインストールした以前のアドインをアンインストールする前に、CLI でアドインをサイドロードした場合、レジストリに以前のアドインのタイトル ID のレコードはありません。 そのため、プロジェクトのルートにあるテキスト ファイルに保存し、Mac コンピューターと Windows コンピューターの両方で TitleID.txt ファイルに名前を付けることもできます。

  4. Agent Toolkit CLI を使用してアドインを開始する場合は、 常に次のコマンドを使用してセッションを停止します。 サーバー ウィンドウを閉じてもサーバーが確実に停止せず、Office アプリケーションを閉じても、Office がアドインの取得を解除する可能性は確実にありません。 "{title ID}" を、"U_" プレフィックスを含むアドインのタイトル ID に置き換えます。たとえば、 U_90d141c6-cf4f-40ee-b714-9df9ea593f39。

    atk uninstall --mode title-id --title-id {title ID} --interactive false

    重要

    uninstall コマンドのドキュメントでは、タイトル ID ではなくアドインのマニフェスト ID を使用する方法について説明します。 CLI が呼び出す API のバグのため、このオプションは現在機能しません。 上記の uninstall コマンドを使用する必要があり、 --interactive false オプションを含める必要があります。

Teams アプリ ストアをサイドロードする

統合マニフェストを使用するアドインは、Teams 関連の機能がなくても、Teams アプリ ストアを介して手動でサイドロードできます。 手順は次のとおりです。

  1. アプリ パッケージがまだツールによって作成されていない場合は、手動で作成します。 「 アドイン パッケージ ファイルを手動で作成する」を参照してください。

  2. すべての Office アプリケーションを閉じてから、「キャッシュを手動でクリアする」の手順に従って Office キャッシュをクリアします。

  3. Teams を開き、アプリ バーから [アプリ] を選択し、[アプリ] ウィンドウの下部にある [アプリの管理] を選択します。

  4. [アプリ] ダイアログで [アプリのアップロード] を選択し、開いたダイアログで [カスタム アプリのアップロード] を選択します。

  5. [ 開く ] ダイアログで、アプリ パッケージに移動して選択します。

  6. 開いたダイアログで [ 追加] を選択します。

  7. アプリが追加されたことを確認するメッセージが表示されたら、Teams でアプリを開 かないでください 。 代わりに、Teams を閉じます。

  8. 次のタスクは、プロジェクトの HTML ファイルと JavaScript ファイルをホストするローカル Web サーバーを起動することです。 これを行う方法は、プロジェクトのフォルダー構造、使用するツール (バンドル、タスク マネージャー、サーバー アプリケーション、それらのツールの構成方法など) など、いくつかの要因によって異なります。 次の手順は、次の条件を満たすプロジェクトにのみ適用されます。

    • プロジェクトのルートには 、 Yeoman Generator for Office アドインまたは Microsoft 365 Agent Toolkit で作成されたアドイン プロジェクトに似たwebpack.config.jsファイルがあります。

    • プロジェクトのルートには、同じ 2 つのツールによって作成されたものと同様の package.json ファイルがあり、ファイルには次のスクリプトが含まれる "scripts" セクションがあります。

      "dev-server": "webpack serve --mode development"

  9. プロジェクトのルートにあるコマンド プロンプトまたは Visual Studio Code TERMINAL で、 npm run dev-server を実行して localhost でサーバーを起動します。

  10. アドインの対象となる Office アプリケーションを開きます。 アドインが読み込まれるまで待ちます。 これには 2 分ほどかかる場合があります。 Office のバージョンによっては、リボン ボタンやその他の成果物が自動的に表示される場合があります。 一部のバージョンでは、アドインを手動でアクティブ化する必要があります。[ホーム] リボンの [アドイン] ボタンを選択し、開いたポップアップでアドインを選択します。 マニフェストの "name.short" プロパティで指定された名前が含まれます。

重要

テスト セッションを終了し、Teams アプリ ストアを通じてサイドロードしたアドインを変更する場合は、次の手順でアドインを完全に削除してください。

  1. Office アプリケーションを閉じます。
  2. サーバーをシャットダウンします。 これを行う方法については、サーバー アプリケーションのドキュメントを参照してください。 Webpack 開発サーバー アプリケーションの場合、シャットダウンは、サーバーが npm run dev-server 実行したのと同じウィンドウで実行されているか、別のウィンドウで実行されているかによって異なります。 同じウィンドウの場合は、ターミナルにフォーカスを設定し、 Ctrl+C キーを押します。 プロンプトに応答してプロセスを終了するには、"Y" を選択します。 別のウィンドウ内にある場合は、 npm run dev-serverを実行したウィンドウで、 npm run stopを実行します。
  3. 「キャッシュを手動でクリアする」の手順に従って Office キャッシュをクリアします。
  4. Teams を開き、アプリ バーから [アプリ] を選択し、[アプリ] ウィンドウの下部にある [アプリの管理] を選択します。
  5. アプリの一覧でアドインを見つけます。 マニフェストの "name.short" プロパティで指定された名前が含まれます。
  6. アプリの一覧からアドインを選択して、その行を展開します。
  7. ごみ箱のアイコンを選択し、プロンプトで [削除 ] を選択します。

変更を加え、もう一度アドインをサイドロードします。

アドイン パッケージ ファイルを手動で作成する

統合マニフェストを使用する場合、インストールとサイドローディングの単位は zip 形式のパッケージ ファイルです。 このファイルは通常、アドインの作成とテストに使用するツールによって自動的に作成されますが、手動で作成するシナリオがあります。 これを行うには、任意の zip ユーティリティを使用して、次のファイルを含む zip ファイルを作成します。

  • 統合マニフェスト。zip ファイルのルートに入ります。
  • マニフェストの "icons" プロパティで参照される 2 つのイメージ ファイル。
  • マニフェストの "localizationInfo" プロパティで参照されるすべてのローカライズ ファイル。
  • "copilotAgents" プロパティで参照されるすべての宣言型エージェント ファイル。
  • 第 2 レベルの補助ファイル。 たとえば、宣言型エージェント構成ファイルは、プラグイン構成ファイルなどの第 2 レベルの補助ファイルを参照する場合があります。 これらも含める必要があります。

重要

これらのファイルはすべて、マニフェストで指定された zip ファイル内の相対パスが同じである必要があります。 たとえば、2 つのイメージ ファイルのパスが assets/icon-64.png と assets/icon-128.pngの場合は、zip パッケージに 2 つのファイルを含む assets フォルダーを含める必要があります。 宣言型エージェントのプラグイン構成ファイルなどの 2 番目のレベルのファイルは、zip ファイル内の相対パスが、それらを参照する第 1 レベルのファイルと同じである必要があります。 たとえば、マニフェストで指定された宣言型エージェント ファイルの相対パスが agents/myAgent.json の場合は、zip パッケージに エージェント フォルダーを含め、 myAgent.json ファイルを配置する必要があります。 宣言型エージェント ファイルがプラグイン構成ファイルのプラグイン/myPlugin.jsonの相対パスを提供する場合は、agents フォルダーの下に plugins サブフォルダーを含め、myPlugin.json ファイルをその中に配置する必要があります。

Microsoft 365 開発ツールとの互換性を最大限に高めるために、パッケージに含まれるファイルを appPackage という名前のフォルダーにプロジェクトのルートに保持し、パッケージ ファイルを appPackage フォルダーの build という名前のサブフォルダーに配置することをお勧めします。

推奨される構造体の例を次に示します。 \build\appPackage.zip ファイル内の構造体は、ビルド フォルダー自体を除き、appPackage フォルダーの構造をミラーする必要があります。

\appPackage
    \assets
        color.png
        outline.png
    \build
        appPackage.zip
    manifest.json

\appPackage
    \agents
        myAgent.json
        \plugins
            myPlugin.json
    \assets
        color.png
        outline.png
    \build
        appPackage.zip
    \languages
        fr-FR.json
        es-MX.json
    manifest.json

注:

"extensions.keyboardShortcuts.keyMappingFiles" プロパティで参照される JSON ファイルは、アプリ パッケージには含まれません。 これらは、アドインの Web アプリケーション ファイルと共にデプロイされます。 詳細については、「 Microsoft Marketplace での統合マニフェストを使用したアドインの下位互換性のサポート」を参照してください。

  • Last updated on