Configure o Openflow Connector for LinkedIn Ads

Nota

O conector está sujeito aos termos do conector.

Este tópico descreve as etapas para configurar o Openflow Connector for LinkedIn Ads.

Pré-requisitos

  1. Certifique-se de ter revisado Sobre a Openflow Connector for LinkedIn Ads.

  2. Certifique-se de ter seguido as etapas em Configuração do Openflow - BYOC ou Configuração do Openflow - Implantação do Snowflake - Visão geral da tarefa.

Obtenha as credenciais

  1. Como usuário do LinkedIn Ads, execute as seguintes tarefas:

    1. Opcional: se você não tiver uma conta de anúncios para executar e gerenciar campanhas, crie uma.

    2. Certifique-se de que a conta de usuário tenha pelo menos uma função VIEWER na conta do anúncio.

    3. Use a conta de usuário para solicitar o acesso à Advertising API. Para obter mais informações, consulte o guia de início rápido da Microsoft.

    4. Obtenha um token de atualização. Use 3-legged oAuth e o escopo r_ads_reporting.

    5. Obtenha o ID e o segredo do cliente no portal do desenvolvedor do LinkedIn. Essas credenciais estão disponíveis na guia Auth em App Details.

Configure a conta Snowflake

Como administrador de conta Snowflake, execute as seguintes tarefas:

  1. Crie uma nova função ou use uma função existente.

  2. Crie um novo usuário de serviço Snowflake com o tipo SERVICE.

  3. Conceda ao usuário do serviço Snowflake a função que você criou nas etapas anteriores.

  4. Configure com a autenticação de pares de chaves para o usuário do Snowflake SERVICE da etapa 2.

  5. A Snowflake recomenda enfaticamente essa etapa. Configure um gerenciador de segredos compatível com o Openflow, por exemplo, AWS, Azure e Hashicorp, e armazene as chaves públicas e privadas no armazenamento de segredos.

    Nota

    Se, por algum motivo, você não quiser usar um gerenciador de segredos, será responsável por proteger os arquivos de chave pública e chave privada usados para autenticação de pares de chaves de acordo com as políticas de segurança de sua organização.

  6. Depois que o gerenciador de segredos estiver configurado, determine como você se autenticará nele. No AWS, é recomendável que você use a função de instância EC2 associada ao Openflow, pois dessa forma nenhum outro segredo precisa ser mantido.

  7. No Openflow, configurar um provedor de parâmetros associado a este Secrets Manager, a partir do menu de configuração no canto superior direito. Navegue até Controller Settings » Parameter Provider e depois buscar seus valores de parâmetro.

  8. Nesse momento, todas as credenciais podem ser referenciadas com os caminhos de parâmetros associados e nenhum valor sensível precisa ser mantido no Openflow.

  9. Se qualquer outro usuário Snowflake precisar de acesso aos documentos e tabelas brutos ingeridos pelo conector (por exemplo, para processamento personalizado no Snowflake), conceda a esses usuários a função criada na etapa 1.

  10. Crie um banco de dados e um esquema no Snowflake para que o conector armazene os dados ingeridos. Conceda os Privilégios de banco de dados necessários para a função criada na primeira etapa. Substitua o espaço reservado para a função pelo valor real e use os seguintes comandos SQL:

    CREATE DATABASE linkedin_destination_db;
    CREATE SCHEMA linkedin_destination_db.linkedin_destination_schema;
    GRANT USAGE ON DATABASE linkedin_destination_db TO ROLE <linkedin_connector_role>;
    GRANT USAGE ON SCHEMA linkedin_destination_db.linkedin_destination_schema TO ROLE <linkedin_connector_role>;
    GRANT CREATE TABLE ON SCHEMA linkedin_destination_db.linkedin_destination_schema TO ROLE <linkedin_connector_role>;
    
    Copy
  11. Crie um warehouse que será usado pelo conector ou use um já existente. Comece com o menor tamanho de warehouse e, em seguida, experimente o tamanho, dependendo do número de tabelas sendo replicadas e da quantidade de dados transferidos. Os números de tabelas grandes normalmente são mais bem dimensionados com warehouses multicluster, em vez de warehouses maiores.

  12. Certifique-se de que o usuário com a função usada pelo conector tenha os privilégios necessários para usar o warehouse. Se esse não for o caso, conceda os privilégios necessários à função.

    CREATE WAREHOUSE linkedin_connector_warehouse WITH WAREHOUSE_SIZE = 'X-Small';
    GRANT USAGE ON WAREHOUSE linkedin_connector_warehouse TO ROLE <linkedin_connector_role>;
    
    Copy

Configuração do conector

Como engenheiro de dados, execute as seguintes tarefas para instalar e configurar o conector:

