Office JavaScript API ライブラリの参照

JavaScript API Officeには、アドインがアプリケーションと対話するために使用できる API がOfficeされます。 ライブラリを参照する最も簡単な方法は、HTML ページのセクション内に次のタグを追加してコンテンツ配信ネットワーク (CDN) <script> <head> を使用する方法です。

<head>
    ...
    <script src="https://appsforoffice.microsoft.com/lib/1/hosted/office.js" type="text/javascript"></script>
</head>

これにより、Office JavaScript API ファイルが初めて読み込まれると、Office.js の最新の実装と、指定したバージョンの関連ファイルが使用されます。

重要

ページのセクション内Office JavaScript API を参照して、本文要素の前に API が完全に初期化 <head> される必要があります。

API のバージョン管理と下位互換性

前の HTML スニペットでは、CDN URL の前面で、バージョン 1 のバージョン内の最新の増分 /1/ office.js リリースをOffice.js。 JavaScript API Office互換性が維持されるので、最新のリリースでは、バージョン 1 で以前に導入された API メンバーを引き続きサポートします。 既存のプロジェクトをアップグレードする必要がある場合は、「JavaScript API とマニフェスト スキーマ ファイルのバージョンOffice 更新する」を参照してください

AppSource から Office アドインを発行する場合は、この CDN の参照を使用する必要があります。ローカル参照は、内部シナリオ、開発シナリオ、デバッグ シナリオにのみ適用できます。

注意

プレビュー API を使用するには、CDN (https://appsforoffice.microsoft.com/lib/beta/hosted/office.js) にある Office JavaScript API ライブラリのプレビュー バージョンを参照します。

TypeScript プロジェクトIntelliSenseを有効にする

前述のように Office JavaScript API を参照する以外に 、DefinitelyTypedの型定義を使用して TypeScript アドイン プロジェクトの IntelliSense を有効にすることもできます。 これを行うには、プロジェクト フォルダーのルートからノード対応のシステム プロンプト (または git bash ウィンドウ) で次のコマンドを実行します。 (npm を含む) Node.js をインストールしておく必要があります。

npm install --save-dev @types/office-js

プレビュー API

新しい JavaScript API は、最初に "プレビュー" で導入され、後で十分なテストが行われるとユーザーフィードバックが必要になった後、特定の番号付き要件セットの一部になります。

注意

プレビュー API は変更されることがあります。運用環境での使用は意図されていません。 試用はテスト環境と開発環境に限定することをお勧めします。 運用環境やビジネス上重要なドキュメントでプレビュー API を使用しないでください。

プレビュー Api を使用するには:

関連項目