サムネイルレプリゼンテーションの取得
サムネイルレプリゼンテーションの取得
サムネイルとは小さい画像のことで、アプリケーション内でファイルのレプリゼンテーションとして使用できる.pngまたは.jpgで表されます。たとえば、ファイルをダウンロードまたはプレビューするリンクのプレースホルダとして使用されます。
1024x1024および2048x2048のPNGを除くすべてのサムネイルレプリゼンテーションは、元のファイルをBoxにアップロードしたときに生成されます。
手順
サムネイルレプリゼンテーションを取得するには、以下の手順に従います。
- すべてのレプリゼンテーションのリストを取得する
[jpg?dimensions=32x32]のように目的のサムネイル形式とサイズを表すx-rep-hintsヘッダーを渡して、サムネイルをリクエストする。url_templateを呼び出してサムネイルをダウンロードする。その際、{+asset_path}を空の文字列に置き換えます。
このエンドポイントを再試行するまでの推定秒数を示すretry-afterレスポンスヘッダーも返されます。
例
x-rep-hintsヘッダーの値の例を以下に示します。
x-rep-hints: [jpg?dimensions=32x32] |
|---|
32x32のJPEGサムネイルを返します。 |
x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=1024x1024] |
|---|
32x32および1024x1024のJPEGサムネイルを返します。 |
x-rep-hints: [jpg?dimensions=32x32][png?dimensions=2048x2048] |
|---|
32x32のJPEGサムネイルおよび2048x2048のPNGサムネイルを返します。 |
x-rep-hints: [jpg?dimensions=2048x2048,png?dimensions=2048x2048] |
|---|
2048x2048のJPEGサムネイルおよび2048x2048のPNGサムネイルを返し、使用可能な最初のレプリゼンテーションを返します。どちらも使用可能でない場合は、レプリゼンテーションは返されません。 |
サポートされているファイルサイズ
以下のサムネイルの形式とサイズが使用可能です。
| ファイルの種類 | サイズ |
|---|---|
| JPG | 32x32, 94x94, 160x160, 320x320, 1024x1024, 2048x2048* |
| PNG | 1024x1024*, 2048x2048* |
*が付いているサイズには、いくつかの制限があります。
ファイルサイズの制限
2048x2048のJPEG
2048x2048サイズのJPEGを使用できるのは、元のファイルがJPEGの場合のみです。このサイズを使用する場合は、PNGか、PNGとJPEGの両方をリクエストすることをお勧めします。
動画ファイル
2048x2048のJPEG、2048x20148のPNG、および1024x1024のPNGのレプリゼンテーションは、動画ファイルでは使用できません。
元のファイルサイズ
サムネイルは拡大されません。Boxにアップロードされたファイルの元のファイルサイズがレプリゼンテーションのサイズより小さい場合は、作成されるサムネイルのサイズの上限は元のファイルのサイズになります。
サポートされているファイルの種類
現時点でサポートされているファイルの種類は以下のとおりです。
| ファイルの種類 | ファイル拡張子 |
|---|---|
| ドキュメント | doc, docx, gdoc, gsheet, gslide, gslides, odp, ods, odt, pdf, ppt, pptx, rtf, wpd, xls, xlsm, xlsx, key, pages, numbers |
| 画像 | ai, bmp, dcm, dicm, eps, gif, idml, indd, indt, inx, jpeg, jpg, png, ps, psd, svg, svs, tif, tiff, tga |
| オーディオ | aac, aifc, aiff, amr, au, flac, m4a, mp3, ogg, ra, wav, wma |
| 動画 | 3g2, 3gp, avi, m2v, m2ts, m4v, mkv, mov, mp4, mpeg, mpg, ogg, mts, qt, wmv |