HubSpot

O conetor do HubSpot permite-lhe realizar operações de inserção, eliminação, atualização e leitura em conjuntos de dados do HubSpot.

Versões suportadas

Este conector suporta as seguintes versões da API HubSpot:

• HubSpot
• HubSpotV3
• HubSpotV4

Antes de começar

Antes de usar o conector do HubSpot, faça as seguintes tarefas:

• No seu projeto do Google Cloud:
  • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
  • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
  • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.

  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (API Connectors)

    Para saber como ativar serviços, consulte o artigo Ativar serviços.

  Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

   Aceda à página Ligações

2. Clique em + Criar novo para abrir a página Criar associação.
3. Na secção Localização, escolha a localização para a ligação.
   1. Região: selecione uma localização na lista pendente.

      As regiões suportadas para conetores incluem:

      Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

   2. Clicar em Seguinte.
4. Na secção Detalhes da associação, conclua o seguinte:
   1. Conetor: selecione HubSpot na lista pendente de conetores disponíveis.
   2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
   3. No campo Nome da ligação, introduza um nome para a instância de ligação.

      Os nomes das associações têm de cumprir os seguintes critérios:

      • Os nomes das associações podem usar letras, números ou hífenes.
      • As letras têm de ser minúsculas.
      • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das associações não podem exceder 49 carateres.
      • Para os conetores que suportam a subscrição de eventos, os nomes das associações não podem começar com o prefixo "goog".
   4. Opcionalmente, introduza uma Descrição para a instância de associação.
   5. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
   6. Para usar a associação para subscrições de eventos, selecione Ativar subscrição de eventos. Se selecionar esta opção, são apresentadas as seguintes opções:
      • Ativar subscrição de eventos com entidade e ações: selecione esta opção para usar a associação para a subscrição de eventos e as operações do conetor (entidades e ações).
      • Ativar apenas subscrição de eventos: selecione esta opção para usar a associação apenas para a subscrição de eventos. Se selecionar esta opção, clique em Seguinte e, de seguida, configure a subscrição de eventos.
   7. Esquema: especifique a versão da API HubSpot a usar. O HubSpotV4 é a nova API.
   8. BrowsableSchemas: esta propriedade restringe os esquemas comunicados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
   9. Propriedades de contactos: introduza os nomes dos campos separados por vírgulas da entidade Contacts que quer selecionar na operação da entidade List. Por exemplo, fieldA, fieldB, fieldC
   10. Companies Properties: introduza os nomes dos campos separados por vírgulas da entidade Companies que quer selecionar na operação da entidade List. Por exemplo, fieldA, fieldB, fieldC
   11. Propriedades de acordos: introduza os nomes dos campos separados por vírgulas da entidade Deals que quer selecionar na operação da entidade List. Por exemplo, fieldA, fieldB, fieldC
   12. Usar proxy: selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
   13. Esquema de autenticação de proxy: o tipo de autenticação a usar para autenticar no proxy ProxyServer.
   14. Utilizador do proxy: um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
   15. Palavra-passe do proxy: uma palavra-passe a usar para a autenticação no proxy ProxyServer.
   16. Tipo de SSL do proxy: o tipo de SSL a usar ao ligar ao proxy ProxyServer.
   17. Opcionalmente, configure as definições do nó de associação:
       • Número mínimo de nós: introduza o número mínimo de nós de ligação.
       • Número máximo de nós: introduza o número máximo de nós de ligação.

       Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

   Nota: só pode personalizar os valores dos nós de associação se for cliente de pagamento conforme o uso.
   18. Opcionalmente, clique em + Adicionar etiqueta para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   19. Clicar em Seguinte.
5. Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
   1. Tipo de destino: pode especificar os detalhes do destino como um endereço de anfitrião ou um anexo de serviço. Selecione um dos seguintes tipos de destinos:
      • Endereço do anfitrião: se quiser especificar o nome de anfitrião ou o endereço IP do destino.
      • Associação de serviços: se quiser especificar o ponto final privado para os seus endereços IP internos. A associação de serviços permite-lhe ocultar os seus endereços IP internos da rede externa. Pode criar uma associação do serviço no Google Cloud através da funcionalidade Private Service Connect. Para obter informações sobre a configuração de um Private Service Connect, consulte o artigo Publique serviços geridos.

      Com base na sua seleção do tipo de destino, introduza o endereço do anfitrião ou o nome da associação de serviço.

      Para introduzir destinos adicionais, clique em +Adicionar destino.

   2. Clicar em Seguinte.
