CMS-API | HubDB

​

Ratenbeschränkungen

• Alle durchgeführten GET-Anfragen, die keine Authentifizierung erfordern (einschließlich clientseitiger JavaScript-Anfragen), sind auf 10 Anfragen pro Sekunde beschränkt. Diese Anfragen werden nicht auf das tägliche Limit angerechnet.
• Für alle anderen Anfragen, die Authentifizierung verwenden, gelten die Standardbeschränkungen.

​

Entwurfs- vs. Live-Tabellen

​

Eine HubDB-Tabelle erstellen

// Example request
{
  "name": "test_table",
  "label": "Test Table",
  "useForPages": false,
  "allowPublicApiAccess": false,
  "allowChildTables": true,
  "enableChildTablePages": false,
  "columns": []
}

​

Tabellenzeilen hinzufügen

// Example request
{
  "label": "Test Table",
  "name": "test_table",
  "columns": [
    {
      "name": "text_column",
      "label": "Text Column",
      "archived": false,
      "type": "TEXT"
    },
    {
      "name": "number_column",
      "label": "Number Column",
      "archived": false,
      "type": "NUMBER"
    },
    {
      "name": "multiselect",
      "label": "Multi Select Column",
      "archived": false,
      "type": "multiselect",
      "options": [
        {
          "name": "Option 1",
          "type": "option"
        },
        {
          "name": "Option 2",
          "type": "option"
        }
      ]
    }
  ],
  "useForPages": true,
  "allowChildTables": true,
  "enableChildTablePages": false,
  "allowPublicApiAccess": false
}

​

Tabellenzeilen hinzufügen

// Example request
{
  "values": {
    "text_column": "sample text value",
    "number_column": 76,
    "rich_text_column": "<strong>This is a styled paragraph.</strong>",
    "date_column": 1591228800000,
    "date_time_column": 1604450520000,
    "boolean_column": 1,
    "select_column": {
      "name": "option 1",
      "type": "option"
    },
    "multiselect_column": [
      {
        "name": "Option 1",
        "type": "option"
      },
      {
        "name": "Option 2",
        "type": "option"
      }
    ],
    "url_column": "https://www.hubspot.com/marketing",
    "video_column": 3392210008,
    "image_column": {
      "url": "https://f.hubspotusercontentqa00.net/hubfs/99992002/image3%20(1).jpg",
      "width": 1600,
      "height": 900,
      "type": "image"
    },
    "foreign_id_column": [
      {
        "id": "4364402239",
        "type": "foreignid"
      },
      {
        "id": "4364402240",
        "type": "foreignid"
      }
    ]
  },
  "path": "test_path",
  "name": "test_title",
  "childTableId": "1902373"
}

​

Zeilen aus CSV importieren

• config: eine Reihe von JSON-formatierten Optionen für den Import.
• file: die CSV-Datei, die Sie importieren möchten.

// Example config JSON
{
  "skipRows": 1,
  "separator": ",",
  "idSourceColumn": 1,
  "resetTable": false,
  "columnMappings": [
    {
      "target": 1,
      "source": 2
    },
    {
      "target": 2,
      "source": "zip_code"
    }
  ],
  "primaryKeyColumn": "name",
  "encoding": "utf-8",
  "format": "csv"
}

curl -L -X POST 'https://api.hubspotqa.com/hubdb/api/v2/tables/xxxxxx/import?portalId=xxxxxxx' \
-H 'Content-Type: multipart/form-data' \
-F 'config="{\"skipRows\":1,\"format\":\"csv\",\"separator\":\",\",\"encoding\":\"iso-8859-1\",\"columnMappings\":[{\"target\":1,\"source\":7},{\"target\":3,\"source\":8}],\"idSourceColumn\":1,\"pathSourceColumn\":null,\"nameSourceColumn\":null,\"childTableSourceColumn\":null,\"resetTable\":true}"' \
-F 'file=@"/Users/xxxxxxxxxxxxx/Downloads/filename.csv"'

​

Datumsformatierung

• yyyy/mm/dd
• yyyy/mm/dd
• mm/dd/yyyy
• mm/dd/yy

