API du CMS | HubDB

​

Limites de taux

• Les demandes GET effectuées qui ne nécessitent pas d’authentification (dont les requêtes JavaScript côté client) sont limitées à 10 demandes par seconde. Ces demandes ne seront pas comptabilisées dans la limite quotidienne.
• Toutes les autres demandes utilisant l’authentification suivent les limites standard.

​

Brouillons de tableaux comparés aux tableaux en ligne

​

Créer un tableau HubDB

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

​

Ajouter des colonnes de tableau

// 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
}

​

Ajouter des lignes de tableau

// 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"
}

​

Importer des lignes depuis CSV

• config** :** un ensemble d’options JSON pour l’import.
• file** :** le fichier CSV que vous souhaitez importer.

// 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"'

​

Formatage de la date

• 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

​

Réinitialiser les options

• Si resetTable est défini sur true :
  • Si les lignes du fichier CSV ne disposent pas d’une colonne ID de ligne (si hs_id ou l’ID de ligne est spécifié comme 0, ces lignes seront insérées avec les nouveaux ID de lignes générés.
  • Si les ID de ligne du fichier CSV existent déjà dans le tableau cible, les lignes existantes du tableau seront mises à jour avec les nouvelles valeurs du fichier d’entrée.
  • Si le tableau contient des lignes, mais que le fichier CSV d’entrée ne contient pas ces ID de ligne, ces lignes seront supprimées du tableau cible.
  • Si les ID de lignes du fichier CSV d’entrée n’existent pas dans le tableau cible, ces lignes seront insérées avec les nouveaux ID de lignes générés et les ID de lignes donnés dans le fichier d’entrée seront ignorés.
  • Si le fichier CSV d’entrée ne contient pas du tout la colonne ID de ligne, toutes les lignes seront supprimées du tableau cible et les lignes du fichier d’entrée seront insérées avec les nouveaux ID de lignes générés.
• Si resetTable est défini sur false (valeur par défaut) :
  • Si les ID de ligne du fichier CSV existent déjà dans le tableau cible, les lignes existantes du tableau seront mises à jour avec les nouvelles valeurs du fichier d’entrée.
  • Si le tableau contient des lignes, mais que le fichier CSV d’entrée ne contient pas ces ID de ligne, ces lignes ne seront pas supprimées du tableau cible et ces lignes resteront inchangées.
  • Si les ID de lignes du fichier CSV d’entrée n’existent pas dans le tableau cible, ces lignes seront insérées avec les nouveaux ID de lignes générés et les ID de lignes donnés dans le fichier d’entrée seront ignorés.
  • Si les lignes du fichier CSV ne contiennent pas de colonne ID de ligne ou si l’ID de ligne est défini comme 0, ces lignes seront insérées avec les nouveaux ID de lignes générés.

​

Récupérer les données HubDB

• Pour récupérer les détails de tous les tableaux publiés, effectuez une demande GET à /cms/v3/hubdb/tables.
• Pour récupérer les détails d’un tableau publié spécifique, effectuez une demande GET à /cms/v3/hubdb/tables{tableIdOrName}.
• Pour récupérer toutes les lignes d’un tableau spécifique, effectuez une demande GET à /cms/v3/hubdb/tables{tableIdOrName}/rows.
• Pour récupérer une ligne spécifique d’un tableau, effectuez une demande GET à /cms/v3/hubdb/tables{tableIdOrName}/rows/{rowId}.

​

Filtrer les lignes renvoyées

• Lorsque vous transmettez des valeurs pour des colonnes multiselect, les valeurs doivent être séparées par des virgules (par exemple : multiselect_column__contains=1,2).
• Pour les filtres datetime, vous pouvez utiliser des dates relatives à la place des horodatages afin de spécifier une valeur relative à l’heure actuelle. Par exemple, -3h correspondrait à l’horodatage de 3 heures avant le moment présent, alors que 10s correspondrait à 10 secondes dans le futur. Les unités de temps prises en charge sont ms (millisecondes), s (secondes), m (minutes), h (heures), j (jours). L’heure actuelle peut être utilisée en spécifiant une valeur zéro : 0 s
• Pour les besoins de ces filtres, la colonne intégrée hs_id est une colonne number, la colonne hs_created_at est une colonne datetime, et les colonnes hs_path et hs_name sont des colonnes text.

​

Trier les lignes renvoyées

• geo_distance(location_column_name, latitude, longitude) : prend le nom d’une colonne d’emplacement et des coordonnées, renvoie les lignes classées en fonction de la distance entre les valeurs de la colonne d’emplacement indiquée et les coordonnées fournies.
• longueur(column_name) : prend le nom d’une colonne, renvoie les lignes classées selon la longueur de la valeur de la colonne (calculée sous forme de chaîne)
• aléatoire() : renvoie les lignes dans un ordre aléatoire.

​

Configurer les tableaux HubDB pour les pages dynamiques

// 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
  }
}

​

Modifications dans la v3

• Les tableaux doivent avoir à la fois name et label. Ce nom ne peut pas être modifié une fois le tableau créé. Les noms peuvent uniquement contenir des minuscules, des chiffres et des tirets du bas et ne peuvent pas commencer par un chiffre. name et label doivent les deux être uniques dans le compte.
• L’API prend en charge à la fois les tableaux id et name dans les chemins URL.
• Les points de terminaison des lignes GET renvoient la colonne name au lieu de id dans le champ values. De plus, les points de terminaison de lignes POST / PUT / PATCH nécessitent une colonne name plutôt que id dans le champ values.
• Les points de terminaison de mise à jour des lignes PATCH acceptent désormais les mises à jour plus rares, ce qui signifie que vous pouvez spécifier uniquement les valeurs de colonne que vous devez mettre à jour (alors que vous deviez spécifier toutes les valeurs de colonne dans les versions précédentes). Lorsque vous mettez à jour une colonne avec une liste de valeurs telle que la sélection multiple, vous devez spécifier la liste de toutes les valeurs. Pour supprimer la valeur d’une colonne, vous devez spécifier la colonne avec la valeur comme null dans la demande.
• Les points de terminaison ont été remplacés par get / update / delete une cellule de ligne au profit des points de terminaison PATCH de mise à jour des lignes.
• Le point de terminaison d’import prend désormais en charge un champ idSourceColumn facultatif avec les champs existants dans les options au format JSON. Vous pouvez utiliser ce champ pour spécifier la colonne du fichier CSV qui contient les ID de ligne. Pour importer de nouvelles lignes avec les nouvelles valeurs pour les lignes existantes, vous pouvez simplement spécifier 0 comme ID de ligne pour les nouvelles lignes et ID de lignes valides pour les colonnes existantes. Pour plus de détails, consultez la section Import ci-dessous. Vous pouvez également utiliser des noms de colonnes ou des identifiants dans le champ cible des mappages de colonnes dans les options au format JSON.
• Cloner le point de terminaison nécessite un nouveau nom et un nouveau libellé.