Partilhar via


Copiar dados do HubSpot usando o Azure Data Factory ou o Synapse Analytics

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Gorjeta

Experimente o Data Factory no Microsoft Fabric, uma solução de análise tudo-em-um para empresas. O Microsoft Fabric abrange tudo, desde a movimentação de dados até ciência de dados, análises em tempo real, business intelligence e relatórios. Saiba como iniciar uma nova avaliação gratuitamente!

Este artigo descreve como usar a Atividade de Cópia em um pipeline do Azure Data Factory ou do Synapse Analytics para copiar dados do HubSpot. Ele se baseia no artigo de visão geral da atividade de cópia que apresenta uma visão geral da atividade de cópia.

Importante

A versão 1.0 do conector HubSpot está numa fase de remoção. Recomenda-se que atualize o conector HubSpot da versão 1.0 para a 2.0.

Capacidades suportadas

Este conector HubSpot é suportado para os seguintes recursos:

Capacidades suportadas IR
Atividade de cópia (fonte/-) (1) (2)
Atividade de Pesquisa (1) (2)

(1) Tempo de execução de integração do Azure (2) Tempo de execução de integração auto-hospedado

Para obter uma lista de armazenamentos de dados suportados como fontes/coletores, consulte a tabela Armazenamentos de dados suportados.

O serviço fornece um driver interno para habilitar a conectividade, portanto, você não precisa instalar manualmente nenhum driver usando esse conector.

O conector suporta as versões do Windows neste artigo.

Introdução

Para executar a atividade de cópia com um pipeline, você pode usar uma das seguintes ferramentas ou SDKs:

Criar um serviço vinculado ao HubSpot usando a interface do usuário

Use as etapas a seguir para criar um serviço vinculado ao HubSpot na interface do usuário do portal do Azure.

  1. Navegue até a guia Gerenciar em seu espaço de trabalho do Azure Data Factory ou Synapse e selecione Serviços Vinculados e clique em Novo:

  2. Procure HubSpot e selecione o conector HubSpot.

    Selecione o conector HubSpot.

  3. Configure os detalhes do serviço, teste a conexão e crie o novo serviço vinculado.

    Configure um serviço vinculado ao HubSpot.

Detalhes de configuração do conector

As seções a seguir fornecem detalhes sobre as propriedades usadas para definir entidades do Data Factory específicas para o conector HubSpot.

Propriedades do serviço vinculado

O conector HubSpot agora suporta a versão 2.0. Consulte esta seção para atualizar a versão do conector HubSpot da versão 1.0. Para obter os detalhes da propriedade, consulte as seções correspondentes.

Versão 2.0

O serviço vinculado da HubSpot suporta as seguintes propriedades quando se aplica a versão 2.0:

Property Descrição Obrigatório
tipo A propriedade type deve ser definida como: Hubspot Sim
versão A versão que especificares. O valor é 2.0. Sim
clientId O ID do cliente associado ao seu aplicativo HubSpot. Saiba como criar um aplicativo no HubSpot a partir daqui. Sim
clientSecret O segredo do cliente associado ao seu aplicativo HubSpot. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Sim
accessToken O token de acesso obtido ao autenticar inicialmente sua integração OAuth. Saiba como obter o token de acesso com o seu ID de cliente e segredo aqui. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Sim
refreshToken O token de atualização obtido ao autenticar inicialmente sua integração OAuth. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Sim
conectarVia O tempo de execução de integração a ser usado para se conectar ao armazenamento de dados. Se nenhum valor for especificado, a propriedade usará o tempo de execução de integração padrão do Azure. Não

Exemplo:

{
    "name": "HubSpotLinkedService",
    "properties": {
        "type": "Hubspot",
        "version": "2.0",
        "typeProperties": {
            "clientId" : "<clientId>",
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            },
            "accessToken": {
                "type": "SecureString",
                "value": "<accessToken>"
            },
            "refreshToken": {
                "type": "SecureString",
                "value": "<refreshToken>"
            }
        }
    }
}

Versão 1.0

