基本的なサムネイルの取得
基本的なサムネイルの取得
サムネイルとは小さい画像のことで、アプリケーション内でファイルのレプリゼンテーションとして使用できる.pngまたは.jpgで表されます。たとえば、ファイルをダウンロードまたはプレビューするリンクのプレースホルダとして使用されます。
リクエスト
ファイルのサムネイルをリクエストするには、GET /files/:id/thumbnail.:extensionエンドポイントを使用します。
cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/thumbnail.png" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.files.getFileThumbnailById(
thumbnailFile.id,
'png' as GetFileThumbnailByIdExtension,
);Python Gen
client.files.get_file_thumbnail_by_id(
thumbnail_file.id, GetFileThumbnailByIdExtension.PNG.value
).NET Gen
await client.Files.GetFileThumbnailByIdAsync(fileId: thumbnailFile.Id, extension: GetFileThumbnailByIdExtension.Png);Python
file_id = '11111'
thumbnail = client.file(file_id).get_thumbnail_representation('92x92', extension='jpg').NET
Stream thumbnailContents = await client.FilesManager.GetThumbnailAsync("11111", maxWidth: 160, maxHeight: 160);iOS
client.files.getThumbnail(forFile: "11111", extension: .png) { (result: Result<Data, BoxSDKError>) in
guard case let .success(thumbnailData) = result else {
print("Error getting file thumbnail")
return
}
let thumbnailImage = UIImage(data: thumbnailData)
}サムネイルの作成に成功すると、そのサムネイルがレスポンスの本文内でバイナリデータとして返されます。
サムネイルの非同期的な作成
場合によっては、サムネイルを直接作成できないこともあります。代わりに、APIからlocationレスポンスヘッダーでHTTP 202が返されます。この場所は、サムネイルの生成中に使用できる一時的な画像のためのものです。
このエンドポイントを再試行するまでの推定秒数を示すretry-afterレスポンスヘッダーも返されます。
サポートされているファイルサイズ
以下のサムネイルの形式とサイズが使用可能です。
| ファイルの種類 | サイズ |
|---|---|
| JPG | 32x32, 94x94, 160x160, 320x320, 1024x1024, 2048x2048* |
| PNG | 1024x1024*, 2048x2048* |
*が付いているサイズには、いくつかの制限があります。
ファイルサイズの制限
元のファイルサイズ
サムネイルは拡大されません。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, mts, ogg, qt, wmv |