HubSpot

Con el conector de HubSpot puedes realizar operaciones de inserción, eliminación, actualización y lectura en el conjunto de datos de HubSpot.

Versiones compatibles

Este conector es compatible con las siguientes versiones de la API de HubSpot:

  • HubSpot
  • HubSpotV3
  • HubSpotV4

Antes de comenzar

Antes de usar el conector de HubSpot, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario. configurar el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Entre las regiones admitidas para los conectores, se incluyen las siguientes:

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haz clic en Siguiente.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Connector (Conector): Selecciona HubSpot en la lista desplegable de conectores disponibles.
    2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de conexión no pueden superar los 49 caracteres.
      • En el caso de los conectores que admiten la suscripción a eventos, los nombres de las conexiones no pueden comenzar con “goog” .
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    6. Para usar la conexión para suscripciones a eventos, selecciona Habilitar la suscripción a eventos. Si lo haces, se mostrarán las siguientes opciones:
      • Habilitar la suscripción a eventos con entidad y acciones: Selecciona esta opción para usar la conexión en las operaciones de suscripción a eventos y de conector (entidades y acciones).
      • Habilitar solo la suscripción a eventos: Selecciona esta opción para usar la conexión solo para la suscripción a eventos. Si seleccionas esta opción, haz clic en Siguiente y, luego, Configura la suscripción al evento.
    7. Esquema: Especifica la versión de la API de HubSpot que se usará. HubSpotV4 es la nueva API.
    8. BrowsableSchemas: esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC
    9. Propiedades de los contactos: Ingresa los nombres de los campos de Contacts separados por comas que quieres seleccionar de la operación de entidad List. Por ejemplo, fieldA, fieldB, fieldC
    10. Companies Properties: Ingresa los nombres de los campos separados por comas de la entidad Companies que deseas seleccionar de la operación de entidad List. Por ejemplo, fieldA, fieldB, fieldC
    11. Propiedades de los acuerdos: Ingresa los nombres de los campos separados por comas de Deals que quieres seleccionar de la operación de entidad List. Por ejemplo, fieldA, fieldB, fieldC
    12. Usar proxy: Selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión.
    13. Esquema de autenticación de proxy: Es el tipo de autenticación que se usa para autenticarse en el proxy de ProxyServer.
    14. Proxy User: Es un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
    15. Contraseña de proxy: Es una contraseña que se usa para autenticarse en el proxy de ProxyServer.
    16. Tipo de SSL de proxy: Es el tipo de SSL que se usa al conectarse al proxy de ProxyServer.
    17. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    18. De forma opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
    19. Haz clic en Siguiente.
  5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
    1. Tipo de destino: Puedes especificar los detalles del destino como una dirección de host o un adjunto de servicio. Selecciona cualquiera de los siguientes tipos de destino:
      • Dirección de host: Si deseas especificar el nombre de host o la dirección IP del destino.
      • Adjunto de servicio: Si deseas especificar el extremo privado para tus direcciones IP internas. El adjunto de servicio te permite ocultar tus direcciones IP internas de la red externa. Puedes crear un adjunto de servicio en Google Cloud con la función de Private Service Connect. Para obtener información sobre cómo configurar Private Service Connect, consulta Publica servicios administrados.

      Según la selección del tipo de destino, ingresa la dirección del host o el nombre del adjunto del servicio.

      Para ingresar destinos adicionales, haz clic en +Agregar destino.

    2. Haz clic en Siguiente.
  6. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de HubSpot admite los siguientes tipos de autenticación:

      • Token de acceso privado de la app: Selecciona el Secret de Secret Manager que contiene el token de acceso privado de la app.

        Las apps privadas te permiten usar las APIs de HubSpot para acceder a datos específicos de tu cuenta de HubSpot. Puedes autorizar lo que cada app privada puede solicitar o cambiar en tu cuenta, lo que generará un token de acceso único para tu app privada. En tu app privada, asegúrate de haber proporcionado el permiso de lectura, al menos, a los siguientes permisos de acceso:

        • crm.schemas.line_items.read
        • crm.schemas.quotes.read
        • crm.schemas.deals.read
        • crm.schemas.companies.read
        • crm.schemas.custom.read
        • crm.schemas.contacts.read

        Para obtener más información, consulta Apps privadas.

    2. Haz clic en Siguiente.
  7. Si habilitaste la suscripción a eventos, aparecerá la sección Detalles de la suscripción a eventos en la página de creación de la conexión. En el paso Detalles de suscripción al evento, proporciona los detalles de autenticación que se usarán para validar la carga útil del token de HubSpot:
    1. Secreto del cliente: (Opcional) Selecciona el secreto de Secret Manager del secreto de cliente de tu app privada y la versión del secreto correspondiente en el menú desplegable Versión del secreto.

      2. Para obtener más información, consulta Apps privadas.

    2. Selecciona Habilitar conectividad privada para obtener una conectividad segura entre tu aplicación de backend y tu conexión. Si seleccionas esta opción, debes realizar pasos de configuración adicionales después de crear la conexión. Si deseas obtener más información, consulta Conectividad privada para suscripción a eventos.
    3. Ingresa la configuración de mensajes no entregados. Si configuras mensajes no entregados, la conexión escribe los eventos sin procesar al tema de Pub/Sub especificado. Ingresa los siguientes detalles:
      1. ID del proyecto de mensajes no entregados: Es el ID del proyecto de Google Cloud en el que configuraste el tema de mensajes no entregados de Pub/Sub.
      2. Tema de mensajes no entregados: Es el tema de Pub/Sub en el que deseas escribir los detalles del evento no procesado.
    4. Haz clic en Siguiente.
  8. Revisa: Revisa tus detalles de conexión y autenticación.
  9. Haz clic en Crear.

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

  • Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

    Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

  • Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones operaciones no aparecen en la lista Operations.

  • Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Por lo general, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Problemas conocidos

  • La operación de actualización en algunas de las entidades muestra una respuesta vacía, a pesar de que la actualización se realiza correctamente. En esos casos, te recomendamos que verifiques la actualización en tu instancia de HubSpot.
  • En HubSpot, es posible que tengas muchos campos personalizados para las siguientes entidades:
    • Contactos
    • Empresas
    • Ofertas

    Para estas entidades, selecciona todos los campos a la vez en la operación de entidad List. puede hacer que el conector de HubSpot muestre un error. En los casos en los que desees limitar la cantidad de campos personalizados de la operación List, especifica los nombres de los campos obligatorios (como valores separados por comas) en la configuración del conector de HubSpot. Por ejemplo, para limitar los campos de la entidad Contacts, haz lo siguiente: especificar los nombres de los campos obligatorios en los registros Contacts Properties. De manera similar, para la entidad Companies, especifica los nombres de campo obligatorios en el campo Companies Properties y, para la entidad Deals, especifica los nombres de campo obligatorios en el campo Deals Properties.

    Puedes especificar los campos durante el paso de creación de la conexión. Sin embargo, si ya tienes una conexión existente, debes editarla y, luego, especificar los campos obligatorios.

  • Si tienes un conjunto de resultados muy grande, List podría fallar debido al tiempo de espera de la conexión. En ese caso, puedes explorar la opción de limitar tu conjunto de resultados especificando la cláusula de filtro para la operación de lista.

