HubSpot

Le connecteur HubSpot vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur un ensemble de données HubSports.

Versions compatibles

Ce connecteur est compatible avec les versions suivantes de l'API HubSpot:

• HubSpot
• HubSpotV3
• HubSpotV4

Avant de commencer

Avant d'utiliser le connecteur HubSpot, effectuez les tâches suivantes :

• Dans votre projet Google Cloud :
  • Accordez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
  • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.

  • Activez les services suivants :
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Pour savoir comment activer des services, consultez la page Activer des services.

  Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

   Accéder à la page "Connexions"

2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
   1. Région : sélectionnez un emplacement dans la liste déroulante.

      Les régions disponibles pour les connecteurs sont les suivantes :

      Pour obtenir la liste de toutes les régions disponibles, consultez la section Emplacements.

   2. Cliquez sur Suivant.
4. Dans la section Détails de la connexion, procédez comme suit :
   1. Connecteur: sélectionnez HubSpot dans la liste déroulante des connecteurs disponibles.
   2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
   3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne peuvent pas dépasser 63 caractères.
   4. Saisissez éventuellement une Description pour l'instance de connexion.
   5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
   6. Pour utiliser la connexion pour souscrire des abonnements à des événements, sélectionnez Activer l'abonnement aux événements. La sélection de cette option affiche les options suivantes :
      • Activer l'abonnement aux événements avec une entité et des actions: sélectionnez cette option pour utiliser la connexion à la fois pour les opérations d'abonnement aux événements et de connecteur (entités et actions).
      • Activer uniquement l'abonnement aux événements: sélectionnez cette option pour n'utiliser la connexion que pour l'abonnement aux événements.

      Pour ces deux sélections, vous êtes invité à configurer les détails de l'événement lors des étapes suivantes.

   7. Schéma : spécifiez la version de l'API HubSpot à utiliser. HubSpotV4 est la nouvelle API.
   8. BrowsableSchemas : cette propriété restreint les schémas signalés à un sous-ensemble des schémas disponibles. Par exemple, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
   9. Contacts Properties (Propriétés des contacts) : saisissez les noms des champs séparés par une virgule de l'entité Contacts que vous souhaitez sélectionner dans l'opération List. Par exemple : fieldA, fieldB, fieldC
   10. Companies Properties (Propriétés des sociétés) : saisissez les noms des champs séparés par une virgule de l'entité Companies que vous souhaitez sélectionner dans l'opération List de l'entité. Par exemple : fieldA, fieldB, fieldC
   11. Deals Properties (Propriétés des accords) : saisissez les noms des champs séparés par une virgule de l'entité Deals que vous souhaitez sélectionner lors de l'opération d'entité List. Par exemple : fieldA, fieldB, fieldC
   12. Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion.
   13. Proxy Auth Scheme (Schéma d'authentification du proxy) : type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer.
   14. Proxy User (Utilisateur du proxy) : nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
   15. Mot de passe du proxy: mot de passe permettant de s'authentifier auprès du proxy ProxyServer.
   16. Type SSL du proxy: type de SSL à utiliser lors de la connexion au proxy ProxyServer.
   17. Vous pouvez également configurer les paramètres du nœud de connexion :
       • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
       • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

       Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

   Remarque : Vous ne pouvez personnaliser les valeurs du nœud de connexion que si vous êtes un client facturé à l'usage.
   18. Vous pouvez également cliquer sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
   19. Cliquez sur Suivant.
5. Dans la section Destinations, saisissez les informations concernant l'hôte distant (système backend) auquel vous souhaitez vous connecter.
   1. Type de destination : vous pouvez spécifier les détails de destination sous la forme d'une adresse hôte ou d'un rattachement de service. Sélectionnez l'un des types de destination suivants :
      • Adresse hôte : si vous souhaitez spécifier le nom d'hôte ou l'adresse IP de la destination.
      • Rattachement de service : si vous souhaitez spécifier le point de terminaison privé pour vos adresses IP internes. Le rattachement de service vous permet de masquer vos adresses IP internes dans le réseau externe. Vous pouvez créer un rattachement de service dans Google Cloud à l'aide de la fonctionnalité Private Service Connect. Pour en savoir plus sur la configuration d'une instance Private Service Connect, consultez la page Publier des services gérés.

      En fonction du type de destination sélectionné, saisissez l'adresse hôte ou le nom du rattachement de service.

      Pour saisir d'autres destinations, cliquez sur + Ajouter une destination.

   2. Cliquez sur Suivant.
6. Dans la section Authentification, saisissez les informations d'authentification.
   1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion HubSpot:

      • Private App Access Token (Jeton d'accès à l'application privée) : sélectionnez le secret Secret Manager contenant le jeton d'accès à l'application privée.

        Les applications privées vous permettent d'utiliser les API HubSpot pour accéder à des données spécifiques de votre compte HubSpot. Vous pouvez autoriser ce que chaque application privée peut demander ou modifier dans votre compte, ce qui générera un jeton d'accès propre à votre application privée. Dans votre application privée, assurez-vous d'avoir accordé l'autorisation de lecture au moins aux niveaux suivants:

        • 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

        Pour en savoir plus, consultez Applications privées.

   2. Cliquez sur Suivant.
7. Si vous avez activé l'abonnement aux événements, la section Détails de l'abonnement aux événements s'affiche sur la page de création de connexion. À l'étape Détails de l'abonnement à l'événement, fournissez les informations d'authentification qui seront utilisées pour valider la charge utile du jeton HubSpot :
   1. Code secret du client : (facultatif) sélectionnez le secret Secret Manager du code secret du client de votre application privée, ainsi que la version correspondante dans la liste déroulante Version du secret.

   Pour en savoir plus, consultez Applications privées.

   2. Sélectionnez Activer la connectivité privée pour sécuriser la connectivité entre votre application backend et votre connexion. Si vous sélectionnez cette option, vous devez effectuer des étapes de configuration supplémentaires après avoir créé la connexion. Pour en savoir plus, consultez Connectivité privée pour l'abonnement à un événement.
   3. Saisissez la configuration de lettres mortes. Si vous configurez des lettres mortes, la connexion écrit les événements non traités dans le sujet Pub/Sub spécifié. Saisissez les informations suivantes :
      1. ID du projet de lettre morte : ID du projet Google Cloud dans lequel vous avez configuré le sujet de lettre morte Pub/Sub.
      2. Sujet de lettres mortes : sujet Pub/Sub dans lequel vous souhaitez écrire les détails de l'événement non traité.
   4. Cliquez sur Suivant.
8. Vérifiez vos informations de connexion et d'authentification.
9. Cliquez sur Créer.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Remarque : Vous pouvez afficher les entités, les opérations et les actions d'un connecteur dans la tâche Connecteurs.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

  Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
  • Liste
  • Obtenir
  • créer
  • Mettre à jour
  • Supprimer

  La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, celles-ci ne sont pas répertoriées dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Remarque : Toutes les entités et les actions seront associées à un schéma. Par exemple, un schéma d'action contiendra les détails des paramètres, tels que les noms des paramètres et le type de données correspondant. Le schéma (métadonnées) des entités et des actions est récupéré par la connexion au moment de l'exécution à partir de votre backend. Si le schéma est mis à jour, celles-ci ne seront pas automatiquement répercutées dans vos connexions existantes. Vous devez actualiser le schéma manuellement. Pour actualiser le schéma d'une connexion, ouvrez la page Détails de la connexion de la connexion, puis cliquez sur Actualiser le schéma de connexion.

Problèmes connus

• L'opération de mise à jour sur certaines entités renvoie une réponse vide même si la mise à jour a réussi. Dans ce cas, nous vous recommandons de vérifier la mise à jour dans votre instance HubSpot.
• Dans HubSpot, vous pouvez éventuellement avoir de nombreux champs personnalisés pour les entités suivantes :
  • Contacts
  • Entreprises
  • Offres spéciales

  Pour ces entités, le fait de sélectionner tous les champs simultanément dans l'opération d'entité List peut entraîner le renvoi d'une erreur par le connecteur HubSpot. Si vous souhaitez limiter le nombre de champs personnalisés de l'opération List, spécifiez les noms de champs obligatoires (sous forme de valeurs séparées par des virgules) dans la configuration du connecteur HubSpot. Par exemple, pour limiter les champs de l'entité Contacts, spécifiez les noms des champs obligatoires dans le champ Contacts Properties de la configuration du connecteur. De même, pour l'entité Companies, spécifiez les noms de champs obligatoires dans le champ Companies Properties et, pour l'entité Deals, spécifiez les noms de champs obligatoires dans le champ Deals Properties.

  Vous pouvez spécifier les champs à l'étape de création de la connexion. Toutefois, si vous disposez déjà d'une connexion, vous devez la modifier, puis spécifier les champs obligatoires.

• Si votre ensemble de résultats est très volumineux, l'opération List peut échouer en raison d'un délai avant expiration de la connexion. Dans un tel scénario, vous pouvez explorer la possibilité de limiter votre ensemble de résultats en spécifiant la clause de filtre pour l'opération de liste.

Exemples d'opérations sur les entités

Cette section explique comment effectuer certaines opérations sur les entités dans ce connecteur.

Exemple : Répertorier tous les contacts

Cet exemple répertorie tous les enregistrements de l'entité Contacts.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Contacts dans la liste Entity.
3. Sélectionnez l'opération LIST, puis cliquez sur OK.

Exemple : Obtenir un enregistrement d'accord

Cet exemple récupère un enregistrement dont l'ID est 45 à partir de l'entité Deals.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Deals dans la liste Entity.
3. Sélectionnez l'opération GET, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId (ID d'entité), puis saisissez 45 dans le champ Default Value (Valeur par défaut).

   Ici, 45 est une valeur de clé primaire dans l'entité Deals.

