Outlook アドインの API

  • [アーティクル]

Outlook アドインで API を使用するには、Office.js ライブラリの場所、要件セット、スキーマ、アクセス許可を指定する必要があります。 主に 、Mailbox オブジェクトを介して公開される Office JavaScript API を使用します。

Office.js ライブラリ

Outlook アドイン API と対話するには、Office.jsで JavaScript API を使用する必要があります。 ライブラリのコンテンツ配信ネットワーク (CDN) は です https://appsforoffice.microsoft.com/lib/1/hosted/Office.js。 AppSource に送られるアドインは、この CDN で Office.js を参照しなければなりません。ローカル参照は使用できません。

アドインの UI を実行する Web ページ (.html、.aspx、.php のファイル) の <head> タグの中の <script> タグの中で CDN を参照します。

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

新しい API が追加されても、Office.js への URL は同じままになります。 URL 内のバージョンは、既存の API の動作を分割する場合にのみ変更されます。

重要

任意の Office クライアント アプリケーション用のアドインを開発する場合は、ページのセクション内 <head> から Office JavaScript API を参照します。 これにより、あらゆる body 要素の前に API が完全に初期化されます。

要件セット

すべての Outlook API は 、メールボックス要件セットに属しています。 Mailbox の要件セットにはバージョンがあり、リリースされる新しい API の各セットは、新しいバージョンのセットに属しています。 最新の API セットがリリースされても、すべての Outlook クライアントがそれをサポートするわけではありませんが、ある Outlook クライアントが 1 つの要件セットのサポートを宣言した場合、その要件セットの中のすべての API がサポートされます。

どの Outlook クライアントにアドインを表示するかを制御するには、最小の要件セットのバージョンをマニフェストで指定します。 たとえば、要件セットのバージョン 1.3 を指定すると、最小バージョンの 1.3 をサポートしていない Outlook クライアントにはアドインが表示されなくなります。

要件セットを指定しても、そのバージョンの API にアドインを限定することにはなりません。 要件セット v1.1 を指定しているアドインが、v1.3 をサポートする Outlook クライアントで実行されると、そのアドインは v1.3 の API を使用できます。 要件セットでは、どの Outlook クライアントにアドインを表示するかのみを制御します。

マニフェストで指定した要件セットよりも上位の要件セットの API が使用できるかどうかを確認する場合は、標準の JavaScript を使用できます。

if (item.somePropertyOrFunction) {
   item.somePropertyOrFunction...  
}

注:

このような確認は、マニフェストで指定された要件セットのバージョンに存在する API には必要ありません。

それなしではアドインの機能が機能しないような、シナリオに絶対必要な API のセットをサポートする最低限要件セットを指定します。 マニフェストで要件セットを指定します。 マークアップは、使用しているマニフェストによって異なります。

  • XML マニフェスト: Requirements> 要素を使用します<。 Requirements> の Methods 子要素<は Outlook アドインではサポートされていないため、特定のメソッドのサポートを宣言することはできません。><
  • Microsoft 365 (プレビュー) の統合マニフェスト: "extensions.capabilities" プロパティを使用します。

詳細については、「 Office アドイン マニフェスト」および 「Outlook API 要件セットについて」を参照してください。

アクセス許可

アドインには、そのアドインが必要とする API を使用するための適切なアクセス許可が必要になります。 一般的には、アドインに必要な最低限のアクセス許可を指定する必要があります。

アクセス許可には 4 つのレベルがあります。制限付き、読み取り項目、読み取り/書き込みアイテム、および読み取り/書き込みメールボックス。 詳細については、次を参照してください。 詳細については、「Outlook アドインのアクセス許可モデルを理解する」を参照してください。

Mailbox オブジェクト

Outlook アドインでは、主に Mailbox オブジェクトにより公開されている API のサブセットを使用します。 Item オブジェクトなど、Outlook アドインで特に使用するオブジェクトとメンバーにアクセスするには、次のコード行に示すように、Context オブジェクトの mailbox プロパティを使用して Mailbox オブジェクトにアクセスします。

// Access the Item object.
const item = Office.context.mailbox.item;

さらに、Outlook アドインでは、次のオブジェクトを使用できます。

  • Office オブジェクト: 初期化に使用します。

  • Context オブジェクト: コンテンツおよび表示言語のプロパティへのアクセスに使用します。

  • RoamingSettings オブジェクト: アドインがインストールされているユーザーのメールボックスに Outlook アドイン固有のカスタム設定を保存する際に使用します。

Outlook アドインでの JavaScript の使用については、「Outlook アドイン」を参照してください。

関連項目