Office JavaScript API について

  • [アーティクル]

Office アドインでは、Office JavaScript API を使用することで、アドインが実行されている Office ドキュメント内のコンテンツを操作できます。

Office JavaScript API ライブラリへのアクセス

Office JavaScript API ライブラリには、https://appsforoffice.microsoft.com/lib/1/hosted/office.js にある Office JS コンテンツ配信ネットワーク (CDN) を経由してアクセスできます。 アドインの Web ページで Office JavaScript API を使用するには、ページの <head> タグにある <script> タグに含まれている CDN を参照する必要があります。

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

注:

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

IntelliSense の入手方法など、Office JavaScript API ライブラリにアクセスする方法の詳細については、「Office JavaScript API ライブラリをそのコンテンツ配信ネットワーク (CDN) から参照する」をご覧ください。

API モデル

Office JavaScript API には、2 つの異なるモデルがあります。

  • アプリケーション固有 API では、特定の Office アプリケーションにネイティブなオブジェクトを操作するために使用できる、厳密に型指定されたオブジェクトが提供されます。 たとえば、Excel JavaScript API を使用して、ワークシート、範囲、テーブル、グラフなどにアクセスすることができます。 現在、アプリケーション固有の API は、次の Office アプリケーションで使用できます。

    この API モデルでは Promise が使用され、Office アプリケーションに送信する各要求で複数の操作を指定することが可能です。 この方法によるバッチ操作を行うと、Web 上の Office アプリケーションのパフォーマンスが大幅に向上します。 Office 2016 では、アプリケーション固有の API が導入されました。

    注:

    Visio 用のアプリケーション固有の API もありますが、SharePoint Online ページでのみ使用して、ページに埋め込まれている Visio ダイアグラムを操作できます。 Office Web アドインは Visio ではサポートされていません。

    この API モデルの詳細については、「アプリケーション固有の API モデルの使用」を参照してください。

  • 共通 API を使用すると、複数の種類の Office アプリケーション間で共通の UI、ダイアログ、クライアント設定などの機能にアクセスすることができます。 この API モデルでは コールバック が使用され、Office アプリケーションに送信する各要求で 1 つの操作のみを指定できます。 一般的な API は Office 2013 で導入され、サポートされている Office アプリケーションとの対話に使用できます。 Outlook、PowerPoint、Project を操作するための API を含む、共通 API オブジェクト モデルの詳細については、「共通 JavaScript API オブジェクト モデル」を参照してください。

注:

共有ランタイムのないカスタム関数は、計算の実行を優先する JavaScript 専用ランタイムで実行されます。 これらの関数は、少し異なるプログラミング モデルを使用します。

API 要件セット

要件セットは、API メンバーの名前付きグループです。 要件セットは、ExcelApi 1.7 要件セット (Excel でのみ使用可能な API のセット) などのように Office アプリケーションに固有の場合もあれば、DialogApi 1.1 要求セット (ダイアログ API がサポートされているすべての Office アプリケーションで使用できる API セット) などのように複数のアプリケーションで共通の場合もあります。

アドインは、要求セットを使用することで、アドインが使用する必要がある API メンバーが Office アプリケーションでサポートされているかどうかを判別できます。 詳細については、「Office アプリケーションと API 要件を指定する」を参照してください。

要件セットのサポートは、Office アプリケーション、バージョン、プラットフォームごとに異なります。 各 Office アプリケーションでサポートされているプラットフォーム、要求セット、および共通 API の詳細については、「Office アドインの Office クライアント アプリケーションとプラットフォームの可用性」を参照してください。

注:

アドインを AppSource に 公開 し、Office エクスペリエンス内で利用できるようにする場合は、商用マーケットプレイスの認定ポリシー に準拠していることを確認してください。 たとえば、検証に合格するには、アドインは、定義したメソッドをサポートするすべてのプラットフォーム全体で機能する必要があります (詳細については、セクション 1120.3 と「Office アドイン アプリケーションと可用性」のページを参照してください)。

関連項目