SharePoint アドイン

  • [アーティクル]

SharePoint アドインには 2 つの基本的な種類、SharePoint ホスト型とプロバイダー ホスト型があります。 シナリオの開発に適した種類について最適な決定をするには、SharePoint アドインの両方の種類の共通点を学ぶことから始めます。

注:

モバイル アプリなどのデバイス アプリは、SharePoint にアクセスしても実際には「SharePoint アドイン」ではありません。 同じことが、SharePoint の外部から起動される Web アプリケーションにも当てはまります。 これらの種類のアプリを開発する場合は、「モバイルおよびネイティブ デバイス アプリから SharePoint にアクセスする」を参照してください。

  • SharePoint アドインは機能の自己完結型の部分であり、SharePoint Web サイトの機能を拡張して、適切に定義されたビジネス上の問題を解決します。
  • アドインには、SharePoint サーバー上で実行されるカスタム コードはありません。 代わりに、すべてのカスタム ロジックがクラウドに「上げられる」か、またはクライアント コンピュータに「下げられる」か、または SharePoint ファームや SharePoint Online サブスクリプションの外部にあるオンプレミス サーバーに「移される」ことになります。 SharePoint サーバーでカスタム コードをオフにしておくと、SharePoint 管理者は、アドインがサーバーに危害を加えたり、SharePoint Online Web サイトのパフォーマンスを低下させたりすることがないという安心感が得られます。
  • SharePoint アドインのビジネス ロジックは、SharePoint に含まれるいくつかのクライアント API のうちのいずれかを使用して SharePoint データにアクセスできます 。 アドインに使用する API は、他の特定の設計上の決定に応じて異なります。
  • ページ、リスト、ワークフロー、カスタム コンテンツ タイプ、リスト テンプレート、Web パーツなどを含む主な種類の SharePoint コンポーネントは、ほぼすべて SharePoint アドインの一部にすることができます。
  • SharePoint アドインがインストールされ、ユーザーがそれらを起動する SharePoint Web サイトは、ホスト Web と呼ばれます。 ただし、SharePoint コンポーネントは通常、アドイン Web と呼ばれるホスト Web の特別な子 Web にあります。
  • SharePoint アドインは、次に示すいくつかの方法で SharePoint Web サイトに収めることができます。
    • イマーシブ フル ページ SharePoint アプリ エクスペリエンス: SharePoint ページの外観を持つ イマーシブ フル ページ エクスペリエンスとして 。
    • SharePoint アプリのアプリ パーツ エクスペリエンス: Web ページの一部として、アドイン パーツと呼ばれる特殊な種類のコントロールを使用して、アドインを含む iframe 要素を表示します。
    • SharePoint アプリのカスタム アクション エクスペリエンス: リスト、ドキュメントなどの リボンとメニューを拡張する UI コマンドとして 。
  • SharePoint Web サイトの [サイト コンテンツ] ページに、ユーザーがインストールしたすべての SharePoint アドインのタイルがあります。 タイルをクリックすると、アドインを実行します。
  • SharePoint アドインは、アドイン マニフェストを使用して構成されます。アドイン マニフェストは、アドインの基本プロパティ、動作する場所、アドインの開始時に SharePoint が何を実行する必要があるかを宣言する XML ファイルです。 とりわけ、アドインでサポートされる言語、アドインが依存する SharePoint のサービスと機能、アドインが必要とするホスト Web へのアクセス権を指定できます。 (SharePoint アドインには独自のアドイン Web のフル コントロールがあります。)
  • SharePoint アドインはアドイン パッケージとして配布されます。このパッケージには、1 つ以上のアドイン マニフェストが必ず含まれています。 (SharePoint コンポーネントがない場合、アドイン パッケージ内にアドイン マニフェストしかない場合もあります。) アドイン Web 内にアドインの SharePoint コンポーネントがある場合は、XML ファイルのセットとしてパッケージに組み込まれます。 リモート Web アプリケーションやデータベースなど、SharePoint 外でホストされるリモート コンポーネントは、パッケージに組み込まれておらず、アドイン パッケージとは別に展開されます。 (ただし、アドイン マニフェストはリモート コンポーネントの URL を指定します。)
  • Office アドインがアドイン パッケージに組み込まれる場合もあります。SharePoint アドインのインストール時に、Office アドインは SharePoint 内の Office アドイン カタログに追加されます。 ユーザーは、このカタログから、Word や Excel のような Office アプリケーションにインストールできます。

ヒント

Office ストアのいくつかの SharePoint アドインを見て、開発できる内容を把握します。 または、SharePoint Web サイトを開き、無料の SharePoint アドインの一部をインストールします。[ サイト コンテンツ] に移動|アドイン |を追加するだけです。SharePoint ストア。

熟練した SharePoint 開発者向けの注意点

カスタム サーバー側コードを含むセキュリティで保護されたソリューション の使用を廃止しました。 JavaScript のみを含む「コードのない」セキュリティで保護されたソリューション や セキュリティで保護されたソリューション は引き続きサポートされています。

