ZIPアーカイブのダウンロード

フォルダ内のすべてのファイル、またはフォルダ構造全体をダウンロードするには、ZIPアーカイブを作成してダウンロードする必要があります。

ZIPアーカイブの作成

最初に、ファイルまたはフォルダ構造を含むZIPアーカイブを作成する必要があります。アカウントのアップロード上限に達しない限り、最大10,000のファイルまたはフォルダIDを含めることができます。

curl -i -X POST "https://api.box.com/2.0/zip_downloads" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "download_file_name": "January Financials",
       "items": [
         {
           "type": "file",
           "id": "12345"
         },
         {
           "type": "file",
           "id": "34325"
         },
         {
           "type": "folder",
           "id": "45678"
         }
       ]
     }'

await client.zipDownloads.createZipDownload({
  items: [
    {
      id: file1.id,
      type: 'file' as ZipDownloadRequestItemsTypeField,
    } satisfies ZipDownloadRequestItemsField,
    {
      id: file2.id,
      type: 'file' as ZipDownloadRequestItemsTypeField,
    } satisfies ZipDownloadRequestItemsField,
    {
      id: folder1.id,
      type: 'folder' as ZipDownloadRequestItemsTypeField,
    } satisfies ZipDownloadRequestItemsField,
  ],
  downloadFileName: 'zip',
} satisfies ZipDownloadRequest);

client.zip_downloads.create_zip_download(
    [
        CreateZipDownloadItems(id=file_1.id, type=DownloadZipItemsTypeField.FILE),
        CreateZipDownloadItems(id=file_2.id, type=DownloadZipItemsTypeField.FILE),
        CreateZipDownloadItems(id=folder_1.id, type=DownloadZipItemsTypeField.FOLDER),
    ],
    download_file_name="zip",
)

await client.ZipDownloads.CreateZipDownloadAsync(requestBody: new ZipDownloadRequest(items: Array.AsReadOnly(new [] {new ZipDownloadRequestItemsField(id: file1.Id, type: ZipDownloadRequestItemsTypeField.File),new ZipDownloadRequestItemsField(id: file2.Id, type: ZipDownloadRequestItemsTypeField.File),new ZipDownloadRequestItemsField(id: folder1.Id, type: ZipDownloadRequestItemsTypeField.Folder)})) { DownloadFileName = "zip" });

try await client.zipDownloads.createZipDownload(requestBody: ZipDownloadRequest(items: [ZipDownloadRequestItemsField(id: file1.id, type: ZipDownloadRequestItemsTypeField.file), ZipDownloadRequestItemsField(id: file2.id, type: ZipDownloadRequestItemsTypeField.file), ZipDownloadRequestItemsField(id: folder1.id, type: ZipDownloadRequestItemsTypeField.folder)], downloadFileName: "zip"))

client.getZipDownloads().createZipDownload(new ZipDownloadRequest.Builder(Arrays.asList(new ZipDownloadRequestItemsField(ZipDownloadRequestItemsTypeField.FILE, file1.getId()), new ZipDownloadRequestItemsField(ZipDownloadRequestItemsTypeField.FILE, file2.getId()), new ZipDownloadRequestItemsField(ZipDownloadRequestItemsTypeField.FOLDER, folder1.getId()))).downloadFileName("zip").build())

ArrayList<BoxZipItem> items = new ArrayList<BoxZipItem>();
BoxZipItem file = new BoxZipItem("file", "12345");
BoxZipItem folder = new BoxZipItem("folder", "156472");
items.add(file);
items.add(folder);
BoxZip zip = new BoxZip(api);
BoxZipInfo zipInfo = zip.create("Awesome Zip File", items);

