次の方法で共有

Office JavaScript API ライブラリの参照

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

<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 が完全に初期化されるようにする必要があります。

Office.js 固有の Web API の動作

Office.js は、replaceStateとpushStateの既定の Window.history メソッドをnullに置き換えます。 アドインがこれらのメソッドに依存している場合は、Office.js ライブラリ参照を次の回避策に置き換えます。

<script type="text/javascript">
    // Cache the history method values.
    window._historyCache = {
        replaceState: window.history.replaceState,
        pushState: window.history.pushState
    };
</script>

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

<script type="text/javascript">
    // Restore the history method values after loading Office.js
    window.history.replaceState = window._historyCache.replaceState;
    window.history.pushState = window._historyCache.pushState;
</script>

この回避策を 提案して検証するために、@stepperと Stack Overflow コミュニティ に感謝します。

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

前の HTML スニペットでは、CDN URL の前のoffice.js/1/は、バージョン 1 の Office.js 内の最新の増分リリースを指定しています。 Office JavaScript API は下位互換性を維持するため、最新リリースではバージョン 1 で以前に導入された API メンバーが引き続きサポートされます。

Office アドインを Microsoft Marketplace に発行する予定の場合は、この 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

Microsoft ではまず、"プレビュー" で新しい JavaScript API を導入します。十分なテストとユーザー フィードバックの後、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を使用します。 これにより、継続的なコンプライアンスが確保され、アドインのパフォーマンスが向上します。

関連項目

  • Last updated on