Dateien
In der Beta-Version können Sie auf APIs zugreifen und diese testen.
Diese API befindet sich derzeit in der Beta-Phase. Mehr zur neuesten stabilen Version finden Sie auf diesen Seiten: Eine neue Datei hochladen, Metadaten für alle Dateien auflisten, Eine ersetzende Datei hochladen, Eine Datei als gelöscht markieren, Datei-Metadaten abrufen, Eine Datei archivieren, Einen Hard Delete für eine Datei und zugehörige Elemente durchführen, Den Zugriff auf eine Gruppe von Dateien aktualisieren, Den Status einer Aktualisierungsaufgabe für den Dateizugriff überprüfen, Eine signierte URL für eine private Datei abrufen, Eine Datei verschieben, Einen Ordner erstellen, Ordner-Metadaten auflisten, Einen Ordner löschen, Ordner nach ID abrufen,
Verwenden Sie das Dateien-Tool von HubSpot, um Dateien in HubSpot zu verwalten und zu speichern. In HubSpot gehostete Dateien können hochgeladen und in HubSpot und externen Inhalten verwendet werden. Sie können auch über die Interaktionen-API an Datensätze angehängt werden.
Wenn Ihr Unternehmen seine Website mit CMS Hub erstellt, können Sie die Dateien-API verwenden, um Elemente hochzuladen und sie in HubSpot zu speichern und dann über CMS Hub bereitzustellen.
Sie können das Dateien-Tool in HubSpot oder mithilfe der Dateien-API aufrufen. Im Folgenden erfahren Sie mehr über die Dateien-API und wie Sie Dateien hochladen und löschen. Klicken Sie auf die Registerkarte „Endpunkte“ oben, um eine vollständige Liste der Dateien-Endpunkte anzuzeigen.
Wenn Sie bislang die vorherige Version dieser API verwendet haben, müssen Sie bei v3 folgende Änderungen berücksichtigen:
- Alle über die API hochgeladenen Dateien sind im Dateien-Dashboard und in der Dateiauswahl sichtbar. Ausgeblendete Dateien können nicht erstellt werden. Private Dateien und nicht-indexierbare Dateien können jedoch weiterhin erstellt werden.
- Listing-Dateien geben ausgeblendete oder gelöschte Dateien nicht zurück. Es kann jedoch eine wesentlich breitere Spanne von Filtern angewendet werden. Ausgeblendete Dateien können weiterhin nach ID abgerufen werden, erfordern jedoch einen neuen Bereich:
files_ui_hidden.read
. - Es können nicht mehrere Dateien mit einer einzigen Anfrage hochgeladen werden.
- Ordneraktualisierungsaktionen wie das Verschieben und Umbenennen sind jetzt asynchron. Jede Anfrage gibt ein Token zurück, das verwendet werden kann, um den Status des Ordners zu überprüfen.
- Für Endpunkte, die Dateien erstellen oder ersetzen, müssen Sie Zugriffsebenen für die Dateien angeben. Diese Zugriffsebenen sind:
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.
- Endpunkte, die Dateien erstellen, ermöglichen ein gewisses Maß an Erkennung von Duplikaten als Teil der Upload-Optionen der Datei.
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.- Die Erkennung von Duplikaten erfolgt in einem
duplicateValidationScope
, was sich auf die Art und Weise auswirkt, wie wir nach einem Duplikat suchen. - Dies erfordert auch eine
duplicateValidationStrategy
, die vorgibt, was passiert, wenn ein Duplikat gefunden wird.
Dateien können mithilfe einer multipart/form-data-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 | Erforderlich | Description | Example |
---|---|---|---|
file
| Yes | Die Datei, die hochgeladen wird. |
"file": {binary data}
|
options
| Yes | Die Datei-Upload-Optionen. Das einzige Pflichtfeld ist das Wenn Sie das
|
"options": "{
"access": "PRIVATE",
"ttl": "P2W",
"overwrite": false,
"duplicateValidationStrategy": "NONE",
"duplicateValidationScope":
"EXACT_FOLDER"
}"
|
folderId
| No | Die ID des Ordners, in den die Datei hochgeladen wird. |
"folderId": 1234
|
folderPath
| No | Der Pfad des Ordners, in den die Datei hochgeladen wird. |
"folderPath": "/folder"
|
fileName
| No | Der Name der Datei. Wird kein Name angegeben, wird ein Name aus dem Inhalt der Datei generiert. |
"fileName": "myImage"
|
charsetHunch
| No | Zeichensatzcodierung für die hochgeladene Datei. Falls nicht angegeben, wird sie aus der Datei abgeleitet. |
"charsetHunch": "UTF-8"
|
Um eine Datei zu löschen, nehmen Sie eine DELETE
-Anfrage an files/v3/files/{fileId}
vor. Dadurch wird die Datei als gelöscht markiert und der Inhalt der Datei kann nicht mehr aufgerufen werden.
Um eine Datei dauerhaft zu löschen, nehmen 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 dauerhaft 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.
Um die Details einer Datei anzuzeigen, die in das Dateien-Tool hochgeladen wurde, nehmen Sie eine GET
-Anfrage an files/v3/files/{fileId}
vor. Dadurch wird die Datei mit Details wie Name, Höhe und Breite, Codierung, URL und mehr zurückgegeben.
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.
Feld | Erforderlich | Description | Example |
---|---|---|---|
name
| Yes | Name des Ordners, den Sie erstellen möchten. |
"name": "myFolder"
|
parentFolderId
| No | Um den Ordner innerhalb eines vorhandenen Ordners zu erstellen, berücksichtigen Sie dieses Feld in der ID des vorhandenen Ordners. |
"parentFolderId": 1234
|
parentFolderPath
| No | Um den Ordner innerhalb eines vorhandenen Ordners zu erstellen, berücksichtigen Sie dieses Feld im Pfad des vorhandenen Ordners ein. |
"folderId": 1234
|
Beispielanfrage
//example request
{
"name": "myNewFolder",
"parentFolderId": 12345
}
Vielen Dank, dass Sie Ihr Feedback mit uns geteilt haben.