• The 1st of March in the year 2022
• Fri Mar 4 2022
• March 4th '22

• next Thursday
• Today
• tomorrow
• 3 days from now

​

Optionen zum Zurücksetzen

• Wenn resetTable auf true festgelegt ist:
  • Wenn die Zeilen in der CSV-Datei keine Zeilen-ID-Spalte (hs_id) haben oder die Zeilen-ID als 0 angegeben ist, werden diese Zeilen mit den neu generierten Zeilen-IDs eingefügt.
  • Wenn die Zeilen-IDs in der CSV-Datei bereits in der Zieltabelle vorhanden sind, werden die vorhandenen Zeilen in der Tabelle mit den neuen Werten aus der Eingabedatei aktualisiert.
  • Wenn die Tabelle Zeilen enthält, die Eingabe-CSV-Datei jedoch nicht über diese Zeilen-IDs verfügt, werden diese Zeilen aus der Zieltabelle gelöscht.
  • Wenn die Zeilen-IDs in der Eingabe-CSV-Datei nicht in der Zieltabelle vorhanden sind, werden diese Zeilen mit den neu generierten Zeilen-IDs eingefügt, und die in der Eingabedatei angegebenen Zeilen-IDs werden ignoriert.
  • Wenn die Eingabe-CSV-Datei die Zeilen-ID-Spalte überhaupt nicht enthält, werden alle Zeilen aus der Zieltabelle gelöscht, und die Zeilen aus der Eingabedatei werden mit den neu generierten Zeilen-IDs eingefügt.
• Wenn resetTable auf false festgelegt ist (Standard):
  • Wenn die Zeilen-IDs in der CSV-Datei bereits in der Zieltabelle vorhanden sind, werden die vorhandenen Zeilen in der Tabelle mit den neuen Werten aus der Eingabedatei aktualisiert.
  • Wenn die Tabelle Zeilen enthält, die Eingabe-CSV-Datei jedoch nicht über diese Zeilen-IDs verfügt, werden diese Zeilen nicht aus der Zieltabelle gelöscht, und diese Zeilen bleiben unverändert.
  • Wenn die Zeilen-IDs in der Eingabe-CSV-Datei nicht in der Zieltabelle vorhanden sind, werden diese Zeilen mit den neu generierten Zeilen-IDs eingefügt, und die in der Eingabedatei angegebenen Zeilen-IDs werden ignoriert.
  • Wenn die Zeilen in der CSV-Datei keine Spalte mit Zeilen-ID aufweisen oder die Zeilen-ID als 0 angegeben ist, werden diese Zeilen mit den neu generierten Zeilen-IDs eingefügt.

​

HubDB-Daten abrufen

• Um Tabellendetails von allen veröffentlichten Tabellen abzurufen, führen Sie eine GET-Anfrage an /cms/v3/hubdb/tables durch.
• Um Tabellendetails aus einer bestimmten veröffentlichten Tabelle abzurufen, führen Sie eine GET-Anfrage an /cms/v3/hubdb/tables{tableIdOrName} durch.
• Um alle Zeilen aus einer bestimmten Tabelle abzurufen, führen Sie eine GET-Anfrage an /cms/v3/hubdb/tables{tableIdOrName}/rows durch.
• Um eine bestimmte Zeile aus einer Tabelle abzurufen, führen Sie eine GET-Anfrage an /cms/v3/hubdb/tables{tableIdOrName}/rows/{rowId} durch.

​

Zurückgegebene Zeilen filtern

• Bei der Übergabe von Werten für multiselect-Spalten sollten die Werte durch Komma getrennt werden (z. B. multiselect_column__contains=1,2).
• Bei datetime-Filtern können Sie relative Datumsangaben anstelle von Zeitstempeln verwenden, um einen Wert relativ zur aktuellen Zeit anzugeben. Beispielsweise entspricht -3h dem Zeitstempel 3 Stunden vor jetzt, während 10s 10 Sekunden in der Zukunft entspricht. Unterstützte Zeiteinheiten sind ms (Millisekunden), s (Sekunden), m (Minuten), h (Stunden), d (Tage). Die aktuelle Uhrzeit kann durch Angabe eines Nullwerts verwendet werden: 0s
• Für die Zwecke dieser Filter ist die integrierte Spalte hs_id eine number-Spalte, die hs_created_at-Spalte eine datetime und die Spalten hs_path und hs_name sind text-Spalten.