O serviço vinculado do HubSpot suporta as seguintes propriedades quando se aplica a versão 1.0:

Property Descrição Obrigatório
tipo A propriedade type deve ser definida como: Hubspot Sim
clientId O ID do cliente associado ao seu aplicativo HubSpot. Saiba como criar um aplicativo no HubSpot a partir daqui. Sim
clientSecret O segredo do cliente associado ao seu aplicativo HubSpot. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Sim
accessToken O token de acesso obtido ao autenticar inicialmente sua integração OAuth. Saiba como obter o token de acesso com o seu ID de cliente e segredo aqui. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Sim
refreshToken O token de atualização obtido ao autenticar inicialmente sua integração OAuth. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure. Sim
useEncryptedEndpoints Especifica se os pontos de extremidade da fonte de dados são criptografados usando HTTPS. O valor predefinido é true. Não
useHostVerification Especifica se o nome do host no certificado do servidor deve corresponder ao nome do host do servidor ao se conectar por TLS. O valor predefinido é true. Não
usePeerVerification Especifica se a identidade do servidor deve ser verificada ao se conectar por TLS. O valor predefinido é true. Não
conectarVia O tempo de execução de integração a ser usado para se conectar ao armazenamento de dados. Se nenhum valor for especificado, a propriedade usará o tempo de execução de integração padrão do Azure. Não

Exemplo:

{
    "name": "HubSpotLinkedService",
    "properties": {
        "type": "Hubspot",
        "typeProperties": {
            "clientId" : "<clientId>",
            "clientSecret": {
                "type": "SecureString",
                "value": "<clientSecret>"
            },
            "accessToken": {
                "type": "SecureString",
                "value": "<accessToken>"
            },
            "refreshToken": {
                "type": "SecureString",
                "value": "<refreshToken>"
            }
        }
    }
}

Propriedades do conjunto de dados

Para obter uma lista completa de seções e propriedades disponíveis para definir conjuntos de dados, consulte o artigo sobre conjuntos de dados. Esta seção fornece uma lista de propriedades suportadas pelo conjunto de dados do HubSpot.

Para copiar dados do HubSpot, defina a propriedade type do conjunto de dados como HubspotObject. As seguintes propriedades são suportadas:

Property Descrição Obrigatório
tipo A propriedade type do conjunto de dados deve ser definida como: HubspotObject Sim
tableName Nome da tabela. Para a versão 2.0, o nome da tabela é <HubSpot Category>.<Sub Category>.<Object Name>, por exemplo: CRM.Commerce.Discounts. Sim para a versão 2.0.
Não na versão 1.0 (se "consulta" for especificada na fonte de atividade)

Exemplo