SharePoint アドインはサーバー側 SharePoint オブジェクト モデルを使用しません。 SharePoint ではクライアント側オブジェクト モデルが大幅に拡張されています。 SharePoint サーバー オブジェクト モデルの一部の API は、クライアント オブジェクト モデルでは使用できませんが、これらはほとんどすべて管理関連とセキュリティ関連のクラスです。 Windows PowerShell スクリプトや従来の SharePoint ファーム ソリューションには、これらの領域に対処するカスタム SharePoint ロジックの方が適しています。 SharePoint アドイン、従来の SharePoint ファーム ソリューション、セキュリティで保護されたソリューションの中からの選択については、「SharePoint アドインと SharePoint ソリューションの比較」を参照してください。

アドイン パッケージの配布または販売に関する 2 つの方法

次の 2 つの方法で、アドイン パッケージを配布できます。

  • 組織のアドイン カタログに。これは、SharePoint Online サブスクリプションまたはオンプレミス ファーム内の専用の SharePoint サイト コレクションです。 この方法は、アドインが特定の組織向けにオーダーメイドされている場合に使用します。
  • Office ストアに。 このストアは、検索から購入、更新まで、マーケティング プロセスを処理します。 マイクロソフトは、Office ストアを通じてアドインを販売するのに役立つ販売者ダッシュボードを提供しています。

どちらかの方法でアドインを展開した後、SharePoint Web サイトの [ アドインの追加] ページでインストールできるようになります。 ホスト Web かその親のサブスクリプションへのアクセス許可が必要なアドインの場合、SharePoint からそのアドインをインストールするユーザーに対してそれらのアクセス許可を付与するように求められます。

バグの修正や機能の追加のためにアドインを更新する必要がある場合は、アドイン マニフェスト内で変更を加えてアドインのバージョン番号を上げます。 それから、アドイン パッケージをストアかアドイン カタログに再展開します。 SharePoint の UI で、ユーザーは更新版が利用可能になったことを示す通知を 24 時間以内に受け取ります。 1 回クリックするだけで更新版をインストールできます。

2 種類のSharePoint アドイン: SharePoint ホスト型とプロバイダー ホスト型

SharePoint ホスト型アプリとプロバイダー向けのホスト型アプリの比較

SharePoint ホスト型 SharePoint アドイン

SharePoint ホスト型アドインは、アドイン Web 内の SharePoint コンポーネントでほぼすべて構成されます。 中心が Sharepoint 内にあると表現されることもあります。

すべての SharePoint アドインと同様に、ユーザーは SharePoint ホスト型アドインを、そのインストール先の SharePoint Web サイトの [サイト コンテンツ] ページ上のタイルから実行できます。 オプションで、他にアドイン パーツとカスタム アクション (つまり、カスタムのリボン ボタンやメニュー項目) の 2 種類の UI コンポーネントをホスト Web 内に持つこともできます。 SharePoint ホスト型アドイン内の他のコンポーネントはすべてアドイン Web に展開されます。 これらのコンポーネントは、XML ファイルを使用して宣言的に定義され、とりわけ、次のものが含まれます。

  • カスタム ページ
  • ワークフロー
  • モジュール (ファイルのセット)
  • リスト テンプレート
  • リストとライブラリのインスタンス
  • カスタム リスト フォームとビュー
  • カスタム コンテンツ タイプ
  • Web テンプレート
  • 組み込み列 (カスタム列ではない)
  • 組み込み Web パーツ (カスタム Web パーツではない)
  • JavaScript ファイル
  • アドイン Web のカスタムのボタンとメニュー項目

SharePoint ホスト型アドイン内のすべてのビジネス ロジックは JavaScript を、直接カスタム ページで使用するか、またはカスタム ページから参照される JavaScript ファイル内で使用します。 JavaScript バージョンの SharePoint オブジェクト モデル (JSOM) を使用すると、アドインが SharePoint データに対して CRUD (作成、読み取り、更新、削除) 操作を実行する方法を簡素化できます。

SharePoint ホスト型アドイン内のカスタム ページは、通常は ASP.NET ページ (ASPX) で、ASP.NET コントロールや組み込みの SharePoint コントロールを宣言的に参照できますが、背後にコードがない場合もあります。 ただし、クライアント側レンダリング オプションやカスタム JavaScript を使用して SharePoint コントロールをカスタマイズできます。

SharePoint ホスト型アドイン内の JavaScript は、特別な JavaScript クロスドメイン ライブラリか特定の JavaScript WebProxy クラスのいずれかの、ブラウザーの同一生成元ポリシーを安全に回避する 2 つの手法のいずれかを使用して、アドイン Web 外のデータやリソースにアクセスできます。 これらの手法を使用して、SharePoint ホスト型アドインはホスト Web、その親のサブスクリプション、またはインターネット上の任意の場所のデータを操作できます。

プロバイダー ホスト型 SharePoint アドイン

