マニフェストの問題を検証し、トラブルシューティングするValidate and troubleshoot issues with your manifest

以下の方法を使用して、Office アドイン マニフェストの問題を検証し、トラブルシューティングを行います。Use these methods to validate and troubleshoot issues in your Office Add-ins manifest:

Office アドイン検証ツールを使用してマニフェストを検証するValidate your manifest with the Office Add-in Validator

Office アドインを記述するマニフェスト ファイルが正確かつ完全であることを確認するために、Office アドイン検証ツールを使用してマニフェスト ファイルを検証します。To help ensure that the manifest file that describes your Office Add-in is correct and complete, validate it against the Office Add-in Validator.

Office アドイン検証ツールを使用してマニフェストを検証するにはTo use the Office Add-in Validator to validate your manifest

  1. Node.js をインストールします。Install Node.js.

  2. 管理者としてコマンド プロンプト/ターミナルを開き、次のコマンドを使用して Office アドイン検証ツールとその依存関係をグローバルにインストールします。Open a command prompt / terminal as an administrator, and install the Office Add-in Validator and its dependencies globally by using the following command:

    npm install -g office-addin-validator
    

    注意

    Yo Office が既にインストールされている場合、最新のバージョンにアップグレードすると、検証ツールが依存関係としてインストールされます。If you already have Yo Office installed, upgrade to the latest version, and the validator will be installed as a dependency.

  3. マニフェストを検証するには、次のコマンドを実行します。MANIFEST.XML をマニフェスト XML ファイルへのパスに置き換えます。Run the following command to validate your manifest. Replace MANIFEST.XML with the path to the manifest XML file.

    validate-office-addin MANIFEST.XML
    

XML スキーマと比較してマニフェストを検証するValidate your manifest against the XML schema

マニフェスト ファイルが、使用している要素のすべての名前空間を含む、正しいスキーマに従っていることを確認するにはTo help ensure that the manifest file follows the correct schema, including any namespaces for the elements you are using. 他のマニフェストのサンプルから要素をコピーした場合は、適切な名前空間が含まれていることも再確認します。If you copied elements from other sample manifests double check you also include the appropiate namespaces. XML スキーマ定義 (XSD) ファイルと比較してマニフェストを検証できます。You can validate a manifest against the XML Schema Definition (XSD) files. XML スキーマの検証ツールを使用して、この検証を実行できます。You can use an XML schema validation tool to perform this validation.

コマンド ライン XML スキーマ検証ツールを使用してマニフェストを検証するにはTo use a command-line XML schema validation tool to validate your manifest

  1. tar および libxml をまだインストールしていない場合はインストールします。Install tar and libxml, if you haven't already.

  2. 次のコマンドを実行します。XSD_FILE をマニフェスト XSD ファイルへのパスに置き換え、XML_FILE をマニフェスト XML ファイルへのパスに置き換えます。Run the following command. Replace XSD_FILE with the path to the manifest XSD file, and replace XML_FILE with the path to the manifest XML file.

    xmllint --noout --schema XSD_FILE XML_FILE
    

ランタイム ログを使用して、アドイン マニフェストをデバッグするUse runtime logging to debug your add-in manifest

ランタイムのログを使用して、アドインのマニフェストをデバッグできます。この機能は、リソース ID の不一致のような XSD スキーマ検証では検出されないマニフェストの問題を識別して修正するのに役立ちます。ランタイムのログは、アドイン コマンドを実装するアドインのデバッグに特に有効です。You can use runtime logging to debug your add-in's manifest. This feature can help you identify and fix issues with your manifest that are not detected by XSD schema validation, such as a mismatch between resource IDs. Runtime logging is particularly useful for debugging add-ins that implement add-in commands.

注意

ランタイムのログ機能は現在、Office 2016 デスクトップで利用可能です。The runtime logging feature is currently available for Office 2016 desktop.

ランタイムのログを有効にするにはTo turn on runtime logging

重要

ランタイムのログはパフォーマンスに影響します。アドイン マニフェストに関する問題をデバッグする必要がある場合にのみ有効にしてください。Runtime Logging affects performance. Turn it on only when you need to debug issues with your add-in manifest.

ランタイムのログを有効にするには、以下を実行します。To turn on runtime logging:

  1. Office 2016 デスクトップのビルド 16.0.7019 以降を実行していることを確認します。Make sure that you are running Office 2016 desktop build 16.0.7019 or later.

  2. HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\ の下に RuntimeLogging レジストリ キーを追加します。Add the RuntimeLogging registry key under HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\.

  3. キーの既定値にログを書き込むファイルの完全なパスを設定します。例については、EnableRuntimeLogging.zip を参照してください。Set the default value of the key to the full path of the file where you want the log to be written. For an example, see EnableRuntimeLogging.zip.

    注意

    ログ ファイルが書き込まれるディレクトリが既に存在しており、書き込みアクセス許可がある必要があります。The directory in which the log file will be written must already exist, and you must have write permissions to it.

