> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt > Use this file to discover all available pages before exploring further. # CMS API | ファイルマネージャー export const ScopesList = ({scopes = [], description = "この API には、次のいずれかのスコープが必要です。"}) => { if (!scopes || scopes.length === 0) { return null; } const sortedScopes = scopes.sort((a, b) => a.localeCompare(b)); return
{description}
{sortedScopes.map((scope, index) =>
{scope}
)}
; }; HubSpot内でファイルを管理および保存するには、HubSpotのファイルツールを使用します。HubSpotでホスティングされているファイルは、HubSpotでも外部コンテンツでもアップロードして使用することが可能です。[エンゲージメントAPI](/api-reference/overview)を使用して、ファイルをレコードに添付することもできます。 HubSpotのCMSを使用してウェブサイトが構築されている場合、ファイルAPIを使用してアセットをHubSpotにアップロードして保存できます。これらのファイルは、HubSpotのCMSを介して提供および共有することができます。 ファイルツールは[HubSpot内](https://knowledge.hubspot.com/ja/files/upload-files-to-use-in-your-hubspot-content)で、またはファイルAPI経由で利用できます。以下に、ファイルAPIの概要、およびファイルのアップロードと削除の方法について説明します。ファイルAPIエンドポイントの完全なリストについては、 [リファレンスドキュメント](/api-reference/files-files-v3/guide)を確認してください。 ## ファイルをアップロードする ファイルをアップロードするには、以下のフィールドを指定したmultipart/form-data`POST`リクエストを`files/v3/files`に送信します。アップロード時に特定のフォルダーIDは必須ではありませんが、ファイルのアップロード先はルートディレクトリーではなくフォルダーにすることをお勧めします。アップロード時のフォルダーの必要性に関しては、今後変更される可能性がありますのでご留意ください。 | フィールド | 説明 | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `file` | アップロードするファイル（必須）。 | | `options` | ファイルの公開設定とインデックス登録を制御するJSONオブジェクトで、次の2つのフィールドが含まれています。1つは必須の`access`で、もう1つはファイルが自動的に削除されるまでの期間を指定する`ttl`です。`ttl`フィールドを使用する場合の条件は、次の通りです。
| | `folderId` | ファイルのアップロード先とするフォルダーのID。リクエストには、このフィールドまたは`folderPath`のいずれかを指定する必要があります（両方を指定することはできません）。 | | `folderPath` | ファイルのアップロード先とするフォルダーのパス。リクエストには、このフィールド または`folderId`のいずれかを指定する必要があります（両方を指定することはできません）。 | | `fileName` | ファイルの名前。名前が指定されていない場合は、ファイルの内容に基づく名前が生成されます。 | | `charsetHunch` | アップロードするファイルのエンコーディングに使用されている文字セット。指定されていない場合、ファイルから取得されます。 | 例えば、次の条件を満たすファイルをHubSpotアカウントにアップロードする場合： * **ファイル名**：`cat.png` * **HubSpotファイルマネージャー内の移動先フォルダー**: `/library/cat_archive` * **HubSpotでのファイルのアクセシビリティー**: 非公開でアクセス可能 次のヘッダーとリクエスト本文が、リクエストに含まれている必要があります。 ```shell theme={null} 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 ``` 生成されるレスポンスには、アップロードされたファイルの`id`と`parentFolderId`が含まれます。これを使用して、GETリクエスト経由でファイルを取得できます。 ```json theme={null} // 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" } ``` ## ファイルのアップロードステータスを確認する `files/v3/files/import-from-url/async`への`POST`リクエストを使用してファイルをURLからファイルマネージャーにインポートする際には、ファイルのアップロードステータスを確認することができます。 確認を行うには、`files/v3/files/import-from-url/async/tasks/{taskId}/status`へ`GET`リクエストを使用します。 このリクエストを送信すると、次のいずれかの返信が送られます。 * `PENDING`：ファイルはアップロード待ちのキューにあります。インポート処理はまだ開始されていません。 * `PROCESSING`：ファイルはアップロード中です。 * `CANCELED`：アップロードはキャンセルされ、ファイルはアップロードされません。ファイルをHubSpotアカウントにインポートするには、ファイルを再度アップロードする必要があります。 * `COMPLETE`：ファイルがファイルツールに正常にアップロードされました。アップロードされたファイルがファイルツールに表示されます。 ## ファイルの詳細を表示する ファイルツールにアップロードされたファイルの詳細を確認するには、`GET`リクエストを`files/v3/files/{fileId}`に送信します。これにより、名前、高さと幅、エンコード、URLなどの詳細情報と共にファイルが返されます。 ファイルの詳細の例として、以下の方法を参照してください。 ファイルが非公開に設定されている場合、返されるURLは404エラーになります。表示可能なファイルのURLを取得するには、`GET`リクエストを`/files/v3/files/{fileId}/signed-url`に送信します。このリクエストを送信するときに、高さと幅などの特定のプロパティーが返されるように`property`パラメーターを含めることができます。 ## ファイルを削除する ファイルを削除するには、`DELETE`リクエストを`files/v3/files/{fileId}`に送信します。これにより、ファイルは削除済みになり、ファイルの内容にアクセスできなくなります。 ファイルを完全に削除するには、`DELETE`リクエストを`files/v3/files/{fileId}/gdpr-delete`に送信します。これにより、ファイルの内容とメタデータが7日以内に完全に削除されます。 GDPR削除が行われていない場合、ファイルの内容は、誰もアクセスできない非公開の状態でHubSpotのサーバーに残ります。ファイルの内容を完全に削除するには、GDPR削除機能を使用します。 ## フォルダーを作成する フォルダーを作成するには、`POST`リクエストを`files/v3/folders`に送信します。このリクエストには、以下のフィールドを含めることができます。 | フィールド | 必須 | 説明 | | ------------------ | --- | ------------------------------------------------------------------------------------------------------- | | `name` | はい | 作成するフォルダーの名前。 | | `parentFolderId` | いいえ | 既存のフォルダー内にフォルダーを作成するには、既存フォルダーのIDを指定したこのフィールドを含めます。`parentFolderId`と`parentFolderPath`同時に設定することはできません。 | | `parentFolderPath` | いいえ | 既存のフォルダー内にフォルダーを作成するには、既存フォルダーのパスを指定したこのフィールドを含めます。`parentFolderId`と`parentFolderPath`を同時に設定することはできません。 | ```json theme={null} //Example request body of POST request to /files/v3/folders { "name": "myNewFolder", "parentFolderId": 12345 } ``` ## V3における変更点 ファイルAPIの旧バージョンを使用している場合、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`も必要です。