{
    "name": "HubSpotDataset",
    "properties": {
        "type": "HubspotObject",
        "typeProperties": {},
        "schema": [],        
        "linkedServiceName": {
            "referenceName": "<HubSpot linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

O conector versão 2.0 suporta as seguintes tabelas HubSpot:

  • Marketing.Campanhas
  • Marketing.Emails.Marketing_Emails
  • Marketing.Subscrições
  • Conversas.CaixaDeEntrada___Mensagens
  • CMS.Autores
  • CMS.Blog_Settings
  • CMS.Content_Audit
  • CMS.Domínios
  • CMS. Hubdb
  • CMS.Pages
  • CMS Publicações
  • CMS.Site_Search
  • CMS Etiquetas
  • CMS.Url_Redirects
  • CRM.Commerce.Carts
  • CRM.Commerce.Descontos
  • CRM Commerce Encargos
  • CRM. Comércio.Faturas
  • CRM.Commerce.Pedidos
  • CRM.Commerce.Cotações
  • CRM.Commerce.Subscrições
  • CRM. Commerce.Impostos
  • CRM. Compromissos.Chamadas
  • CRM. Compromissos.Comunicações
  • CRM. Engajamentos.E-mails
  • CRM. Compromissos.Reuniões
  • CRM. Compromissos.Notas
  • CRM.Engagements.Postal_Mail
  • CRM. Compromissos.Tarefas
  • CRM. Objetos.Empresas
  • CRM.Objetos.Contatos
  • CRM.Objetos.Negócios
  • CRM. Objects.Feedback_Submissions
  • CRM.Objects.Goal_Targets
  • CRM.Entidades.Contactos
  • CRM. Objects.Line_Items
  • CRM.Objetos.Produtos
  • CRM.Objetos.Tickets
  • CRM.Proprietários

Propriedades da atividade Copy

Para obter uma lista completa de seções e propriedades disponíveis para definir atividades, consulte o artigo Pipelines . Esta seção fornece uma lista de propriedades suportadas pela origem do HubSpot.

HubspotSource como fonte

Para copiar dados do HubSpot, defina o tipo de origem na atividade de cópia como HubspotSource. As seguintes propriedades são suportadas na seção de origem da atividade de cópia:

Property Descrição Obrigatório
tipo A propriedade type da fonte de atividade de cópia deve ser definida como: HubspotSource Sim
consulta Use a consulta SQL personalizada para ler dados. Por exemplo: "SELECT * FROM Companies where Company_Id = xxx". Não (se "tableName" no conjunto de dados for especificado)

Observação

query não é suportado na versão 2.0.

Exemplo:

"activities":[
    {
        "name": "CopyFromHubspot",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<HubSpot input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "HubspotSource",
                "query": "SELECT * FROM Companies where Company_Id = xxx"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Mapeamento de tipo de dados para HubSpot

Quando você copia dados do HubSpot, os mapeamentos a seguir se aplicam dos tipos de dados do HubSpot aos tipos de dados internos usados pelo serviço. Para saber como a atividade de cópia mapeia o esquema de origem e o tipo de dados para o destino, consulte Mapeamentos de esquema e tipo de dados.

Tipo de dados HubSpot Tipo de dados de serviço provisório (para a versão 2.0) Tipo de dados de serviço provisório (para a versão 1.0)
bool booleano booleano
Booleano booleano booleano
enumeração Cordão Cordão
cadeia (de caracteres) Cordão Cordão
object_coordinates Cordão Cordão
número de telefone Cordão Cordão
Json Cordão Cordão
date DateTime Não suportado.
datetime DateTime DateTime
número Decimal Decimal
número inteiro Número inteiro Número inteiro
objecto Cordão Não suportado.

Propriedades da atividade de pesquisa

Para saber detalhes sobre as propriedades, verifique Atividade de pesquisa.

Ciclo de vida e atualização do conector HubSpot

A tabela a seguir mostra o estágio de liberação e os logs de alteração para diferentes versões do conector HubSpot:

Versão Fase de lançamento Registo de alterações
Versão 1.0 Removed Não aplicável.
Versão 2.0 Disponibilidade geral • O tableName valor é <HubSpot Category>.<Sub Category>.<Object Name>, por exemplo: CRM.Commerce.Discounts.

• data é lida como tipo de dados DateTime.

• objeto é lido como tipo de dados String.

useEncryptedEndpoints, useHostVerification, usePeerVerification não são suportados no serviço ligado.

query• não é suportado.

• Suporte a tabelas específicas da HubSpot. Para a lista de tabelas suportadas, vá para Propriedades do conjunto de dados.

Atualize o conector HubSpot da versão 1.0 para a versão 2.0

  1. Na página Editar serviço vinculado , selecione a versão 2.0 e configure o serviço vinculado consultando as propriedades do serviço vinculado versão 2.0.

  2. O mapeamento do tipo de dados para o serviço vinculado do HubSpot versão 2.0 é diferente do da versão 1.0. Para saber o mapeamento de tipo de dados mais recente, consulte Mapeamento de tipo de dados para o HubSpot.

  3. query só é suportado na versão 1.0. Você deve usar o tableName em vez de query na versão 2.0.

  4. Observe que a versão 2.0 suporta tabelas específicas do HubSpot. Para a lista de tabelas suportadas, vá para Propriedades do conjunto de dados.

Para obter uma lista de armazenamentos de dados suportados como fontes e coletores pela atividade de cópia, consulte Armazenamentos de dados suportados.