SharePoint ホスト型アドイン内に組み込める SharePoint コンポーネントを、プロバイダー ホスト型アドインにも組み込めます。 しかし、プロバイダー ホスト型アドインは、1 つ以上のリモート コンポーネント (SharePoint ファームや SharePoint Online サブスクリプションの外部でホストされる Web アプリケーション、サービス、データベースなど) が含まれている点が SharePoint ホスト型アドインと異なります。 これは、SharePoint ファームと同じ企業ネットワーク内のサーバーや、クラウド サービスなどです。 外部コンポーネントは、Linux、Apache、MySQL、PHP (LAMP) スタックなど、任意の Web ホスト型スタックでホストできます。

注:

「プロバイダー」は、サーバーやクラウド アカウントを所有する人です。 アドインのインストール場所の SharePoint ファームか SharePoint Online テナンシーを所有している会社や組織の場合もあります。 しかし、アドインの開発者もプロバイダーになれます。 通常、組織に対するアドインを作成する際には、その組織がホスティングを提供します。 しかし、複数の組織に対するアドインを作成するときは、開発者がリモート コンポーネントをホストする場合が多くなります。 SharePoint アドインが Office ストアを通じて販売される場合は、開発者はアドインの購入者の連絡先情報がわからないので、開発者によるホスティングが必要です。 このシナリオでは、アドイン マニフェスト内で指定されているため、アドインのさまざまなインスタンスがリモート コンポーネントの URI を認識しています。

リモート コンポーネントに使用するホスティング フレームワークには高い柔軟性があります。 Microsoft スタックを使用する必要はありません。 LAMP (Linux、Apache サーバー、MySQL、PHP)、MEAN (MongoDB、ExpressJS、AngularJS、Nodejs)、Java、Python などの任意の Web ホスティング フレームワークを使用できます。Microsoft 以外の開発ツールを使用しても問題ありません。 さらに、Microsoft 以外のクラウド サービスでリモート コンポーネントをホストすることもできます。

特別なクロム コントロールを使用して、アドイン内のリモート ページに SharePoint ページの外観を付与できます。

BLOB、キャッシュ、メッセージ キュー、コンテンツ配信ネットワーク (CDN)、データベースなどのリモート データを使用できます 。 リレーショナルやオブジェクト指向など、どの種類のデータベースでも使用できます。 リモート データにはさまざまな方法でアクセスできます。 たとえば、Business Connectivity Services (BCS) を使用して SharePoint リストのデータを表示できます。 また別の選択肢としては、リモート Web アプリケーションのページ上のグリッドでデータを公開する方法があります。

SharePoint アドインでは、SharePoint API を使用して、 検索、ワークフロー、ソーシャル ネットワーク、分類、ユーザー プロファイル、BCS などの SharePoint 機能に接続して統合します。 これにより、ドキュメントの読み取り、検索、ユーザーの接続、CRUD 操作の実行が可能になります。 API のセットは複数あります。

  • .NET を使用してリモート コンポーネントが実装されている場合、マネージ コードの SharePoint クライアント側オブジェクト モデル (CSOM) ライブラリを使用できます。
  • .NET に基づいていないリモート コンポーネントには、SharePoint データにアクセスするために使用できる REST/OData API のセットがあります。 OData インターフェイスの操作を選んだ場合、.NET クライアントから使用することもできます。
  • 前述の JSOM ライブラリ はリモート ページでは使用できませんが、プロバイダー ホスト型アドインはアドイン Web 内にカスタム SharePoint ページを持つことができ、これらのページ上の JavaScript は JSOM ライブラリを使用できます。

SharePoint にアクセスするプロバイダー ホスト型アドインは、ユーザーやグループと同じくセキュリティ プリンシパルです 。 ユーザーの場合と同様に、アドインのプリンシパルが認証されて承認される必要があります。 アドインには、ホスト Web 内の SharePoint データに対して操作を実行するアクセス許可が必要です。 ほとんどのシナリオでは、SharePoint アドインを通じて SharePoint を操作するユーザーのアクセス許可として有効なのは、ユーザーのアクセス許可とアドインのアクセス許可の共通部分ですが、ユーザーがアクセス許可を持っていない操作をアドインを使用して実行できるシナリオもあります。

プロバイダー ホスト型アドインは、内部や公共の Web サービスに接続できます。また SharePoint ホスト型アドインとは違って、ドキュメント ライブラリへのアイテムの追加など、SharePoint のリスト イベントやリスト項目イベントを処理できます。

SharePoint 開発パスの選択

始める準備はいいですか。

  • SharePoint 開発の経験が豊富な場合は、最初に SharePoint ホスト型アドインを使用することをお勧めします。 過去に経験した種類の SharePoint 拡張に最も似ています。

    SharePoint ホスト型の SharePoint アドインの作成を始める

  • ASP.NET Web アプリケーション開発の経験が豊富な場合は、最初にプロバイダー ホスト型アドインを使用することをお勧めします。それらは Web アプリケーションを中心にして開発されます。

    プロバイダー ホスト型 SharePoint アドインの作成を始める

  • マイクロソフト以外のスタックでプロバイダー ホスト型アドインを開発する場合は、この記事で開始する方法を示します。

注:

SharePoint と Web 開発の初心者の方は、最初に Microsoft Virtual Academy の無料のコースを利用するか、または SharePoint の開発に関する資料を読むと、最大の益が得られます。

関連項目