Table of contents
TOC
目次を折りたたむ
目次を展開する
最終更新日: 2017/11/10

Office 365 でのファイル ハンドラーの構成と更新

適用対象:Office 365

アプリ マニフェストと addIns プロパティ

Azure Active Directory (AD) のアプリケーション エンティティには、ファイル ハンドラーをサポートするための新しいプロパティ addIns が含まれています。 addIns プロパティは、アプリに含まれるファイル ハンドラーおよび関連するプロパティを詳細化します。 これらの詳細情報は、拡張子に対応するファイル ハンドラーを Office 365 で構成し、その拡張子に関して、ファイルの新規作成、開く、プレビューの動作を指定するために使用されます。

マニフェストの構文は次のとおりです。

{
    "addIns": [
        {
            "id": "unique guid",
            "type": "FileHandler",
            "properties": [
                {
                    "key": "extension",
                    "value": "List of file extensions separated by semicolons"
                },
                {
                    "key": "fileIcon",
                    "value": "URL of icon for the file type"
                },
                {
                    "key": "newFileUrl",
                    "value": "URL for the new file function"
                },
                {
                    "key": "openUrl",
                    "value": "URL for the file open function"
                },
                {
                    "key": "previewUrl",
                    "value": "URL for the file preview function"
                }
            ]
        }
    ]
}

プロパティのキーは、大文字と小文字が区別されます。

スキーマについては、次の表で説明します。

メンバー説明データ型子メンバー
addInsルート要素。アプリケーションのファイル ハンドラーを定義するオブジェクトの配列が含まれます。arrayなしtype
properties
idアドイン コレクション内で個別のアドインを識別します。この値は、GUID 生成ツールを使用して生成できます。GUIDaddInsなし
typeアドインの型。ファイル ハンドラーの場合、値は "FileHandler" になります。stringaddInsなし
propertiesファイル ハンドラーのプロパティを定義します。objectaddInsextension
fileIcon
newFileUrl
previewUrl
openUrl
extension先頭の "." 文字を含まないファイル ハンドラーの拡張子 (例: "psd")。セミコロンで区切ることで、複数の拡張子を指定できます。stringpropertiesなし
fileIconファイルの種類を表すアイコンの URL (例: "https://fabrikam.com/SampleFileHandler/psdicon.png" )。プロトコルは https でなければならず、HTML ページで表示される任意のイメージ形式を使用できます。イメージは自動的にサイズ変更されます。このイメージに推奨される寸法は、32x32 ピクセルです。stringpropertiesなし
newFileUrl新規ファイル機能の URL (例: "https://fabrikam.com/SampleFileHandler/newFile" )。プロトコルは https でなければなりません。stringpropertiesなし
previewUrlプレビュー機能の URL (例: "https://fabrikam.com/SampleFileHandler/preview" )。プロトコルは https でなければなりません。stringpropertiesなし
openUrl編集用にファイルを開く機能の URL (例: "https://fabrikam.com/SampleFileHandler/open" )。プロトコルは https でなければなりません。stringpropertiesなし

ファイル ハンドラーを構成するには、addIns プロパティを使用して、Azure AD のアプリ マニフェストにファイル ハンドラーの詳細を追加する必要があります。 現時点では、これを実行するための UI が Azure 管理ポータルに存在しません。そのため、Azure AD Graph API のクエリを使用する必要があります。

最初のクエリでは、アプリケーションの objectId を取得する必要があります。 これには、クエリのフィルター パラメーターとして appId を指定した GET 要求を使用する必要があります。 objectIdappId は、どちらもアプリケーションを識別する GUID ですが、それぞれの値は異なります。

appId (クライアント ID とも呼ばれる) は、Azure 管理ポータルのアプリの構成ページにある [クライアント ID] プロパティでわかります。 また、アプリケーションの web.config の appSettings セクションの ClientID キーでもわかります。

objectId を取得するには、次に示す GET 要求を Azure AD Graph に送信します。

GET https://graph.windows.net/contoso.com/applications?api-version=1.6&$filter=appId%20eq%20'appId'

contoso.com は自分のテナント ドメインに置き換えてください。また、appId はクライアント ID の値に置き換えてください。 このクエリは、objectId プロパティを格納しているアプリケーション オブジェクトを返します。

この時点で、ファイル ハンドラーの構成を更新するためのクエリを作成できます。次に例を示します。

PATCH https://graph.windows.net/contoso.com/applications/objectId/?api-version=1.6

contoso.com は自分のテナント ドメインに置き換えてください。また、objectId は最初のクエリで取得した objectId の値に置き換えてください。 コンテンツ タイプを application/json に設定し、ファイル ハンドラーの構成の詳細を指定する json を要求の本文で渡します。

addIns プロパティは Azure AD Graph 1.6 スキーマ の一部であるため、前述の例に示したように、api-version パラメーターには 1.6 を指定する必要があります。

詳細については、「Azure AD Graph API のバージョン管理」を参照してください。

アプリケーション構成の更新後、マニフェスト ファイルをダウンロードすると、変更内容は見えなくなります。

AddIns Manager サンプル ツール

AddIns Manager サンプル ツールを使用して、ファイル ハンドラーを構成および更新するための Azure AD Graph のクエリを実行できます (ファイル ハンドラー アプリケーションが Azure AD に登録してある場合)。 AddIns Manager ツールを使用すると、Azure AD でアプリの構成が更新されます。

AddIns Manager サンプル ツールは、デモおよびテストのみを目的としたものです。運用環境では使用しないでください。

AddIns Manager ツールを使用してファイル ハンドラーを構成するには

  1. AddIns Manager サンプル ツールに移動します。
  2. ブラウザーにページが読み込まれたら、ページの右上にある [Sign in] をクリックします。
  3. テナント管理者の資格情報を入力して、[sign in] をクリックします。
  4. 左側のナビゲーション バーの [My Applications] で、ファイル ハンドラー アプリの名前を選択します。
  5. [Register Add-In] をクリックします。
  6. [Register Add-In] ダイアログで、[File Handler] を選択します。
  7. [File Handler Add-In] のドロップダウンをクリックします。
  8. ファイル ハンドラーの詳細を入力します。 プロトコルは HTTPS にする必要があります。
  9. [Update Add-In] をクリックします。

ファイル ハンドラーが正常に構成されると、正常な更新を確認するダイアログ ボックスが表示されます。

© 2018 Microsoft