サムネイルとは小さい画像のことで、アプリケーション内でファイルのレプリゼンテーションとして使用できる.pngまたは.jpgで表されます。たとえば、ファイルをダウンロードまたはプレビューするリンクのプレースホルダとして使用されます。
1024x1024および2048x2048のPNGを除くすべてのサムネイルレプリゼンテーションは、元のファイルをBoxにアップロードしたときに生成されます。
ファイルのサムネイルを取得する方法として、の使用は非推奨になりました。
サムネイルレプリゼンテーションを取得するには、以下の手順に従います。
-
[jpg?dimensions=32x32]のように目的のサムネイル形式とサイズを表すx-rep-hintsヘッダーを渡して、。
url_templateを呼び出してする。その際、{+asset_path}を空の文字列に置き換えます。
場合によっては、サムネイルを直接作成できないこともあります。代わりに、APIからlocationレスポンスヘッダーでHTTP 202が返されます。この場所は、サムネイルの生成中に使用できる一時的な画像のためのものです。
このエンドポイントを再試行するまでの推定秒数を示すretry-afterレスポンスヘッダーも返されます。
x-rep-hintsヘッダーの値の例を以下に示します。
サポートされているファイルサイズ
以下のサムネイルの形式とサイズが使用可能です。
*が付いているサイズには、いくつかの制限があります。
ファイルサイズの制限
2048x2048のJPEG
2048x2048サイズのJPEGを使用できるのは、元のファイルがJPEGの場合のみです。このサイズを使用する場合は、PNGか、PNGとJPEGの両方をリクエストすることをお勧めします。
動画ファイル
2048x2048のJPEG、2048x20148のPNG、および1024x1024のPNGのレプリゼンテーションは、動画ファイルでは使用できません。
元のファイルサイズ
サムネイルは拡大されません。Boxにアップロードされたファイルの元のファイルサイズがレプリゼンテーションのサイズより小さい場合は、作成されるサムネイルのサイズの上限は元のファイルのサイズになります。
サポートされているファイルの種類
現時点でサポートされているファイルの種類は以下のとおりです。
ファイルの種類がドキュメントの場合、返されるレプリゼンテーションはプレースホルダアイコンとなり、実際のサムネイルではありません。