レジストリは次の図のようになります。The following image shows what the registry should look like. この機能を無効にするには、RuntimeLogging キーをレジストリから削除します。To turn the feature off, remove the RuntimeLogging key from the registry.

RuntimeLogging レジストリ キーを追加したレジストリ エディターのスクリーンショット

マニフェストの問題のトラブルシューティングを行うにはTo troubleshoot issues with your manifest

ランタイムのログを使用してアドインの読み込みに関する問題のトラブルシューティングを行うには、次のようにします。To use runtime logging to troubleshoot issues loading an add-in:

  1. テスト用にアドインをサイドロードします。Sideload your add-in for testing.

    注意

    ログ ファイルのメッセージ数を最小限に抑えるため、テストするアドインのみをサイドロードすることをお勧めします。We recommend that you sideload only the add-in that you are testing to minimize the number of messages in the log file.

  2. 何も起こらず、アドインが表示されない (アドイン ダイアログ ボックスにも表示されない) 場合は、ログ ファイルを開きます。If nothing happens and you don't see your add-in (and it's not appearing in the add-ins dialog box), open the log file.

  3. ログ ファイルでアドインの ID を検索します。ID はマニフェストで定義します。ログ ファイルでは、この ID には SolutionId というラベルが付いています。Search the log file for your add-in ID, which you define in your manifest. In the log file, this ID is labeled SolutionId.

次の例のログ ファイルでは、存在しないリソース ファイルを参照しているコントロールが示されています。この例の問題を修正するには、マニフェストの入力ミスを訂正するか、足りないリソースを追加します。In the following example, the log file identifies a control that points to a resource file that doesn't exist. For this example, the fix would be to correct the typo in the manifest or to add the missing resource.

見つからないリソース ID を指定するエントリが含まれるログ ファイルのスクリーンショット

ランタイムのログに関する既知の問題Known issues with runtime logging

混乱を招くメッセージまたは正しく分類されていないメッセージがログ ファイルに書き込まれることがあります。たとえば次のような場合です。You might see messages in the log file that are confusing or that are classified incorrectly. For example:

  • メッセージ "Medium Current host not in add-in's host list" に続く "Unexpected Parsed manifest targeting different host" は、誤ってエラーとして分類されています。The message Medium Current host not in add-in's host list followed by Unexpected Parsed manifest targeting different host is incorrectly classified as an error.

  • SolutionId が含まれていないメッセージ "Unexpected Add-in is missing required manifest fields DisplayName" は、多くの場合、エラーはデバッグ対象のアドインと関係ありません。If you see the message Unexpected Add-in is missing required manifest fields DisplayName and it doesn't contain a SolutionId, the error is most likely not related to the add-in you are debugging.

  • Monitorable メッセージは、システムの観点からのエラーと予想されます。場合によっては、スキップされたがマニフェスト失敗の原因にはならなかったスペル ミスのある要素のような、マニフェストの問題を示していることがあります。Any Monitorable messages are expected errors from a system point of view. Sometimes they indicate an issue with your manifest, such as a misspelled element that was skipped but didn't cause the manifest to fail.

Office のキャッシュをクリアするClear the Office cache

リボン ボタンのアイコンのファイル名やアドイン コマンドのテキストなど、マニフェスト ファイルに変更を加えたときに、変更内容が反映されていないと思われる場合は、そのコンピューターで Office のキャッシュをクリアしてみてください。If changes you've made in the manifest, such as file names of ribbon button icons, or text of add-in commands, do not seem to take effect, try clearing the Office cache on your computer.

Windows の場合:For Windows:

フォルダー %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\ の内容を削除します。Delete the content of the folder %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\.

Mac の場合: For Mac:

フォルダー /Users/{your_name_on_the_device}/Library/Containers/com.Microsoft.OsfWebHost/Data/ の内容を削除します。Delete the content of the folder /Users/{your_name_on_the_device}/Library/Containers/com.Microsoft.OsfWebHost/Data/.

iOS の場合: For iOS:

アドイン内の JavaScript から window.location.reload(true) を呼び出して強制的に再読み込みします。または、Office を再インストールしてください。Call window.location.reload(true) from JavaScript in the add-in to force a reload. Alternatively, you can reinstall Office.

関連項目See also