鍋綿ブログ

C#・SharePoint・SharePoint Framework・Office365を中心に扱うブログです。

SharePoint Onlineでファイルのサムネイル画像を取得する方法

SharePoint Onlineの標準機能ではライブラリや検索結果などでファイルのサムネイル画像を見られます。この画像はAPIを使うなどのややこしい方法でなくてもURLさえ知っていれば見られますのでその方法をご紹介します。

 

 

サムネイル画像URLの利用例

例としてSharePoint Frameowrk (SPFx)で開発したWebパーツで利用してみました。一部ファイルでサムネイルが表示できていないように見えるのはサンプルにしたファイルの中身がほとんど空っぽだからですね。

f:id:micknabewata:20191012144920p:plain

SPFxでのドキュメントプレビュー

URLの作り方

以下のページにURLパラメータを付与して取得します。

(サイトURL)/_layouts/15/getpreview.ashx

方法1:ファイルパスでファイルを特定する方法

pathパラメータにファイルパスを指定することでサムネイル画像を取得できます。絶対パスでも相対パスでも指定可能です。

 

構文:(サイトURL)/_layouts/15/getpreview.ashx?path=(ファイルパス)

例 :https://contoso.sharepoint.com/sites/sampleSite/_layouts/15/getpreview.ashx?path=/sites/sampleSite/shared%20documents/04.Sample1.pptx

 

f:id:micknabewata:20191012145900p:plain

ブラウザでURLにアクセスした結果

方法2:guidでファイルを特定する方法

guidSite、guidWeb、guidFileの3つのパラメータを指定してすることでもサムネイル画像を取得できます。ファイルパスが得られない場合に利用します。

 

構文:(サイトURL)/_layouts/15/getpreview.ashx?guidSite=(サイトコレクションGUID)&guidWeb=(サイトGUID)&guidFile=(ファイルGUID)

 

指摘できるURLパラメータの一覧

 上記の他にもオプションを指定することができますので一覧化しておきます。

Parameter Note
action

オプションパラメータ。

ファイル拡張子を明示的に指定します。

サポートされているファイル拡張子は以下URLで取得できます。

(サイトURL)/_layouts/15/getpreview.ashx?action=supportedtypes

guidSite

pathパラメータを指定しない場合、必須。

guidSite、guidWeb、guidFileの3セットで指定します。

guidWeb

pathパラメータを指定しない場合、必須。

guidSite、guidWeb、guidFileの3セットで指定します。

guidFile

pathパラメータを指定しない場合、必須。

guidSite、guidWeb、guidFileの3セットで指定します。

path

guidSite、guidWeb、guidFileの3セットを指定しない場合、必須。

ファイルパスを指定します。

resolution

オプションパラメータ。

サムネイル画像のサイズを0~6の数値を指定します。

index

オプションパラメータ。

表示するページを1から始まる数値で指定します。

PowerPoint、PDFなど1ファイルが複数ページに分かれるファイル種類でのみ指定可能です。

force

オプションパラメータ。

1を指定するとキャッシュを使わずリアルタイムにサムネイル画像を表示します。

指定しない場合、1時間ごとに取得されるキャッシュから画像が返されます。

 

以上、参考になれば幸いです。