API del CMS | HubDB

​

Límites de tasa

• Las solicitudes GET realizadas que no requieren autentificación (incluidas las solicitudes de JavaScript del lado del cliente) están limitadas a 10 solicitudes por segundo. Estas solicitudes no contarán para el límite diario.
• Todas las demás solicitudes que utilizan la autenticación siguen los límites estándar.

​

Tablas en borrador vs tablas en vivo

​

Crear una tabla de HubDB

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

​

Agregar columnas a la tabla

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

​

Agregar filas a la tabla

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

​

Importar filas desde CSV

• config: un conjunto de opciones con formato JSON para la importación.
• file: el archivo CSV que deseas importar.

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

​

Formato de fecha

• 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

​

Opciones de restablecimiento

• Si resetTable se establece en true:
  • Si las filas del archivo CSV no tienen una columna de ID de fila (hs_id o el ID de fila se especifica como 0, esas filas se insertarán con los nuevos ID de fila generados.
  • Si los ID de fila del archivo CSV ya existen en la tabla objetivo, las filas existentes en la tabla se actualizarán con los nuevos valores de los archivos de entrada.
  • Si la tabla tiene filas pero el archivo CSV de entrada no tiene esos ID de fila, esas filas se eliminarán de la tabla objetivo.
  • Si los ID de fila del archivo CSV de entrada no existen en la tabla objetivo, esas filas se insertarán con los nuevos ID de fila generados y se ignorarán los ID de fila indicados en el archivo de entrada.
  • Si el archivo CSV de entrada no contiene la columna ID de fila, todas las filas se eliminarán de la tabla objetivo y las filas del archivo de entrada se insertarán con los nuevos ID de fila generados.
• Si resetTable se establece en false (por opción predeterminada):
  • Si los ID de fila del archivo CSV ya existen en la tabla objetivo, las filas existentes en la tabla se actualizarán con los nuevos valores de los archivos de entrada.
  • Si la tabla tiene filas pero el archivo CSV de entrada no tiene esos ID de fila, esas filas no se eliminarán de la tabla objetivo y esas filas permanecerán sin cambios.
  • Si los ID de fila del archivo CSV de entrada no existen en la tabla objetivo, esas filas se insertarán con los nuevos ID de fila generados y se ignorarán los ID de fila indicados en el archivo de entrada.
  • Si las filas del archivo CSV no tienen una columna de ID de fila o el ID de fila se especifica como 0, esas filas se insertarán con los nuevos ID de fila generados.

​

Recuperar datos de HubDB

• Para recuperar los detalles de la tabla de todas las tablas publicadas, haz una solicitud GET a /cms/v3/hubdb/tables.
• Para recuperar los detalles de la tabla de una tabla publicada específica, realiza una solicitud GET a /cms/v3/hubdb/tables{tableIdOrName}.
• Para recuperar todas las filas de una tabla específica, haz una solicitud GET a /cms/v3/hubdb/tables{tableIdOrName}/rows.
• Para recuperar una fila específica de una tabla, haz una solicitud GET a /cms/v3/hubdb/tables{tableIdOrName}/rows/{rowId}.

​

Filtrar filas obtenidas

• Al pasar valores para las columnas multiselect, los valores deben estar separados por comas (por ejemplo, multiselect_column__contains=1,2).
• Para los filtros datetime, puedes utilizar fechas relativas en lugar de marcas de tiempo para especificar un valor relativo a la hora actual. Por ejemplo, -3h correspondería a la marca de tiempo 3 horas antes de ahora, mientras que 10s correspondería a 10 segundos en el futuro. Las unidades de tiempo admitidas son ms (milisegundos), s (segundos), m (minutos), h (horas), d (días). La hora actual se puede utilizar especificando un valor cero: 0s

​

Ordenar filas obtenidas

• geo_distance(location_column_name, latitud, longitud): toma el nombre de una columna de localización y las coordenadas, devuelve las filas ordenadas según la distancia entre el valor de la columna de localización especificada y las coordenadas proporcionadas.
• longitud(column_name): toma el nombre de una columna, devuelve las filas ordenadas por la longitud del valor de la columna (calculada como una cadena)
• random(): devuelve las filas en orden aleatorio.

​

Configurando tablas HubDB para páginas dinámicas

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

​

Cambios en la v3

• Las tablas deben tener tanto name como label. Este nombre no se puede cambiar una vez creada la tabla. Los nombres solo pueden incluir letras minúsculas, dígitos y guiones bajos y no pueden comenzar con un número. Ambos name y label deben ser únicos en la cuenta.
• La API admite tanto la tabla id como name las rutas URL.
• GET Los puntos de terminación de fila devuelven la columna name en lugar de id en el campovalues. Además, los puntos de terminación de fila POST / PUT / PATCH requieren una columna name en lugar de id en el campovalues.
• Los puntos de terminación de actualización de fila PATCH ahora aceptan actualizaciones dispersas, lo que significa que solo puedes especificar los valores de columna que necesita actualizar (mientras que tenías que especificar todos los valores de columna en las versiones anteriores). Al actualizar una columna con una lista de valores como multiselect, debes especificar la lista de todos los valores. Para eliminar el valor de una columna, debes especificar la columna con el valor como null en la solicitud.
• Se han eliminado los puntos de terminación get / update / delete a una celda de fila en favor de los puntos de terminación de actualización de filaPATCH.
• El punto de terminación de importación ahora admite un campo opcional idSourceColumn junto con los campos existentes en las opciones con formato JSON. Puedes utilizar este campo para especificar la columna del archivo csv que contiene los ID de fila. Para importar nuevas filas junto con los nuevos valores de las filas existentes, simplemente puedes especificar 0 como el id de fila para las nuevas filas y los id de fila válidos para las columnas existentes. Ver más detalles a continuación en la sección Importar. También puedes utilizar nombres o identificadores de columnas en el campo de destino de las asignaciones de columnas en las opciones con formato JSON.
• Clonar el punto de terminación requiere un nuevo nombre y una nueva etiqueta.