Exemple : Créer une demande d'assistance

Cet exemple crée une demande dans l'entité Ticket.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Tickets dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Name": "Test735362767",
   "Label": "Test735362767",
   "Type": "String",
   "FieldType": "Insert ticket1",
   "GroupName": "ticketinformation",
   "Description": "Test ticket"
   }

   Si l'intégration réussit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

   {
   "Name": "Test1695971640609"
   }

Exemple – Mettre à jour une entrée pour les offres spéciales

Cet exemple met à jour l'enregistrement dont l'ID est 97 dans l'entité Contacts.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Deals dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Description": "New description"
   }

5. Cliquez sur entityId, puis saisissez 97 dans le champ Valeur par défaut.

   Au lieu de spécifier entityId, vous pouvez également définir filterClause sur 97.

Exemple : Supprimer un formulaire

Cet exemple supprime l'enregistrement dont l'ID est 78 dans l'entité Forms.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Forms dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 78 dans le champ Default Value (Valeur par défaut).

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre	Type de données	Obligatoire	Description
schema	ENUM	Vrai	Spécifiez la version de l'API HubSpot à utiliser. HubSpotV4 est la nouvelle API. Valeurs acceptées: HubSpot, HubSpotV3, HubSpotV4
browsable_schemas	STRING	Faux	Cette propriété limite les schémas signalés à un sous-ensemble des schémas disponibles. Par exemple, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
contacts_columns	STRING	Faux	Liste de propriétés à sélectionner dans HubSpot pour l'entité Contacts, séparées par une virgule.
companies_columns	STRING	Faux	Liste de propriétés à sélectionner dans HubSpot for the Companies, séparées par une virgule.
deals_columns	STRING	Faux	Liste de propriétés à sélectionner dans HubSpot pour l'entité "Deals", séparées par une virgule.
proxy_enabled	VALEUR BOOLÉENNE	Faux	Cochez cette case pour configurer un serveur proxy pour la connexion.
proxy_auth_scheme	ENUM	Faux	Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont: BASIC, DIGEST, NONE
proxy_user	STRING	Faux	Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password	SECRET	Faux	Mot de passe à utiliser pour l'authentification auprès du proxy ProxyServer.
proxy_ssltype	ENUM	Faux	Type SSL à utiliser lors de la connexion au proxy ProxyServer. Les valeurs acceptées sont: AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion HubSpot dans une intégration

Une fois la connexion créée, elle devient disponible à la fois dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.

• Pour comprendre comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la section Tâche Connecteurs.
• Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes

• Découvrez comment suspendre et réactiver une connexion.
• Découvrez comment surveiller l'utilisation des connecteurs.
• Découvrez comment afficher les journaux du connecteur.