Dateien

 

ÜberblickEndpunkte

Das Dateien-Tool von HubSpot ist ein System zur Verwaltung und Speicherung von Dateien in HubSpot. Dateien, die mit dem Dateien-Tool gehostet werden, können in Ihre HubSpot-Inhalte und externen Inhalte hochgeladen und dort verwendet werden. Außerdem können sie an Datensätze angehängt werden, die dieInteraktionen-API verwenden. Wenn Ihr Unternehmen beispielsweise seine Website mit dem HubSpot CMS erstellt, können Sie die Dateien-API verwenden, um Elemente hochzuladen und sie in HubSpot zu speichern und dann über das HubSpot CMS 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.

Änderungen in V3

Wenn Sie bislang die vorherige Version dieser API verwendet haben, müssen Sie bei v3 folgende Änderungen berücksichtigen:

  • Sie können keine ausgeblendeten Dateien erstellen. Alle über die API hochgeladenen Dateien sind im Dateien-Dashboard und in der Dateiauswahl sichtbar. Private Dateien und nicht-indexierbare Dateien können weiterhin erstellt werden. 
  • 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 im gesamten Account nach einer doppelten Datei 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.
    • Es bedarf auch einer duplicateValidationStrategy, die vorgibt, was passiert, wenn ein Duplikat gefunden wird.
  • Listing-Dateien geben nicht mehr ausgeblendete oder gelöschte Dateien 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 mehr mehrere Dateien in einer einzelnen 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.

Eine Datei hochladen

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

Beispiel

Beschreibung 

file

Ja


"file": {binary data}


Die Datei, die hochgeladen wird.

folderId


Nein


"folderId": 1234


Die ID des Ordners, in den die Datei hochgeladen wird. folderId und folderPath können nicht gleichzeitig festgelegt werden.
folderPath Nein

"folderPath": "/folder"

Der Pfad des Ordners, in den die Datei hochgeladen wird. folderId und folderPath können nicht gleichzeitig festgelegt werden.
fileName Nein "fileName": "myImage"

Der Name der Datei. Wird kein Name angegeben, wird ein Name aus dem Inhalt der Datei generiert.


charsetHunch		 Nein
"charsetHunch": "UTF-8"
Zeichensatzcodierung für die hochgeladene Datei. Falls nicht angegeben, wird sie aus der Datei abgeleitet.
options Ja
"options": "{
  "access":  "PRIVATE",
"ttl": "P2W",
"overwrite": false,
"duplicateValidationStrategy": "NONE",
"duplicateValidationScope": "EXACT_FOLDER"
}

JSON-Zeichenfolge, die die Optionen für den Datei-Upload darstellt. Das einzige Pflichtfeld ist das Zugriffsfeld, das den Datenschutz und die Indexierbarkeit der Datei steuert.



Eine Datei löschen

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. 

Details einer Datei anzeigen

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.

Einen Ordner erstellen

Um einen Ordner zu erstellen, nehmen Sie eine POST-Anfrage an files/v3/folders vor. Bei der Anfrage können Sie die folgenden Felder einbeziehen. 

 

Felder

Erforderlich

Beispiel

Beschreibung

name

Ja

"name": "myFolder"


Name des Ordners, den Sie erstellen möchten.

parentFolderId

Nein
"parentFolderId": 1234


Die ID des übergeordneten Ordners für den neuen Ordner, den Sie erstellen. parentFolderId und parentFolderPath können nicht gleichzeitig festgelegt werden.

parnetFolderPath

Nein
"parentFolderPath": "/folder/otherFolder"


Der Pfad des übergeordneten Ordners für den Ordner, den Sie erstellen. parentFolderId und parentFolderPath können nicht gleichzeitig festgelegt werden.

 

 

  

 

Beispielanfrage

JSON 
//example request
{
"name": "myNewFolder",
"parentFolderId": 12345
}
War dieser Artikel hilfreich? *
Dieses Formular dient dazu, Feedback zu unserer Entwicklerdokumentation zu sammeln. Wenn Sie uns Ihre Meinung zu HubSpot-Produkten mitteilen möchten, teilen Sie diese bitte im Ideenforum der Community.