6. Na secção Autenticação, introduza os detalhes de autenticação.
   1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela associação do HubSpot:

      • Token de acesso a apps privadas: selecione o segredo do Secret Manager que contém o token de acesso a apps privadas.

        As apps privadas permitem-lhe usar as APIs da HubSpot para aceder a dados específicos da sua conta da HubSpot. Pode autorizar o que cada app privada pode pedir ou alterar na sua conta, o que gera um token de acesso exclusivo da sua app privada. Na sua app privada, certifique-se de que concedeu, pelo menos, a autorização de leitura aos seguintes âmbitos:

        • 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 mais informações, consulte o artigo Apps privadas.

   2. Clicar em Seguinte.
7. Se ativou a subscrição de eventos, a secção Detalhes da subscrição de eventos é apresentada na página de criação da associação. No passo Detalhes da subscrição de eventos, indique os detalhes de autenticação que vão ser usados para validar a carga útil do token do HubSpot:
   1. Segredo do cliente: (opcional) selecione o segredo do Secret Manager do segredo do cliente da sua app privada e a versão do segredo correspondente no menu pendente Versão do segredo.

   Para mais informações, consulte o artigo Apps privadas.

   2. Selecione Ativar conetividade privada para uma conetividade segura entre a sua aplicação de back-end e a sua ligação. Se selecionar esta opção, tem de realizar passos de configuração adicionais depois de criar a associação. Para mais informações, consulte o artigo Conetividade privada para subscrição de eventos.
   3. Introduza a configuração de mensagens não entregues. Se configurar a fila de mensagens rejeitadas, a ligação escreve os eventos não processados no tópico Pub/Sub especificado. Introduza os seguintes detalhes:
      1. ID do projeto de mensagens não entregues: o ID do projeto do Google Cloud onde configurou o tópico Pub/Sub de mensagens não entregues.
      2. Tópico de mensagens não entregues: o tópico do Pub/Sub onde quer escrever os detalhes do evento não processado.
   4. Clicar em Seguinte.
8. Rever: reveja os detalhes da ligação e da autenticação.
9. Clique em Criar.

Tipo de ligação ao servidor do HubSpot V1

A tabela seguinte apresenta os valores de exemplo para os vários campos que configura quando cria a associação do HubSpot.

Nome do campo	Detalhes
Região	us-central1
Conetor	HubSpot
Versão do conetor	1
Nome da ligação	hub-spot-conn
Conta de serviço	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com/td>
Esquema	Hubspot
Número mínimo de nós	2
Número máximo de nós	50
Token de acesso à app privada	PRIVATE_APP_ACCESS_TOKEN
Versão do secret	1

Crie um token de acesso a apps privadas no HubSpot

1. Crie uma nova conta do HubSpot e inicie sessão no HubSpot.
2. Clique em Definições e, de seguida, navegue para Integrações > Apps privadas.
3. Clique em Criar app privada.
4. No separador Informações básicas, configure os detalhes da sua aplicação, como o nome, o logótipo e a descrição.
5. No separador Âmbitos, selecione Ler ou Escrever para cada âmbito ao qual quer que a sua aplicação privada tenha acesso.
6. Depois de configurar a aplicação, clique em Criar app.
7. Reveja as informações sobre o token de acesso da sua aplicação e, de seguida, clique em Continuar criação e, depois, em Mostrar token.

Use este valor do token para especificar o token de acesso da app privada quando configurar a associação no Google Cloud.

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

Nota: pode ver as entidades, as operações e as ações de um conector na tarefa Conectores.

• Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não suporte ou não tenha entidades, caso em que a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:
  • Lista
  • Obter
  • Criar
  • Atualizar
  • Eliminar

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.

• Ação: uma ação é uma função de primeira classe que é disponibilizada à integração através da interface do conetor. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Nota: todas as entidades e ações têm um esquema associado. Por exemplo, um esquema de ação tem os detalhes dos parâmetros, como os nomes dos parâmetros e o respetivo tipo de dados. O esquema (metadados) para entidades e ações é obtido pela ligação em tempo de execução a partir do seu back-end. Se existirem atualizações ao esquema, estas não são refletidas automaticamente nas suas associações existentes. Tem de atualizar o esquema manualmente. Para atualizar o esquema de uma associação, abra a página Detalhes da associação da associação e, de seguida, clique em Atualizar esquema da associação.

