HubSpot

O conector do HubSpot permite executar operações de inserção, exclusão, atualização e leitura no conjunto de dados do HubSpot.

Versões compatíveis

Esse conector é compatível com as seguintes versões da API HubSpot:

HubSpot
HubSpotV3
HubSpotV4

Antes de começar

Antes de usar o conector do HubSpot, faça o seguinte:

No seu projeto do Google Cloud, faça o seguinte:
- Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando o conector.
- Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.
- Ative os seguintes serviços:
  - secretmanager.googleapis.com (API Secret Manager)
  - connectors.googleapis.com (API Connectors)
  Para entender como ativar os serviços, consulte Como ativar serviços.
Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
Acesse a página "Conexões"
Clique em + Criar novo para abrir a página Criar conexão.
Na seção Local, escolha o local da conexão.
1. Região: selecione um local na lista suspensa.
  Veja abaixo as regiões com suporte com o conector:
  Para acessar a lista de todas as regiões com suporte, consulte Locais.
2. Clique em Próxima.
Na seção Detalhes da conexão, faça o seguinte:
1. Conector: selecione HubSpot na lista suspensa de conectores disponíveis.
2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
3. No campo Nome da conexão, insira um nome para a instância de conexão
  Os nomes de conexão precisam atender aos seguintes critérios:
  - Os nomes de conexões podem usar letras, números ou hifens.
  - As letras precisam ser minúsculas.
  - Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
  - Os nomes das conexões não podem exceder 63 caracteres.
4. Como opção, insira uma Descrição para a instância de conexão.
5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
6. Para usar a conexão em inscrições em eventos, selecione Ativar inscrição em eventos. Ao selecionar essa opção, aparecem as seguintes opções:
  - Ativar inscrição de eventos com entidade e ações: selecione essa opção para usar a conexão na inscrição de eventos e nas operações do conector (entidades e ações).
  - Ativar somente assinatura de eventos: selecione essa opção para usar a conexão apenas para a assinatura de eventos.
  Para essas duas seleções, você vai precisar configurar os detalhes do evento nas próximas etapas.
7. Esquema: especifique a versão da API HubSpot a ser usada. HubSpotV4 é a nova API.
8. BrowsableSchemas: essa propriedade restringe os esquemas informados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
9. Contacts Properties: insira os nomes de campos separados por vírgula da entidade Contacts que você quer selecionar na operação de entidade List. Por exemplo: fieldA, fieldB, fieldC.
10. Propriedades de empresas: insira os nomes de campos separados por vírgula da entidade Companies que você quer selecionar da operação de entidade List. Por exemplo: fieldA, fieldB, fieldC.
11. Deals Properties: insira os nomes dos campos separados por vírgula da entidade Deals que você quer selecionar da operação de entidade List. Por exemplo: fieldA, fieldB, fieldC.
12. Usar proxy: marque essa caixa de seleção para configurar um servidor proxy para a conexão.
13. Esquema de autenticação de proxy: o tipo de autenticação a ser usado para autenticar o proxy do ProxyServer.
14. Usuário do proxy: um nome de usuário a ser usado para autenticação no proxy do ProxyServer.
15. Senha de proxy: senha a ser usada para autenticação no proxy do ProxyServer.
16. Tipo de SSL do proxy: o tipo de SSL a ser usado na conexão com o proxy do ProxyServer.
17. Opcionalmente, defina as Configurações do nó de conexão:
  - Número mínimo de nós: digite o número mínimo de nós de conexão.
  - Número máximo de nós: digite o número máximo de nós de conexão.
  Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.
18. Também é possível clicar em + Adicionar rótulo para incluir um rótulo na conexão na forma de um par de chave-valor.
19. Clique em Próxima.
Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
1. Tipo de destino: é possível especificar os detalhes de destino como endereço de host ou anexo de serviço. Selecione um dos tipos de destino a seguir:
  - Endereço do host: se você quiser especificar o nome do host ou o endereço IP do destino.
  - Anexo de serviço: se você quiser especificar o endpoint particular para seus endereços IP internos. O anexo de serviço permite ocultar seus endereços IP internos da rede externa. É possível criar um anexo de serviço no Google Cloud usando o recurso Private Service Connect. Para informações sobre como configurar um Private Service Connect, consulte Publicar serviços gerenciados.
  Com base no tipo de destino selecionado, insira o endereço do host ou o nome do anexo do serviço.
  
  Para inserir mais destinos, clique em +Adicionar destino.
2. Clique em Próxima.
Na seção Autenticação, insira os detalhes da autenticação.
1. Selecione um Tipo de autenticação e insira os detalhes relevantes.
  Os seguintes tipos de autenticação são compatíveis com a conexão do HubSpot:
  - Private App Access Token : selecione o Secret do Secret Manager que contém o token de acesso a apps particulares.
    Com os apps particulares, é possível usar as APIs do HubSpot para acessar dados específicos da sua conta. É possível autorizar o que cada app particular pode solicitar ou alterar na sua conta, o que gera um token de acesso exclusivo. No app particular, verifique se você forneceu a permissão de leitura pelo menos para os seguintes escopos:
    - 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 Apps particulares.
