SharePoint REST サンプル集

最終更新日：2020/09/22

はじめに

SharePoint オンプレ、オンラインで使える REST のサンプルを思いついた時にメモ代わりにこの記事へ記載していきます。 SharePoint REST の文法の詳細については、Docs を参照してください。 バージョンは 2013 ですが、壁面に貼るリアルな壁紙もあったりするので、是非プロジェクトルームの目に付くところへどうぞｗ SharePoint 2013 REST Syntax また、対象が SharePoint Online であれば、SharePoint REST ではなく、Microsoft Graph REST API を使う方法もあります。 Graph REST API で SharePoint にアクセスする方法についても、Docs に詳細の記載があるので参考にしてください。 SharePoint REST を使用するか、Graph REST API を使用するかの線引きは、SharePoint にアクセス可能なアクセストークンを既に持っているかどうか。 例えば、SharePoint ページに配置されるスクリプト内から Call するのであれば、SharePoint REST API を使う方が簡単です。 このサンプル集では、SharePoint REST API を取り扱います。

SharePoint サイトの各種設定を手軽に変更する「SP Editor」

はじめに

Chrome ブラウザの拡張機能として、SP Editor という万能ツールが提供されています。 SP Editor を使うことで、PnP PowerShell を使わなくてもページレイアウトの変更ができたり、スクリプトを書かなくてもサイトやリストの設定を即座に変更することができるようになります。 色々試すにはとても重宝するツールになりそうなので、ちょっと試してみました。 ちなみに、この拡張機能は先日リリースされた Chromium 版 Microsoft Edge でも動作しました。 Edge にインストールするためには、[他のストアからの拡張機能を許可します] をオンにして、Chrome ウェブストアから拡張機能をインストールする必要があります。

SharePoint Framework v1.10 の変更点

2020年1月7日に SharePoint Framework v1.10 がリリースされました。 この記事では v1.10 の変更点について気になるところだけ抜粋して記載します。 詳細は以下のリリースノートを確認してください。 SharePoint Framework v1.10 release notes

Teams Personal Apps 開発への対応

• SharePoint Framework で、Teams の個人用アプリの開発が行えるようになりました。
• 個人用アプリは、チームやチャネルを横断して個人視点で利用するアプリの事を指します。
• 参考サイト：docs

リストの更新通知のサブスクライブ

• ドキュメントライブラリに格納されたファイルが更新されると、任意のメソッドがコールバックさせることができる機能が正式リリースとなりました。
• 参考サイト：docs

Application Customizer の事前領域確保

• Application Customizer で使用する領域を事前に確保することで、Application Customizer のロードに時間がかかっても画面の表示乱れが起きなくなります。
• 参考サイト：docs

Office アドイン開発への対応 (dev preview)

• SharePoint Framework で、 Office アドインの開発が行えるようになりました。 ただし、このリリースは開発者プレビューの段階です。
• 参考サイト：docs

Microsoft Search 拡張機能開発への対応 (dev preview)

• Microsoft Search の検索クエリをカスタマイズするために使用する拡張機能の開発が行えるようになりました。 ただし、このリリースは開発者プレビュー段階です。
• 参考サイト：docs

Teams コンテキストへのアクセス手段の変更

• これまで Teams コンテキストにアクセスするには、this.context.microsoftTeams  プロパティを使用していましたが、これが廃止になりました。 代わりに、this.context.sdks.microsoftTeams  を使用します。

TypeScript のバージョン変更

• TypeScript のバージョンが v3.3 になりました。

  [AdSense-B]

モダンページのページレイアウトの種類と変更方法

はじめに

モダンページには複数の種類 (ページレイアウト) があり、それぞれページの特徴が異なります。 ページレイアウトは、いくつかの方法で切り替えることができるのですが、この記事ではページレイアウトの種類と PnP PowerShell を使用した切り替え方法をまとめています。 今後も新しいページレイアウトが追加された際には記事をアップデートしていきたいと思います。

ページレイアウトの種類

2019年12月時点では、以下の3つのページレイアウトが用意されています。 なお、今回のサンプルはコミュニティサイトとして作成したサイトをベースにしているので、サイドリンクバーが表示されていません。

Home

モダンサイトを作成した際に Home.aspx に適用されているページレイアウトです。 ページヘッダーとページタイトルが表示されない状態になります。

