ファイルのAPIエンドポイントは、ファイルマネージャー上のデータの取得および管理に使用されます。
POST
リクエストをfiles/v3/files
に送信します。アップロード時に特定のフォルダーIDは必須ではありませんが、ファイルのアップロード先はルートディレクトリーではなくフォルダーにすることをお勧めします。アップロード時のフォルダーの必要性に関しては、今後変更される可能性がありますのでご留意ください。
フィールド | 説明 |
---|---|
file | アップロードするファイル(必須)。 |
options | ファイルの公開設定とインデックス登録を制御するJSONオブジェクトで、次の2つのフィールドが含まれています。1つは必須のaccess で、もう1つはファイルが自動的に削除されるまでの期間を指定するttl です。ttl フィールドを使用する場合の条件は、次の通りです。
|
folderId | ファイルのアップロード先とするフォルダーのID。リクエストには、このフィールドまたはfolderPath のいずれかを指定する必要があります(両方を指定することはできません)。 |
folderPath | ファイルのアップロード先とするフォルダーのパス。リクエストには、このフィールド またはfolderId のいずれかを指定する必要があります(両方を指定することはできません)。 |
fileName | ファイルの名前。名前が指定されていない場合は、ファイルの内容に基づく名前が生成されます。 |
charsetHunch | アップロードするファイルのエンコーディングに使用されている文字セット。指定されていない場合、ファイルから取得されます。 |
cat.png
/library/cat_archive
id
とparentFolderId
が含まれます。これを使用して、GETリクエスト経由でファイルを取得できます。
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 を同時に設定することはできません。 |
files_ui_hidden.read.
が必要になります。
PUBLIC_INDEXABLE
: ファイルが一般に公開され、URLを知っている全員がアクセスできます。このファイルは、検索エンジンによるインデックス登録が可能です。PUBLIC_NOT_INDEXABLE
: ファイルが一般に公開され、URLを知っている全員がアクセスできます。ファイルの取得時には常に「X-Robots-Tag: noindex」ヘッダーが送信され、検索エンジンに対し、ファイルをインデックス登録しないよう通知されます。PRIVATE
: ファイルは一般に公開されません。コンテンツを表示するには署名付きURLが必要です。検索エンジンはこのファイルのインデックス登録を行うことができません。ENTIRE_PORTAL
: アカウント内で重複するファイルを検索します。EXACT_FOLDER
: 指定されたフォルダー内で重複するファイルを検索します。NONE
: 重複の検証を実行しません。REJECT
: 重複が見つかった場合はアップロードを拒否します。RETURN_EXISTING
: 重複したファイルが見つかった場合は、新しいファイルをアップロードせずに、見つかった重複ファイルを返します。duplicateValidationScope
を基に機能するため、重複の検索にも影響します。duplicateValidationStrategy
も必要です。