2. Clique em Próxima.
Se você tiver ativado a inscrição de eventos, a seção Detalhes da assinatura de eventos será exibida na página de criação da conexão. Na etapa Detalhes da assinatura do evento, informe os detalhes de autenticação que vão ser usados para validar o payload do token do HubSpot:
1. Chave secreta do cliente: (opcional) selecione a chave secreta do Secret Manager da chave secreta do cliente do app particular e a versão correspondente do secret na lista suspensa Versão do secret.
2. Selecione Ativar conectividade particular para conectividade segura entre seu aplicativo de back-end e sua conexão. Se você selecionar essa opção, precisará executar etapas de configuração adicionais depois de criar a conexão. Para mais informações, consulte Conectividade particular para inscrição em eventos.
3. Insira a configuração de mensagens inativas. Se você configurar a mensagem inativa, a conexão gravará os eventos não processados no tópico do Pub/Sub especificado. Digite os seguintes detalhes:
  1. ID do projeto de mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico do Pub/Sub de mensagens inativas.
  2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer escrever os detalhes do evento não processado.
4. Clique em Próxima.
Revisão: revise os detalhes de conexão e autenticação.
Clique em Criar.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.
No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.
Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
- List
- Receber
- Criar
- Atualizar
- Excluir
Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, essas operações não serão listadas na lista Operations.
Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Problemas conhecidos

A operação de atualização em algumas das entidades retorna uma resposta vazia mesmo que a atualização seja bem-sucedida. Nesses casos, é recomendável verificar a atualização na sua instância do HubSpot.
No HubSpot, é possível ter muitos campos personalizados para as seguintes entidades:
- Contatos
- Empresas
- Ofertas
Para essas entidades, selecionar todos os campos de uma só vez na operação de entidade List pode fazer com que o conector do HubSpot retorne um erro. Nos cenários em que você quiser 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 conector do HubSpot. Por exemplo, para limitar os campos da entidade Contacts, especifique os nomes dos campos obrigatórios no campo Contacts Properties da configuração do conector. Da mesma forma, para a entidade Companies, especifique os nomes de campo obrigatórios no campo Companies Properties e, para a entidade Deals, especifique os nomes de campo obrigatórios no campo Deals Properties.

É possível especificar os campos durante a etapa de criação da conexão. No entanto, se você já tiver uma conexão, edite-a e especifique os campos obrigatórios.
Se você tiver um conjunto de resultados muito grande, a operação List poderá falhar devido ao tempo limite de conexão. Nesse cenário, você pode explorar a opção de limitar seu conjunto de resultados especificando a cláusula de filtro para a operação List.

Exemplos de operação de entidade

Esta seção mostra como executar algumas das operações da entidade no conector.

Exemplo: listar todos os contatos

Neste exemplo, listamos todos os registros na entidade Contacts.

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

Exemplo: acessar um registro da oferta

Neste exemplo, recebemos um registro com o ID 45 da entidade Deals.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Deals na lista de Entity.
Selecione a operação GET e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em EntityId e insira 45 no campo Valor padrão.
Aqui, 45 é um valor de chave primária na entidade Deals.

Exemplo: criar um tíquete

Neste exemplo, um tíquete é criado na entidade Ticket.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Tickets na lista de Entity.
Selecione a operação Create e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira 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 terá um valor semelhante a este:
```
{
"Name": "Test1695971640609"
}
```

Exemplo: atualizar uma entrada de oferta

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

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Deals na lista de Entity.
Selecione a operação Update e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"Description": "New description"
}
```
Clique em entityId e, em seguida, insira 97 no campo Valor padrão.
Como alternativa, em vez de especificar o entityId, você também pode definir o filterLesson como 97.

Exemplo: excluir um formulário

Este exemplo exclui o registro cujo ID é 78 na entidade Forms.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Forms na lista de Entity.
Selecione a operação Delete e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 78 no campo Valor padrão.

Usar o Terraform para criar conexões

Use o recurso do Terraform (em inglês) para criar uma nova conexão.

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

Confira um exemplo de modelo do Terraform para criar uma conexão em exemplo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
schema	ENUM	Verdadeiro	Especifique a versão da API HubSpot a ser usada. HubSpotV4 é a nova API. Os valores aceitos são: HubSpot, HubSpotV3 e HubSpotV4
browsable_schemas	STRING	Falso	Esta propriedade restringe os esquemas informados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
contacts_columns	STRING	Falso	Lista de propriedades separadas por vírgulas a serem selecionadas do HubSpot para a entidade "Contatos".
companies_columns	STRING	Falso	Lista de propriedades separadas por vírgulas a serem selecionadas do HubSpot para a entidade "Empresas".
deals_columns	STRING	Falso	Lista separada por vírgulas de propriedades a serem selecionadas no HubSpot para a entidade "Transações".
proxy_enabled	BOOLEAN	Falso	Marque essa caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar o proxy ProxyServer. Valores aceitos: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticação no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado na conexão com o proxy do ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, SELECTED

Usar a conexão da HubSpot em uma integração

Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use a conexão em uma integração por meio da tarefa Conectores.

Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte Tarefa Conectores.
Para entender como criar e usar a tarefa de conectores na Application Integration, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Entenda como visualizar os registros do conector.