CMS API | ファイルマネージャー

​

ファイルをアップロードする

• ファイル名：cat.png
• HubSpotファイルマネージャー内の移動先フォルダー: /library/cat_archive
• HubSpotでのファイルのアクセシビリティー: 非公開でアクセス可能

curl --request POST \
  --url 'https://api.hubapi.com/files/v3/files?=' \
  --header 'Authorization: Bearer pat-na1-00000000-0000-0000-0000-000000000000' \
  --header 'Content-type: multipart/form-data' \
  --form file=@/Users/person/Downloads/cat.png \
  --form 'options={"access": "PRIVATE"}' \
  --form folderPath=/library/cat_archive

// 201 Response from successful file upload
{
  "id": "122692044085",
  "createdAt": "2023-06-28T17:56:45.393Z",
  "updatedAt": "2023-06-28T17:56:45.393Z",
  "archived": false,
  "parentFolderId": "122692510820",
  "name": "cat",
  "path": "/library/cat_archive/cat.png",
  "size": 24574,
  "height": 219,
  "width": 225,
  "encoding": "png",
  "type": "IMG",
  "extension": "png",
  "defaultHostingUrl": "https://12345.fs1.hubspotusercontent-na1.net/hubfs/12345/library/cat_archive/cat.png",
  "url": "https://12345.fs1.hubspotusercontent-na1.net/hubfs/12345/library/cat_archive/cat.png",
  "isUsableInContent": true,
  "access": "PRIVATE"
}

​

ファイルのアップロードステータスを確認する

• PENDING：ファイルはアップロード待ちのキューにあります。インポート処理はまだ開始されていません。
• PROCESSING：ファイルはアップロード中です。
• CANCELED：アップロードはキャンセルされ、ファイルはアップロードされません。ファイルをHubSpotアカウントにインポートするには、ファイルを再度アップロードする必要があります。
• COMPLETE：ファイルがファイルツールに正常にアップロードされました。アップロードされたファイルがファイルツールに表示されます。

​

ファイルの詳細を表示する

​

ファイルを削除する

​

フォルダーを作成する

//Example request body of POST request to /files/v3/folders
{
  "name": "myNewFolder",
  "parentFolderId": 12345
}

​

V3における変更点

• このAPI経由でアップロードした全てのファイルは、ファイルダッシュボードおよびファイル選択時に表示されるようになりました。非表示ファイルを作成することはできません。ただし、非公開ファイルとインデックス登録不可のファイルは引き続き作成できます。
• ファイルのリストでは、非表示のファイルや削除済みのファイルが返されなくなりました。ただし、適用できるフィルターの種類が大幅に増えました。非表示のファイルは引き続きIDを指定して取得できますが、その場合は新しいスコープfiles_ui_hidden.read.が必要になります。
• 1回のリクエストで複数のファイルをアップロードすることはできなくなりました。
• 移動や名前変更などのフォルダー更新アクションは非同期になりました。リクエストごとに、フォルダーの編集ステータスの確認に使用できるトークンが返されます。
• ファイルを作成または置換するエンドポイントを使用するには、ファイルのアクセスレベルを指定することが必要になりました。アクセスレベルは以下の通りです。
  • PUBLIC_INDEXABLE: ファイルが一般に公開され、URLを知っている全員がアクセスできます。このファイルは、検索エンジンによるインデックス登録が可能です。
  • PUBLIC_NOT_INDEXABLE: ファイルが一般に公開され、URLを知っている全員がアクセスできます。ファイルの取得時には常に「X-Robots-Tag: noindex」ヘッダーが送信され、検索エンジンに対し、ファイルをインデックス登録しないよう通知されます。
  • PRIVATE: ファイルは一般に公開されません。コンテンツを表示するには署名付きURLが必要です。検索エンジンはこのファイルのインデックス登録を行うことができません。
• ファイルを作成するエンドポイントでは、ファイルのアップロードオプションの一部として、重複検出レベルを指定できます。
  • ENTIRE_PORTAL: アカウント内で重複するファイルを検索します。
  • EXACT_FOLDER: 指定されたフォルダー内で重複するファイルを検索します。
  • NONE: 重複の検証を実行しません。
  • REJECT: 重複が見つかった場合はアップロードを拒否します。
  • RETURN_EXISTING: 重複したファイルが見つかった場合は、新しいファイルをアップロードせずに、見つかった重複ファイルを返します。
  • 重複検出はduplicateValidationScopeを基に機能するため、重複の検索にも影響します。
  • 重複が検出された場合の処理を指示するduplicateValidationStrategyも必要です。