Die Dateien-Endpunkte werden verwendet, um Daten in Ihrem Datei-Manager abzurufen und zu verwalten.
POST
-Anfrage an files/v3/files
mit den folgenden Feldern hochgeladen werden. Beim Upload ist zwar keine bestimmte Ordner-ID erforderlich, es wird jedoch empfohlen, Dateien in einen Ordner hochzuladen und nicht in das Stammverzeichnis. Die Ordneranforderungen beim Upload können sich in Zukunft ändern.
Feld | Beschreibung |
---|---|
file | Die Datei, die hochgeladen wird (erforderlich). |
options | Ein JSON-Objekt, das den Datenschutz und die Indexierbarkeit der Datei steuert und zwei Felder enthält: access , das erforderlich ist, und ttl , das einen Zeitraum angibt, nach dem die Datei automatisch gelöscht wird. Wenn Sie das ttl -Feld verwenden:
|
folderId | Die ID des Ordners, in den die Datei hochgeladen wird. Entweder dieses Feld oder folderPath muss in Ihrer Anfrage angegeben werden (aber nicht beides). |
folderPath | Der Pfad des Ordners, in den die Datei hochgeladen wird. Entweder dieses Feld oder folderId muss in Ihrer Anfrage angegeben werden (aber nicht beides). |
fileName | Der Name der Datei. Wird kein Name angegeben, wird ein Name aus dem Inhalt der Datei generiert. |
charsetHunch | Zeichensatzcodierung für die hochgeladene Datei. Falls nicht angegeben, wird sie aus der Datei abgeleitet. |
cat.png
/library/cat_archive
id
und parentFolderId
der hochgeladenen Datei, mit der Sie die Datei über eine GET-Anfrage abrufen können.
POST
-Anfrage an files/v3/files/import-from-url/async
von einer URL in Ihren Datei-Manager importieren, können Sie den Upload-Status der Datei überprüfen.
Führen Sie dazu eine GET
-Anfrage an files/v3/files/import-from-url/async/tasks/{taskId}/status
durch.
Nachdem Sie diese Anfrage durchgeführt haben, erhalten Sie eine der folgenden Antworten:
PENDING
: die Datei befindet sich in der Warteschlange, die hochgeladen werden soll. Der Importvorgang hat noch nicht begonnen.PROCESSING
: die Datei wird gerade hochgeladen.CANCELED
: der Upload wurde abgebrochen und die Datei wird nicht hochgeladen. Um die Datei in Ihren HubSpot-Account zu importieren, müssen Sie die Datei erneut hochladen.COMPLETE
: die Datei wurde erfolgreich in das Dateien-Tool hochgeladen. Die hochgeladene Datei wird in Ihrem Dateien-Tool angezeigt.GET
-Anfrage an files/v3/files/{fileId}
durch. Dadurch wird die Datei mit Details wie Name, Höhe und Breite, Codierung, URL und mehr zurückgegeben.
So rufen Sie beispielsweise die Details einer Datei ab:
Wenn eine Datei auf „privat“ festgelegt ist, führt die zurückgegebene URL zu einem 404-Fehler. Um eine aufrufbare URL der Datei zu erhalten, können Sie eine GET
-Anfrage an /files/v3/files/{fileId}/signed-url
vornehmen. Wenn Sie diese Anfrage durchführen, können Sie property
-Parameter einschließen, damit spezifische Eigenschaften wie Höhe und Breite zurückgegeben werden.
DELETE
-Anfrage an files/v3/files/{fileId}
durch. Dadurch wird die Datei als gelöscht markiert und der Inhalt der Datei kann nicht mehr aufgerufen werden.
Um eine Datei vollständig zu löschen, führen Sie eine DELETE
-Anfrage an files/v3/files/{fileId}/gdpr-delete
vor. Dadurch werden der Inhalt und die Metadaten der Datei innerhalb von 7 Tagen vollständig gelöscht.
Wenn eine Datei nicht DSGVO-konform gelöscht wird, bleiben ihre Inhalte auf den HubSpot-Servern in einem privaten Zustand gespeichert, bei dem kein Benutzer darauf zugreifen kann. Um sicherzustellen, dass Dateiinhalte vollständig gelöscht werden, verwenden Sie die Funktionalität für eine DSGVO-konforme Löschung.
POST
-Anfrage an files/v3/folders
durch. Bei der Anfrage können Sie die folgenden Felder einbeziehen.
Feld | Erforderlich | Beschreibung |
---|---|---|
name | Ja | Name des Ordners, den Sie erstellen möchten. |
parentFolderId | Nein | Um den Ordner innerhalb eines vorhandenen Ordners zu erstellen, berücksichtigen Sie dieses Feld in der ID des vorhandenen Ordners. parentFolderId und parentFolderPath können nicht gleichzeitig festgelegt werden. |
parentFolderPath | Nein | Um den Ordner innerhalb eines vorhandenen Ordners zu erstellen, berücksichtigen Sie dieses Feld im Pfad des vorhandenen Ordners ein. parentFolderId und parentFolderPath können nicht gleichzeitig festgelegt werden. |
files_ui_hidden.read.
.
PUBLIC_INDEXABLE
: Die Datei ist für alle, die die URL kennen, öffentlich zugänglich. Suchmaschinen können die Datei indexieren.PUBLIC_NOT_INDEXABLE
: Die Datei ist für alle, die die URL kennen, öffentlich zugänglich. Das X-Robots-Tag: Der noindex-Header wird bei jedem Abrufen der Datei gesendet. Dabei werden Suchmaschinen angewiesen, die Datei nicht zu indexieren.PRIVATE
: Die Datei ist nicht öffentlich zugänglich. Eine signierte URL ist erforderlich, um Inhalte anzuzeigen. Suchmaschinen können die Datei nicht indexieren.ENTIRE_PORTAL
: Es wird nach einer doppelten Datei im Account gesucht.EXACT_FOLDER
: Es wird im angegebenen Ordner nach einer doppelten Datei gesucht.NONE
: Es wird keine Überprüfung auf Duplikate ausgeführt.REJECT
: Der Upload wird abgelehnt, wenn ein Duplikat gefunden wird.RETURN_EXISTING
: Wenn eine doppelte Datei gefunden wird, darf keine neue Datei hochgeladen werden. Stattdessen wird das gefundene Duplikat zurückgegeben.duplicateValidationScope
, was sich auf die Art und Weise auswirkt, wie wir nach einem Duplikat suchen.duplicateValidationStrategy
, die vorgibt, was passiert, wenn ein Duplikat gefunden wird.