var name = 'test',
items = [
 {
  type: 'file',
  id: '466239504569'
 },
 {
  type: 'folder',
  id: '466239504580'
 }
];
client.files.createZip(name, items)
 .then(zip => {
  /* zip -> {
    "download_url": "https://api.box.com/2.0/zip_downloads/124hfiowk3fa8kmrwh/content",
    "status_url": "https://api.box.com/2.0/zip_downloads/124hfiowk3fa8kmrwh/status",
    "expires_at": "2018-04-25T11:00:18-07:00",
    "name_conflicts": [
     [
      {
       "id": "100",
       "type": "file",
       "original_name": "salary.pdf",
       "download_name": "aqc823.pdf"
      },
      {
       "id": "200",
       "type": "file",
       "original_name": "salary.pdf",
       "download_name": "aci23s.pdf"
      }
     ],
     [
      {
       "id": "1000",
       "type": "folder",
       "original_name": "employees",
       "download_name": "3d366a_employees"
      },
      {
       "id": "2000",
       "type": "folder",
       "original_name": "employees",
       "download_name": "3aa6a7_employees"
      }
     ]
    ]
   }
  */
 });

レスポンスは以下のようになります。

{
  "download_url": "https://dl.boxcloud.com/2.0/zip_downloads/25gvaXcIE4QJlinNiw2oHAQ==ZFs3Q2Xpd7pKBz7OyzXNrUaoW3aJxQRN5znAvyM-KpdEEPdWcQDKU-Dl85Ew/content",
  "status_url": "https://api.box.com/2.0/zip_downloads/25gvaXcIE4QJlinNiw2oHAQ==ZFs3Q2Xpd7pKBz7OyzXNrUaoW3aJxQRN5znAvyM-KpdEEPdWcQDKU-Dl85Ew/status",
  "expires_at": "2023-02-28T10:23:54Z",
  "name_conflicts": []
}

アーカイブ内のファイルとフォルダの名前

ZIPアーカイブ内の名前は、Boxで表示される名前と異なる場合があります。Boxが名前を調整することで、アーカイブがWindowsで展開できるようになるほか、各パスがアーカイブの文字数制限に収まります。 Boxは各ファイルとフォルダの名前を、Windowsで確実に展開できるように変更します。