Ejemplos de operaciones de entidades

En esta sección, se muestra cómo realizar algunas de las operaciones de la entidad en este conector.

Ejemplo: enumera todos los contactos

En este ejemplo, se enumeran todos los registros de la entidad Contacts.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Contacts de la lista Entity.
  3. Selecciona la operación LIST y haz clic en Listo.

Ejemplo: Cómo obtener un registro de oferta

En este ejemplo, se obtiene un registro cuyo ID es 45 de la entidad Deals.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Deals de la lista Entity.
  3. Selecciona la operación GET y, luego, haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en EntityId. Luego, ingresa 45 en el campo Valor predeterminado.

    Aquí, 45 es un valor de clave primaria en la entidad Deals.

Ejemplo: crea un ticket

En este ejemplo, se crea un ticket en la entidad Ticket.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Tickets de la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value: 
    {
"Name": "Test735362767",
"Label": "Test735362767",
"Type": "String",
"FieldType": "Insert ticket1",
"GroupName": "ticketinformation",
"Description": "Test ticket"
}

    Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    {
"Name": "Test1695971640609"
}

Ejemplo: Actualiza una entrada de acuerdos

En este ejemplo, se actualiza el registro cuyo ID es 97 en la entidad Contacts.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Deals en la lista Entity.
  3. Selecciona la operación Update y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
"Description": "New description"
}
  5. Haz clic en entityId y, luego, ingresa 97 en el campo Default Value.

    Como alternativa, en lugar de especificar el entityId, también puedes establecer el filterClause como 97.

Ejemplo: Borra un formulario

En este ejemplo, se borra el registro cuyo ID es 78 en la entidad Forms.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Forms en la lista Entity.
  3. Selecciona la operación Delete y haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en entityId y Luego, ingresa 78 en el campo Valor predeterminado.

Usar Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de Terraform de muestra para crear conexiones, consulta la plantilla de muestra.

Cuando crees esta conexión con Terraform, debes establecer las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Obligatorio Descripción
schema ENUM Verdadero Especifica la versión de la API de HubSpot que se usará. HubSpotV4 es la nueva API. Los valores admitidos son: HubSpot, HubSpotV3 y HubSpotV4.
browsable_schemas STRING Falso Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC
contacts_columns STRING Falso Es una lista de propiedades separadas por comas que se deben seleccionar de HubSpot para la entidad Contactos.
companies_columns STRING Falso Es una lista separada por comas de las propiedades que se deben seleccionar de HubSpot para la entidad Empresas.
deals_columns STRING Falso Lista de propiedades separadas por comas que se deben seleccionar de HubSpot para la entidad de acuerdos.
proxy_enabled BOOLEAN Falso Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso El tipo de autenticación que se utiliza para autenticarse en el proxy ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE
proxy_user STRING Falso Un nombre de usuario que se usará para autenticarse en el proxy ProxyServer.
proxy_password SECRET Falso Una contraseña que se usará para autenticarse en el proxy ProxyServer.
proxy_ssltype ENUM Falso Es el tipo de SSL que se usará para conectarse al proxy de ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.

Usa la conexión de HubSpot en una integración

Después de crear la conexión, estará disponible en la integración de Apigee y en la integración de aplicaciones. Puedes usar la conexión en una integración a través de la tarea Connectors.

  • Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la Tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?