Instalação do conector

  1. Crie um banco de dados e um esquema no Snowflake para que o conector armazene os dados ingeridos. Conceda os Privilégios de banco de dados necessários para a função criada na primeira etapa. Substitua o espaço reservado para a função pelo valor real e use os seguintes comandos SQL:

    CREATE DATABASE DESTINATION_DB;
    CREATE SCHEMA DESTINATION_DB.DESTINATION_SCHEMA;
    GRANT USAGE ON DATABASE DESTINATION_DB TO ROLE <CONNECTOR_ROLE>;
    GRANT USAGE ON SCHEMA DESTINATION_DB.DESTINATION_SCHEMA TO ROLE <CONNECTOR_ROLE>;
    GRANT CREATE TABLE, CREATE PIPE ON SCHEMA DESTINATION_DB.DESTINATION_SCHEMA TO ROLE <CONNECTOR_ROLE>;
    
    Copy
  1. Navegue até a página Visão geral do Openflow. Na seção Featured connectors, selecione View more connectors.

  2. Na página de conectores do Openflow, localize o conector e selecione Add to runtime.

  3. Na caixa de diálogo Select runtime, selecione seu tempo de execução na lista suspensa Available runtimes.

  4. Selecione Add.

    Nota

    Antes de instalar o conector, verifique se você criou um banco de dados e um esquema no Snowflake para que o conector armazene os dados ingeridos.

  5. Autentique-se na implementação com as credenciais de sua conta Snowflake e selecione Allow quando solicitado para permitir que o aplicativo de tempo de execução acesse sua conta Snowflake. O processo de instalação do conector leva alguns minutos para ser concluído.

  6. Autentique-se no tempo de execução com as credenciais de sua conta Snowflake.

A tela do Openflow é exibida com o grupo de processos do conector adicionado a ela.

Configuração do conector

Nota

Cada grupo de processos é responsável pela obtenção de dados para uma única configuração de relatório. Para usar várias configurações em um cronograma regular, crie um grupo de processos separado para cada configuração de relatório.

  1. Clique com o botão direito do mouse no grupo de processos importado e selecione Parameters.

  2. Preencha os valores dos parâmetros necessários conforme descrito em Parâmetros de fluxo.

Parâmetros de fluxo

Esta seção descreve os parâmetros de fluxo que podem ser configurados com base nos contextos de parâmetros a seguir:

Parâmetros de origem do Linkedin Ads

Parâmetro

Descrição

ID do cliente

O ID de cliente de um aplicativo registrado no LinkedIn

Segredo do cliente

O segredo do cliente relacionado ao ID de cliente

Token de atualização

Um usuário obtém o token de atualização após o processo de registro do aplicativo. Eles o utilizam junto com o ID de cliente e o segredo do cliente para obter um token de acesso.

Ponto de extremidade de token

O ponto de extremidade do token é obtido por um usuário durante o processo de registro do aplicativo

Parâmetros de destino do Linkedin Ads

Parâmetro

Descrição

Obrigatório

Banco de dados de destino

O banco de dados onde os dados serão persistidos. Ele já deve existir no Snowflake. O nome diferencia maiúsculas de minúsculas. Para identificadores sem aspas, forneça o nome em maiúsculas.

Sim

Esquema de destino

O esquema onde os dados serão persistidos, que já deve existir no Snowflake. O nome diferencia maiúsculas de minúsculas. Para identificadores sem aspas, forneça o nome em maiúsculas.

Veja os exemplos a seguir:

  • CREATE SCHEMA SCHEMA_NAME ou CREATE SCHEMA schema_name: use SCHEMA_NAME

  • CREATE SCHEMA "schema_name" ou CREATE SCHEMA "SCHEMA_NAME": use schema_name ou SCHEMA_NAME, respectivamente

Sim

Identificador de conta Snowflake

Ao utilizar:

  • Session Token Authentication Strategy: deve ficar em branco.

  • KEY_PAIR: nome da conta Snowflake formatado como [nome-da-organização]-[nome-da-conta], onde os dados serão persistentes.

Sim

Estratégia de autenticação Snowflake

Ao utilizar:

  • Implantação do Snowflake Openflow: Use SNOWFLAKE_SESSION_TOKEN. Esse token é gerenciado automaticamente pelo Snowflake.

  • BYOC: use KEY_PAIR como o valor para a estratégia de autenticação.

Sim

Chave privada Snowflake

Ao utilizar:

  • Session Token Authentication Strategy: deve ficar em branco.

  • KEY_PAIR: deve ser a chave privada RSA utilizada para a autenticação.

    A chave RSA deve ser formatada de acordo com os padrões PKCS8 e têm os cabeçalhos e rodapés PEM padrão. Observe que ou o arquivo de chave privada do Snowflake ou a chave privada do Snowflake deve ser definido.