名前はUnicode NFCに正規化されます。そのため、CJKや日本語の名前など、macOSによってNFD形式で保存される名前もそのまま維持されます。
Windowsでは使用できない文字 (<、>、:、"、/、\、|、?、*) と制御文字は、_に置換されます。
Windowsで予約済みの名前 (CON、PRN、NUL、.、..など) には、末尾に_が追加されます。
ファイル名の最後をピリオドにすることはできません。ファイル名末尾のピリオドは_に置換されます。

アーカイブのフルパスには245文字の上限があります。パスがこの上限を超える場合、以下のようになります。

パスが長すぎる状態になるフォルダ階層から、パスが文字数制限に収まるまで、フォルダ名が_に置換されます。
パスがまだ長すぎる場合は、ファイル名が短縮されます。拡張子は可能な限り維持されます。
それでもパスが245文字より長い場合は、ダウンロードに失敗します。

同じフォルダ内で名前が重複する場合には、名前の末尾に数字が追加されます。たとえば、report.pdfはreport(1).pdfとして保存されます。あるBoxフォルダ内にあるファイルは、アーカイブでもそのフォルダに保持されます。ファイル名が短縮される場合も、それらのファイルが新たなフォルダに格納されることはありません。リクエストに同じ名前の項目が含まれている場合は、name_conflictsで、それぞれのoriginal_nameがアーカイブで使用されるdownload_nameにマッピングされます。

ZIPダウンロードIDの抽出

ZIPアーカイブをダウンロードするには、ZIPダウンロードIDが必要です。これは、アーカイブの作成時に返されたレスポンスで確認できます。 status_urlに移動し、zip_downloadsとcontentの間にあるIDをコピーします。

25gvaXcIE4QJlinNiw2oHAQ==ZFs3Q2Xpd7pKBz7OyzXNrUaoW3aJxQRN5znAvyM-KpdEEPdWcQDKU-Dl85Ew

ダウンロードURLは、expires_atパラメータで指定された日時まで有効です。

ファイルのダウンロード

以下のサンプルのように、ファイルの場所のURLにダウンロードIDを配置して、適切なファイルを指します。

curl -L GET "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -o sample_curl.zip

await client.zipDownloads.getZipDownloadContent(zipDownload.downloadUrl!);

client.zip_downloads.get_zip_download_content(zip_download.download_url)

await client.ZipDownloads.GetZipDownloadContentAsync(downloadUrl: NullableUtils.Unwrap(zipDownload.DownloadUrl));

try await client.zipDownloads.getZipDownloadContent(downloadUrl: zipDownload.downloadUrl!, downloadDestinationUrl: URL(path: destinationPathString))

client.getZipDownloads().getZipDownloadContent(zipDownload.getDownloadUrl())

ArrayList<BoxZipItem> items = new ArrayList<BoxZipItem>();
BoxZipItem file = new BoxZipItem("file", "12345");
BoxZipItem folder = new BoxZipItem("folder", "156472");
items.add(file);
items.add(folder);
BoxZip zip = new BoxZip(api);
FileOutputStream stream = new FileOutputStream();
BoxZipDownloadStatus zipDownloadStatus = zip.download("Another Awesome Zip File", items, stream);
stream.close();
if (zipDownloadStatus.getState() == BoxZipDownloadStatus.State.SUCCEEDED) {
    System.out.println("Zip downloaded successfully");
}

name = 'test'
file = mock_client.file('466239504569')
folder = mock_client.folder('466239504580')
items = [file, folder]
output_file = open('test.zip', 'wb')
status = client.download_zip(name, items, output_file)
print(f'The status of the zip download is {status["state"]}')

BoxZipRequest request = new BoxZipRequest();
request.Name = "test";
request.Items = new List<BoxZipItemRequest>();

var file = new BoxZipRequestItem()
{
    Id = "466239504569",
    Type = BoxZipItemType.file
};
var folder = new BoxZipRequestItem()
{
    Id = "466239504580",
    Type = BoxZipItemType.folder
};
request.Items.Add(file);
request.Items.Add(folder);
Stream fs = new FileStream(@"c:\temp\MyTest.zip");

BoxZipDownloadStatus status = await _filesManager.DownloadZip(request, fs);

var name = 'test',
items = [
 {
  type: 'file',
  id: '466239504569'
 },
 {
  type: 'folder',
  id: '466239504580'
 }
],
stream = new Readable();
client.files.downloadZip(name, items, stream)
 .then(status => {
  /* status -> {
    "total_file_count": 20,
    "downloaded_file_count": 10,
    "skipped_file_count": 10,
    "skipped_folder_count": 10,
    "state": "succeeded"
   }
  */
 });

ダウンロードに時間がかかる場合は、を使用してダウンロードのステータスを監視できます。これにより、ダウンロードの進行状況のほか、スキップされた可能性のある項目の数を確認できます。

curl -i -X GET "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!);

client.zip_downloads.get_zip_download_status(zip_download.status_url)

await client.ZipDownloads.GetZipDownloadStatusAsync(statusUrl: NullableUtils.Unwrap(zipDownload.StatusUrl));

try await client.zipDownloads.getZipDownloadStatus(statusUrl: zipDownload.statusUrl!)

client.getZipDownloads().getZipDownloadStatus(zipDownload.getStatusUrl())

SDKを使用してフォルダのコンテンツをダウンロードする場合は、のガイドに従ってください。

はじめに

アプリケーションと統合

IDとアクセス

APIの利用

トラブルシューティング

コンテンツ

コラボレーション

メタデータと検索

イベントとWebhook

ユーザー

インテリジェントなワークフロー

電子サイン

セキュリティとコンプライアンス

ZIPアーカイブのダウンロード

ZIPアーカイブの作成

アーカイブ内のファイルとフォルダの名前

ZIPダウンロードIDの抽出

ファイルのダウンロード

​ZIPアーカイブの作成

​アーカイブ内のファイルとフォルダの名前

​ZIPダウンロードIDの抽出

​ファイルのダウンロード

ZIPアーカイブの作成

アーカイブ内のファイルとフォルダの名前

ZIPダウンロードIDの抽出

ファイルのダウンロード