ファイルのサムネイル (小さい画像レプリゼンテーション) を取得します。
サイズ32x32
、64x64
、128x128
、256x256
は.png
形式で返すことができます。また、サイズ32x32
、160x160
、320x320
は.jpg
形式で返すことができます。
サムネイルを生成できる画像および動画フ ァイルの形式については、こちらを参照してください。
png
The file format for the thumbnail.
次の値のいずれか1つ: png
,jpg
12345
ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123
の場合、file_id
は123
です。
320
32
320
The maximum height of the thumbnail.
320
32
320
The maximum width of the thumbnail.
32
32
320
The minimum height of the thumbnail.
32
32
320
The minimum width of the thumbnail.
サムネイルを作成できる場合は、レスポンスの本文内でサムネイルデータが返されます。
サムネイルを作成できる場合は、レスポンスの本文内でサムネイルデータが返されます。
サムネイルの生成には数秒かかることがあります。そのような場合、APIはこのファイルタイプに対して使用できるプレースホルダグラフィックを示すLocation
ヘッダーを返します。
プレースホルダグラフィックはサムネイルの生成が完了するまでユーザーインターフェースで使用できます。Retry-After
ヘッダーは、サムネイルの準備がいつ完了するかを示します。その時点で、このエンドポイントを再試行するとサムネイルを取得できます。
このファイルタイプのサムネイルをBoxで生成できない場合は、エラーを返します。
代わりに、このファイルタイプのプレースホルダグラフィックを指すLocation
ヘッダーが返されます。
パラメータが不足しているか無効の場合はエラーを返します。
requested_preview_unavailable
- 正しくないサイズがリクエストされました。これは、リクエストされたサイズが、サムネイル形式で使用可能なファイルサイズよりも大きいか小さい場合に、またはサイズの制約どうしが矛盾している場合に発生します。Authorization
ヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
ファイルが見つからない場合、ユーザーがファイルにアクセスできない場合、またはその他の理由でファイルを使用できない場合に返されます。
preview_cannot_be_generated
- Box does not support thumbnails for this type of file.予期しないクライアントエラー。
curl -i -X GET "https://api.box.com/2.0/files/12345/thumbnail.png" \
-H "authorization: Bearer <ACCESS_TOKEN>"
await client.files.getFileThumbnailById(
thumbnailFile.id,
'png' as GetFileThumbnailByIdExtension,
);
client.files.get_file_thumbnail_by_id(
thumbnail_file.id, GetFileThumbnailByIdExtension.PNG
)
await client.Files.GetFileThumbnailByIdAsync(fileId: thumbnailFile.Id, extension: GetFileThumbnailByIdExtension.Png);
file_id = '11111'
thumbnail = client.file(file_id).get_thumbnail_representation('92x92', extension='jpg')
Stream thumbnailContents = await client.FilesManager.GetThumbnailAsync("11111", maxWidth: 160, maxHeight: 160);