モダンサイトのテンプレート展開などを実現する「PnP PowerShell」

PnP PowerShell とは

モダンサイトやリストの自動展開や各種設定を SharePoint 管理コンソールよりも簡単に実施できるようにするためのコマンドレットを多数備えた、PowerShell コマンドライブラリです。 SharePoint Online だけでなく SharePoint オンプレミスに対しても使用することができます。 詳細は docs を参照してください。

どんなことができるの？

PnP PowerShell を使うことで、例えば次のようなことができるようになります。

モダンサイトのテンプレート展開

モダンサイトはテンプレート化することができませんが、PnP PowerShell のプロビジョニングテンプレートを使用することで、予め定めたリストやライブラリを追加したり、ドキュメントを事前にアップロードしてサイトを展開するというようなことができるようになります。 旧来のサイトテンプレートと全く同じではありませんが、サイトテンプレートよりも細かいことまで含めてできるようになります。

SPO のモダン対応を促進する「SharePoint Modernization Scanner」

SharePoint Modernization Scanner とは

SharePoint Modernization Scanner は、SharePoint Online サイトのモダン化を進めるために、SharePoint Online サイトをスキャンしてモダンに切り替えられていないサイトを抽出するツールです。 PnP コミュニティにより維持管理されており、GitHub からダウンロードして無償で使用することができます。 また、詳細な説明資料はマイクロソフトの Docs に掲載されており、Docs に最新モジュールへのリンクも掲載されています。 SharePoint Modernization Scanner は随時アップデートがされており、ドキュメントもそれに合わせて更新されているので、使用する際には常に Docs を確認して最新の情報を参照するようにしてください。 このブログでも、ツールの紹介だけを行い詳細な使い方については割愛しています。

Docker を使った SharePoint Framework 開発環境の構築 その３

はじめに

※2020年2月2日更新 Docker 上に SharePoint Framework の開発環境を構築する手順をまとめました。 この資料の内容は、こちらのスライドからの抜粋となります。 構築手順をまとめて確認したい方は、スライドをダウンロードしてください。 なお、環境構築手順は、 ・開発環境を構築するためにホストとなる PC で行う手順 ・Docker イメージを準備する手順 ・Docker 上でプロジェクトごとに行う手順 の３部構成になっています。 この記事では、Docker 上でプロジェクトごとに行う手順について記載します。

Teams タブ開発基礎講座

先日の Microsoft 365 Developer Bootcamp 2019 Tokyo では、Teams タブの開発を一から学ぶためのハンズオンを行いました。 その際に使用したスライドとソースコードは、それぞれ以下の場所で公開しています。 スライド：SharePoint Framework Teams タブ開発基礎講座

サンプルコード：GitHub   SlideShare では、Teams タブの他にアプリケーションカスタマイザー、フィールドカスタマイザー、コマンドバー開発のための資料も公開していたりするので、SharePoint Framework 開発をはじめる方は参考にしてみてください。 https://www.slideshare.net/HiroakiOikawa/sharepoint-framework-extension[AdSense-B]

SharePoint Framework v1.9.1 の変更点

2019年8月14日に SharePoint Framework  v1.9.1 がリリースされました。 この記事では v1.9.1 の変更点について気になるところだけ抜粋して記載します。 詳細は以下のリリースノートを確認してください。 SharePoint Framework v1.9 release notes

Library Components

• SharePoint Framework におけるコードの再利用を実現するための機能で、自作のファンクションなどを共通コードライブラリとして SharePoint 環境に展開するための機能です。

SharePoint Framework でライブラリコンポーネントタイプを使用する

SharePoint Framework v1.8 の変更点

2019年3月8日に SharePoint Framework  v1.8 がリリースされました。 この記事では v1.8 の変更点について気になるところだけ抜粋して記載します。 詳細は以下のリリースノートを確認してください。 SharePoint Framework v1.8 release notes

Teams タブ

• v1.7 ではプレビュー版としてリリースされていましたが、v1.8 で正式サポートとなりました。
• 「Teams タブ」は SharePoint Framework の Web パーツの開発と同じ開発手法で開発したカスタムアプリケーションを Microsoft Teams に「タブ」として追加できるようにするためのソリューションです。

SharePoint Framework を使用した Microsoft Teams タグの作成