Problemas conhecidos

• A operação de atualização em algumas das entidades devolve uma resposta vazia, mesmo que a atualização seja bem-sucedida. Nestes casos, recomendamos que valide a atualização na sua instância do HubSpot.
• No HubSpot, pode ter muitos campos personalizados para as seguintes entidades:
  • Contactos
  • Empresas
  • Ofertas especiais

  Para estas entidades, selecionar todos os campos em simultâneo na operação de entidade List pode fazer com que o conetor do HubSpot devolva um erro. Nos cenários em que quer limitar o número de campos personalizados da operação List, especifique os nomes dos campos obrigatórios (como valores separados por vírgulas) na configuração do conetor do HubSpot. Por exemplo, para limitar os campos da entidade Contacts, especifique os nomes dos campos necessários no campo Contacts Properties da configuração do conetor. Da mesma forma, para a entidade Companies, especifique os nomes dos campos obrigatórios no campo Companies Properties e, para a entidade Deals, especifique os nomes dos campos obrigatórios no campo Deals Properties.

  Pode especificar os campos durante o passo de criação da associação. No entanto, se já tiver uma ligação, tem de editar a ligação e, em seguida, especificar os campos obrigatórios.

• Se tiver um conjunto de resultados muito grande, a operação List pode falhar devido a um limite de tempo da ligação. Neste cenário, pode explorar a opção de limitar o conjunto de resultados especificando a cláusula filter para a operação List.

Exemplos de operações de entidades

Esta secção mostra como realizar algumas das operações de entidades neste conector.

Exemplo: listar todos os contactos

Este exemplo apresenta todos os registos na entidade Contacts.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Contacts na lista Entity.
3. Selecione a operação LIST e, de seguida, clique em Concluído.

Exemplo: obter um registo de negócio

Este exemplo obtém um registo cujo ID é 45 da entidade Deals.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Deals na lista Entity.
3. Selecione a operação GET e, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em EntityId e, de seguida, introduza 45 no campo Valor predefinido.

   Aqui, 45 é um valor de chave principal na entidade Deals.

Exemplo: criar um pedido

Este exemplo cria um pedido na entidade Ticket.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Tickets na lista Entity.
3. Selecione a operação Create e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

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

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector tem um valor semelhante ao seguinte:

   {
   "Name": "Test1695971640609"
   }

Exemplo: atualize uma entrada de ofertas

Este exemplo atualiza o registo cujo ID é 97 na entidade Contacts.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Deals na lista Entity.
3. Selecione a operação Update e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

   {
   "Description": "New description"
   }

5. Clique em entityId e, de seguida, introduza 97 no campo Valor predefinido.

   Em alternativa, em vez de especificar o entityId, também pode definir a filterClause como 97.

Exemplo: elimine um formulário

Este exemplo elimina o registo cujo ID é 78 na entidade Forms.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Forms na lista Entity.
3. Selecione a operação Delete e, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conetores, clique em entityId e, de seguida, introduza 78 no campo Valor predefinido.

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

Para saber como aplicar ou remover uma configuração do Terraform, consulte os comandos básicos do Terraform.

Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
esquema	ENUM	True	Especifique a versão da API HubSpot a usar. O HubSpotV4 é a nova API. Os valores suportados são: HubSpot, HubSpotV3 e HubSpotV4
browsable_schemas	STRING	Falso	Esta propriedade restringe os esquemas comunicados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
contacts_columns	STRING	Falso	Lista separada por vírgulas de propriedades a selecionar do HubSpot para a entidade Contacts.
companies_columns	STRING	Falso	Lista de propriedades separadas por vírgulas a selecionar do HubSpot para a entidade Companies.
deals_columns	STRING	Falso	Lista de propriedades separadas por vírgulas a selecionar do HubSpot para a entidade Deals.
proxy_enabled	BOOLEAN	Falso	Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a usar para autenticar no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma palavra-passe a usar para autenticar no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a usar quando se liga ao proxy ProxyServer. Os valores suportados são: AUTO, ALWAYS, NEVER, TUNNEL

Use a associação do HubSpot numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

• Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
• Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

• Compreenda como suspender e retomar uma associação.
• Compreenda como monitorizar a utilização do conector.
• Compreenda como ver os registos do conetor.