Não

Arquivo de chave privada Snowflake

Ao utilizar:

  • Estratégia de autenticação de token de sessão: o arquivo de chave privada deve estar em branco.

  • KEY_PAIR: carregue o arquivo que contém a chave privada RSA usada para autenticação no Snowflake, formatado de acordo com os padrões PKCS8 e incluindo cabeçalhos e rodapés PEM padrão. A linha do cabeçalho começa com -----BEGIN PRIVATE. Para carregar o arquivo de chave privada, marque a caixa de seleção Reference asset.

Não

Senha de chave privada Snowflake

Ao usar

  • Session Token Authentication Strategy: deve ficar em branco.

  • KEY_PAIR: forneça a senha associada ao arquivo de chave privada do Snowflake.

Não

Função Snowflake

Ao usar

  • Estratégia de autenticação de tokens de sessão: use sua função de tempo de execução. Você pode encontrar sua função de tempo de execução na UI do Openflow, navegando para View Details no seu tempo de execução.

  • Estratégia de autenticação de KEY_PAIR: use uma função válida configurada para o usuário do seu serviço.

Sim

Nome de usuário do Snowflake

Ao usar

  • Session Token Authentication Strategy: deve ficar em branco.

  • KEY_PAIR: forneça o nome de usuário usado para se conectar à instância do Snowflake.

Sim

Warehouse Snowflake

Warehouse Snowflake usado para executar consultas.

Sim

Parâmetros de ingestão do Linkedin Ads

A tabela a seguir lista os parâmetros que não são herdados de outros contextos de parâmetro:

Parâmetro

Descrição

Nome do relatório

O nome exclusivo do relatório. Ele está em letras maiúsculas e é usado como o nome da tabela de destino.

Data de início

Data de início da ingestão. Deve estar no formato aaaa-MM-dd.

Granularidade de tempo

Granularidade temporal dos resultados. Possíveis valores:

  • ALL: resultados agrupados em um único resultado em todo o intervalo de tempo do relatório.

  • DAILY: resultados agrupados por dia.

  • MONTHLY: resultados agrupados por mês.

  • YEARLY: resultados agrupados por ano.

Janela de conversão

O período de tempo para o qual os dados são atualizados durante a carga incremental quando a granularidade de tempo DAILY é escolhida. Por exemplo, se a janela de conversão for igual a 30 dias, durante a carga INCREMENTAL, a ingestão começa a partir da data da última ingestão bem-sucedida menos 30 dias.

Obrigatório quando a granularidade de tempo DAILY é especificada. Para outras granularidades de tempo possíveis, como ALL, MONTHLY e YEARLY, a estratégia de ingestão SNAPSHOT é usada. Os dados da data de início até o presente são sempre baixados; portanto, não há necessidade de usar uma janela de conversão.

A janela de conversão pode ser qualquer número de 1 a 365.

Métricas

Lista de métricas separadas por vírgulas. As métricas diferenciam maiúsculas de minúsculas. Para obter mais informações, consulte Relatórios.

As métricas pivotValues e dateRange são obrigatórias e são incluídas automaticamente pelo conector.

Até 20 métricas podem ser especificadas, incluindo as métricas obrigatórias.

Pivôs

Lista de pivôs separada por vírgulas. Os pivôs disponíveis são os seguintes:

O conector usa o Localizador de análises quando zero ou um pivô é especificado e alterna para o Localizador de estatísticas quando dois ou três pivôs são selecionados. Você pode usar no máximo três pivôs.

Compartilhamentos

Lista de IDs de compartilhamentos separada por vírgulas. Este parâmetro pode ser usado para filtrar os resultados por ID de compartilhamento.

Campanhas

Lista de IDs de campanhas separada por vírgulas. Este parâmetro pode ser usado para filtrar os resultados por ID de campanha.

Grupos de campanha

Lista de IDs de grupos de campanhas separada por vírgulas. Este parâmetro pode ser usado para filtrar os resultados por ID de grupo de campanhas.

Contas

Lista de IDs de contas separada por vírgulas. Este parâmetro pode ser usado para filtrar os resultados por ID de conta.

Empresas

Lista de IDs de empresas separada por vírgula. Este parâmetro pode ser usado para filtrar resultados por ID de empresa.

Nota

Você deve especificar pelo menos um dos filtros, ou seja, compartilhamentos, campanhas, grupos de campanha, contas ou empresas.

Execute o fluxo

  1. Clique com o botão direito do mouse no plano e selecione Enable all Controller Services.

  2. Clique com o botão direito do mouse no grupo de processos importado e selecione Start.

    O conector inicia a ingestão de dados.