​

Zurückgegebene Zeilen sortieren

• geo_distance(location_column_name, latitude, longitude): nimmt den Namen einer Standortspalte und Koordinaten an und gibt die Zeilen danach geordnet zurück, wie weit der Wert der angegebenen Standortspalte von den angegebenen Koordinaten entfernt ist.
• **length(column_name):**nimmt den Namen einer Spalte an und gibt die Zeilen geordnet nach der Länge des Spaltenwerts (berechnet als Zeichenfolge) zurück
• random(): gibt die Zeilen in zufälliger Reihenfolge zurück.

​

Konfigurieren von HubDB-Tabellen für dynamische Seiten

// Example POST request to create table
{
  "name": "dynamic_page_table",
  "label": "Dynamic page table",
  "useForPages": true,
  "columns": [
    {
      "name": "meta_description",
      "label": "Meta description",
      "archived": false,
      "type": "TEXT"
    },
    {
      "name": "featured_image",
      "label": "Featured image",
      "archived": false,
      "type": "IMAGE"
    },
    {
      "name": "canonical_url",
      "label": "Canonical URL",
      "archived": false,
      "type": "URL"
    }
  ],
  "dynamicMetaTags": {
    "DESCRIPTION": 1,
    "FEATURED_IMAGE_URL": 2,
    "LINK_REL_CANONICAL_URL": 3
  }
}

​

Änderungen in v3

• Tabellen sollten sowohl name als auch label enthalten. Dieser Name kann nicht mehr geändert werden, nachdem die Tabelle erstellt wurde. Namen dürfen nur Kleinbuchstaben, Ziffern und Unterstriche enthalten und dürfen nicht mit einer Zahl beginnen. Sowohl name als auch label sollten im Account eindeutig sein.
• API unterstützt sowohl die id als auch name von Tabellen in URL-Pfaden.
• GET-Zeilenendpunkte geben den name der Spalte statt die id im values-Feld zurück. Außerdem erfordern POST/PUT/PATCH-Zeilenendpunkte den name einer Spalte statt die id im values-Feld.
• PATCH-Endpunkte für Zeilenaktualisierungen akzeptieren jetzt lückenhafte Aktualisierungen, d. h., Sie können nur die Spaltenwerte angeben, die Sie aktualisieren müssen (während Sie in früheren Versionen alle Spaltenwerte angeben mussten). Wenn Sie eine Spalte mit einer Liste von Werten aktualisieren, z. B. Mehrfachauswahl, müssen Sie die Liste aller Werte angeben. Um den Wert für eine Spalte zu löschen, müssen Sie die Spalte mit dem Wert wie null in der Anfrage angeben.
• Es wurden die Endpunkte zum get/update/delete eine Zeilenzelle zugunsten der PATCH-Endpunkte für Zeilenaktualisierungen entfernt.
• Der Import-Endpunkt unterstützt jetzt das optionales Feld idSourceColumn zusammen mit vorhandenen Feldern in den JSON-formatierten Optionen. Sie können dieses Feld verwenden, um die Spalte in der CSV-Datei anzugeben, die Zeilen-IDs enthält. Um neue Zeilen zusammen mit den neuen Werten für vorhandene Zeilen zu importieren, können Sie einfach 0 als Zeilen-ID für die neuen Zeilen und die gültigen Zeilen-IDs für die vorhandenen Spalten angeben. Weitere Informationen finden Sie im Abschnitt zum Importieren. Außerdem können Sie Spaltennamen oder -IDs im Zielfeld der Spaltenzuordnungen in den JSON-formatierten Optionen verwenden.
• Der Klonen-Endpunkt erfordert einen neuen Namen und ein neues Label.