Office JavaScript API ライブラリの参照

  • [アーティクル]

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

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

これにより、アドインが初めて読み込まれた時点で Office JavaScript API ファイルがダウンロードおよびキャッシュされ、指定したバージョンに対してOffice.jsとその関連ファイルの最新の実装が使用されていることを確認できます。

重要

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

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

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

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

注:

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

TypeScript プロジェクトの IntelliSense の有効化

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

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

プレビュー API

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

注:

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

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

他の Microsoft 365 環境の CDN 参照

21Vianet は、ライセンスを取得した Microsoft テクノロジを利用したOffice 365 サービスを運営および管理し、現地の法律や規制に準拠したOffice 365サービスを中国に提供します。 このクラウド環境内で使用するために開発されたアドインでは、対応する CDN を使用する必要があります。 標準の CDN 参照の代わりに を使用https://appsforoffice.cdn.partner.office365.cn/appsforoffice/lib/1/hosted/office.jsします。 これにより、継続的なコンプライアンスが確保され、アドインのパフォーマンスが向上します。

関連項目