Como compartilhar dados por um hub de ações

Além de enviar conteúdo para os destinos integrados do Looker, você pode usar ações, também chamadas de integrações, para enviar conteúdo a serviços de terceiros integrados ao Looker por um servidor de hub de ações.

Nesta página, você vai conhecer as opções de criação de ações personalizadas que podem ser adicionadas ao Hub de ações do Looker ou ao seu próprio servidor privado de hub de ações. Esta página também descreve como iniciar um servidor local do hub de ações para testar suas ações personalizadas ou executar um servidor privado do hub de ações.

Para começar a usar as ações, você pode:

Depois que a ação for adicionada ao hub, um administrador do Looker poderá ativá-la para enviar conteúdo do Looker a esses serviços.

Também é possível configurar vários hubs de ações se você quiser usar as integrações do Looker pelo Hub de Ações do Looker e hospedar suas próprias ações privadas ou personalizadas. As ações de cada hub de ações aparecem na página Ações do painel Administrador.

Looker Action Hub

O Looker hospeda e fornece a central de ações do Looker, um servidor sem estado que implementa a API Action do Looker e expõe ações populares. Todos os dados que seus usuários enviam usando uma ação são processados temporariamente no servidor do Looker Action Hub, em vez de na sua instância do Looker.

O Looker já está integrado a vários serviços. Consulte a página de documentação Configurações de administrador: ações para saber como ativar esses serviços.

Requisitos do Looker Action Hub

O Looker Action Hub precisa enviar e receber solicitações de API das seguintes maneiras:

Se a implantação do Looker não puder acomodar essas solicitações ou se o recurso Lista de permissões de IP estiver ativado na instância do Looker, configure um servidor do hub de ações locais para veicular integrações ou ações personalizadas particulares do Looker. Os administradores de instâncias hospedadas pelo cliente também podem implantar um servidor de ações local especificamente para OAuth e ações de streaming.

Solicitações da instância do Looker para a rede do Hub de ações do Looker

As solicitações para actions.looker.com são resolvidas para um endereço IP dinâmico. As solicitações de saída da instância do Looker precisam alcançar os seguintes endpoints:

actions.looker.com/
actions.looker.com/actions/<name>/execute
actions.looker.com/actions/<name>/form

em que name é o nome programático da ação.

Solicitações do navegador do usuário do Looker para a rede do hub de ações do Looker

O navegador do usuário do Looker precisa fazer solicitações para os seguintes endpoints do Hub de Ações do Looker (para OAuth):

actions.looker.com/actions/<name>/oauth

em que name é o nome programático da ação.

Solicitações da rede do Looker Action Hub para a instância do Looker

O Looker Action Hub precisa fazer solicitações à instância do Looker para ações que ofereçam suporte aos resultados de streaming ou que usem OAuth.

Uma ação de streaming permite que ela consuma consultas que entregam Todos os resultados. As ações ativadas para OAuth usam autenticação por usuário nos fluxos do OAuth 2.0. As ações do OAuth precisam armazenar as credenciais do usuário na instância de origem do Looker porque o Hub de Ações do Looker é sem estado e multissetorial e não armazena credenciais específicas do usuário de nenhum tipo.

As solicitações da central de ações do Looker para uma instância do Looker têm os seguintes formatos:

GET <host_looker_url>/downloads/<random_40_char_token>
POST <host_looker_url>/action_hub_state/<random_40_char_token>

Esses URLs são gerados na hora na instância do Looker antes de serem enviados ao Looker Action Hub. Por esse motivo, o Hub de Ações do Looker precisa resolver o <host_looker_url> em um endereço IP e fazer solicitações na rede em que a instância do Looker está.

O Hub de Ação do Looker tem endereços IP de saída estáticos de onde as solicitações sempre vêm: 35.153.89.114, 104.196.138.163 e 35.169.42.87. Os administradores de instâncias hospedadas pelo Looker que ativaram a lista de permissões de IP precisam adicionar esses endereços para usar ações que oferecem suporte a resultados transmitidos em streaming ou que usam OAuth.

Considerações para instâncias hospedadas pelo cliente

Para usar as integrações do Looker, o hub de ações do Looker precisa se comunicar com a instância do Looker e atender aos requisitos do hub de ações do Looker. Isso nem sempre é possível com instâncias do Looker hospedadas pelo cliente, por vários motivos. Se não for possível estabelecer comunicação bidirecional entre o Looker Action Hub e a instância do Looker, ele poderá apresentar comportamentos inesperados ou indesejáveis, como consultas pendentes ou ações indisponíveis.

Para resolver o possível problema de o Hub de Ações do Looker não conseguir se comunicar com a instância do Looker, os administradores do Looker podem implementar uma das soluções mostradas mais adiante nesta página. A solução ou combinação de soluções adequadas vai depender da arquitetura da instância do Looker:

  • Se a instância hospedada pelo cliente não puder ser resolvida pelo Looker Action Hub, ou seja, o Looker Action Hub não pode receber solicitações da instância do Looker, os administradores do Looker poderão entrar em contato com um especialista em vendas do Google Cloud para ativar o recurso de licença public_host_url. Esse recurso de licença revela a opção de inicialização --public-host-url, que permite que os administradores especifiquem um nome de host <public_host_url> solucionável diferente da instância <host_looker_url>. O public_host_url substitui o nome do host de alguns URLs de callback específicos do Looker Action Hub e os encaminha por um proxy reverso que tem o public_host_url como um nome publicamente solucionável. Esse proxy reverso aceita solicitações apenas dos endereços IP de saída estáticos do Hub de ações do Looker. Os administradores do Looker que usam esse método precisam adicionar à lista de permissões os endereços IP de saída de onde o Hub de ações do Looker faz solicitações para a instância do Looker: 35.153.89.114, 104.196.138.163 e 35.169.42.87.

  • Se o URL da instância hospedada pelo cliente for resolvido pela instância do Looker, mas o Hub de ações do Looker não conseguir enviar solicitações para a instância, os usuários não poderão configurar ou usar ações que ofereçam suporte a resultados transmitidos por streaming ou que usem OAuth. Para resolver isso, os administradores do Looker precisam adicionar à lista de permissões os endereços IP de saída de onde o Looker Action Hub faz solicitações à instância do Looker: 35.153.89.114, 104.196.138.163 e 35.169.42.87.

  • Se nenhuma das soluções mencionadas for adequada para a arquitetura da instância do Looker, os administradores do Looker poderão implantar um hub de ações hospedado pelo cliente para todas as ações ou apenas para aquelas que oferecem suporte a resultados transmitidos em streaming ou que usam OAuth.

  • Para implantar um hub de ações hospedado pelo cliente, é necessário garantir que o arquivo JAR seja hospedado em um servidor público para que o hub de ações do Looker possa se comunicar com ele. No entanto, essa solução não é recomendada.

Além disso, as ações de OAuth e streaming podem não ser usadas em uma instância do Looker hospedada pelo cliente se ela usar um certificado SSL emitido por uma autoridade certificadora (AC) que não está nesta lista de certificados raiz.

Como criar uma ação personalizada

Nesta seção, descrevemos as etapas para criar e testar uma ação personalizada usando o código-fonte do Looker Action Hub. Para ver exemplos de código funcional, verifique as ações existentes no repositório looker-open-source/actions (em inglês) no GitHub.

Para criar uma ação personalizada:

  1. Como configurar um repositório de desenvolvimento
  2. Escrever sua ação
  3. Como testar sua ação
  4. Publicar e ativar sua ação no Looker Action Hub ou no seu próprio servidor particular

Como em qualquer ação, talvez seja necessário configurar seus modelos do LookML com parâmetros específicos antes de usar a ação para entregar seus dados.

Como configurar um repositório de desenvolvimento

O Hub de ações do Looker é um servidor Node.js escrito em TypeScript, uma pequena camada sobre o JavaScript moderno que adiciona informações de tipo para ajudar a detectar erros de programação. Se você já conhece o JavaScript, a maioria do TypeScript também será familiar.

A execução do Looker Action Hub requer o seguinte software:

  • Node.js
  • Gerenciador de versões de nó (NVM, para selecionar a versão correta do Node.js)
  • Yarn (para gerenciar dependências)

Depois de instalar o software necessário, você já pode configurar seu ambiente de desenvolvimento. O exemplo a seguir usa o Git.

  1. Clone o repositório looker-open-source/actions localmente:

    git clone git@github.com:looker-open-source/actions.git

  2. Crie um diretório com o nome da sua ação no diretório actions/src/actions. Exemplo:

    mkdir actions/src/actions/my_action

  3. Comece a preencher o diretório com os arquivos necessários para executar a ação. Consulte o repositório do GitHub de ações (link em inglês) para conferir um exemplo de estrutura de arquivos.

O Looker recomenda que você também adicione o seguinte:

  • Um README para explicar o propósito e os meios de autenticação da ação
  • Um ícone PNG para exibição no Hub de ações do Looker (ou Hub de ações particular na sua instância do Looker) e nas janelas de envio de dados do Looker
  • Qualquer arquivo de testes que você quer executar no código de ação. Isso é diferente de testar sua ação.

Escrever uma ação

Um requisito de design para o servidor do Looker Action Hub é que ele permaneça completamente sem estado. Portanto, não é permitido armazenar informações no aplicativo ou serviço de ação. Todas as informações necessárias para atender à ação precisam ser fornecidas nas chamadas de solicitação do arquivo de ação.

O conteúdo exato do arquivo de ação varia de acordo com o serviço, o tipo ou o nível em que a ação opera e quais formatos de dados ou visualização precisam ser especificados. A ação também pode ser configurada para fluxos de autorização do OAuth 2.0.

Os arquivos de ação são baseados no método da API /execute. As solicitações da API Looker recebem um DataActionRequest sempre que um usuário executa a ação no Looker. O DataActionRequest contém todos os dados e metadados necessários para executar a ação. Também há um método /form disponível, que pode ser usado para coletar mais informações do usuário antes que ele execute a ação. Os campos especificados em /form serão exibidos no pop-up Enviar ou Programar quando os usuários selecionarem a ação como destino para a entrega de dados.

Ao escrever o arquivo de ação, inclua pelo menos os seguintes parâmetros marcados como Obrigatório na definição de ação:

Parâmetro Obrigatório Descrição Tipo de dado
name Sim Um nome exclusivo para a ação. Ele precisa ser exclusivo em todas as ações no Looker Action Hub. string
url Sim Um URL absoluto do endpoint /execute para essa ação. string
label Sim Um rótulo legível para a ação. string
supportedActionTypes Sim Uma lista de tipos de ações com suporte. Os valores válidos são "cell", "query" e "dashboard". string
formURL Não Um URL absoluto do endpoint /form para essa ação. string
description Não Descrição da ação. string
params Não Matriz de parameters para a ação. Inclua o nome, o rótulo e a descrição no formato de string de cada parâmetro. Esses são os campos que aparecem na página de ativação da ação no painel Administrador. Se quiser gerenciar como os usuários enviam dados para um destino de ação, especifique um atributo de usuário que tenha um valor definido. parameters
supportedFormats Não Uma lista de formatos de dados aceitos pela ação. Os valores válidos são: "txt", "csv", "inline_json", "json" e "json_detail", "json_detail_lite_stream", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", and "wysiwyg_png".. string
supportedFormattings Não Uma lista de opções de formatação compatíveis com a ação. Os valores válidos são: "formatted" e "unformatted". string
supportedVisualizationFormattings Não Uma lista de opções de formatação de visualização compatíveis com a ação. Os valores válidos são: "apply" e "noapply". string
iconName Não Um URI de dados que representa uma imagem de ícone para a ação. string
requiredFields Não Uma lista de descrições dos campos obrigatórios compatíveis com essa ação. Se houver várias entradas nessa lista, a ação vai exigir mais de um campo. RequiredField
supportedDownloadSettings Não Um booleano que determina se a ação vai receber um URL de download de uso único para facilitar o streaming ilimitado de dados. O parâmetro é definido pelo parâmetro usesStreaming, que é um booleano true/false. Se for usesStreaming = true, então supportedDownloadSettings = url. Se usesStreaming = false, então supportedDownloadSettings = push. Booleano
usesOAuth Não Um booleano que determina se a ação é do OAuth. Isso vai determinar se a ação vai receber um link de uso único para definir state para um usuário específico. Booleano
usesStreaming Não Um booleano que determina se a ação oferece suporte aos resultados da consulta de streaming. Marque a coluna Usar streaming de dados (Sim/Não) na lista de serviços integrados. As ações que transmitem resultados podem exigir a configuração de um servidor de hub de ações local. Consulte a página de práticas recomendadas Configurar um hub de ações local para ações que usam OAuth ou streaming para mais informações. Booleano
minimumSupportedVersion Não A versão mínima do Looker em que a ação vai aparecer na lista da central de ações do painel Administrador. string

Exemplos das ações do Looker Action Hub estão no GitHub para referência.

Tipos de ação aceitos

O Looker oferece suporte a três tipos de ações, conforme especificado no parâmetro supportedActionTypes da ação: consulta, célula e painel.

  • Uma ação no nível da consulta: é uma ação que envia uma consulta inteira. A ação de segmento, por exemplo, é uma ação no nível da consulta.
  • Uma ação no nível da célula: uma ação no nível da célula envia o valor de uma única célula específica em uma tabela de dados. Esse tipo de ação é diferente das ações de dados, que podem ser definidas para dimensões ou medidas usando o parâmetro action. Para enviar informações de uma célula específica de uma tabela, o Looker usa tags para mapear ações para as células correspondentes. As ações precisam especificar para quais tags elas são compatíveis no requiredFields. Para mapear ações e campos, os campos no LookML precisam especificar para quais tags eles são mapeados com o parâmetro tags do LookML. Por exemplo, a ação do Twilio Message usa uma tag phone para que os desenvolvedores do LookML possam controlar em quais campos de número de telefone a ação do Twilio aparecerá.
  • Uma ação no nível do painel:permite o envio da imagem de um painel. Por exemplo, a ação do SendGrid envia imagens do painel por e-mail.

Adicionar atributos do usuário a ações personalizadas

Para ações personalizadas, adicione atributos de usuário no parâmetro params do seu arquivo de ação. Se o parâmetro for obrigatório, cada usuário precisará ter um valor para esse atributo definido na conta de usuário ou em um grupo de usuários ao qual pertence, além da permissão send_to_integration, para que a ação seja exibida como uma opção de destino ao enviar ou programar conteúdo.

Para adicionar um atributo do usuário à sua ação:

  1. Um administrador do Looker pode precisar criar o atributo de usuário que corresponde ao user_attribute_param, se ele ainda não existir.
  2. Defina um valor válido para o atributo de usuário dos usuários ou grupos de usuários que precisam enviar conteúdo para o destino da ação. Esses usuários também precisam ter permissões send_to_integration.
  3. O parâmetro params representa os campos do formulário que um administrador do Looker precisa configurar na página de ativação da ação na lista Ações do painel Administrador. No parâmetro params do seu arquivo de ação, inclua o seguinte:
  params = [{
    description: "A description of the param.",
    label: "A label for the param.",
    name: "action_param_name",
    user_attribute_name: "user_attribute_name",
    required: true,
    sensitive: true,
  }]

em que user_attribute_name é o atributo do usuário definido no campo Nome na página Atributos do usuário na seção Usuários do painel Administrador. required: true significa que um usuário precisa ter um valor válido e não nulo definido para esse atributo para ver a ação quando os dados estão sendo enviados. sensitive: true significa que o atributo do usuário é criptografado e nunca é exibido na interface do Looker depois de ser inserido. É possível especificar vários subparâmetros de atributos do usuário.

  1. Implante as atualizações no servidor do Action Hub.
    • Se você estiver adicionando uma ação, um administrador do Looker vai precisar ativar a ação clicando no botão Ativar ao lado da ação na página Ações no painel Administrador.
    • Se você estiver atualizando uma ação, clique no botão Atualizar para atualizar a lista de ações. Em seguida, clique no botão Configurações.
  2. Na página de ativação/configuração da ação, um administrador do Looker precisa configurar os campos do formulário da ação para extrair informações do atributo do usuário. Para isso, clique no ícone do atributo do usuário à direita do campo apropriado e selecione o atributo desejado.

Parâmetros requiredField em ações no nível da célula

Para ações no nível da célula, é possível configurar os campos do LookML do modelo para enviar dados ao destino da ação especificando quais tags são compatíveis com a ação no parâmetro requiredFields do arquivo de ação.

Parâmetro Obrigatório Descrição Tipo de dados
tag Não Se presente, corresponde a um campo que tem essa tag. string
any_tag Não Se presente, substitui tag e corresponde a um campo que tem qualquer uma das tags fornecidas. string
all_tags Não Se presente, substitui tag e corresponde a um campo com todas as tags fornecidas. string

Formatos de dados compatíveis

A classe DataActionRequest define qual formato de entrega de dados está disponível para a ação. Para ações no nível da consulta, a solicitação contém um anexo que pode estar em vários formatos. A ação pode especificar um ou mais supportedFormats ou permitir que o usuário escolha o formato especificando todos os formatos possíveis. Para ações no nível da célula, o valor da célula vai estar presente em DataActionRequest.

Como configurar uma ação para o OAuth

Você pode configurar sua ação para que os usuários possam se autenticar na ação com OAuth. Embora o Looker Action Hub precise permanecer sem estado, é possível aplicar um estado usando uma solicitação de formulário da API Looker Action.

Fluxo OAuth da ação do Looker

Para ações no Hub de Ações do Looker, você pode estender um OAuthAction em vez de um Hub.Action para definir um booleano que indique quais métodos OAuth são necessários para autenticar um usuário em uma ação. Para cada ação ativada para OAuth ou com estado, o Looker armazena um estado por ação por usuário, de modo que cada ação e combinação de usuários tenha um evento OAuth independente.

O fluxo para criar ações geralmente envolve uma solicitação /form seguida por uma /execute. Para OAuth, a solicitação /form precisa ter um método para determinar se o usuário está autenticado no serviço de destino. Se o usuário já estiver autenticado, a ação vai retornar um /form normal de acordo com o que a solicitação /execute exigir. Se o usuário não estiver autenticado, a ação retornará um link que inicializará um fluxo do OAuth.

Como salvar o estado com o URL do OAuth

O Looker vai enviar uma solicitação POST HTTP com um corpo vazio para o endpoint ActionList. Se a ação retornar uses_oauth: true na definição, uma state_url de uso único será enviada em cada solicitação /form do Looker. O state_url é um URL especial de uso único que define o estado de um usuário para uma determinada ação.

Se o usuário não estiver autenticado com o endpoint, o /form retornado precisará conter um form_field do tipo oauth_link que vai para o endpoint /oauth de uma ação. O state_url precisa ser criptografado e salvo como um parâmetro state no oauth_url retornado. Exemplo:

{
        "name": "login",
        "type": "oauth_link",
        "label": "Log in",
        "description": "OAuth Link",
        "oauth_url": "ACTIONHUB_URL/actions/my_action/oauth?state=encrypted_state_url"
}

Neste exemplo, o endpoint /oauth redireciona o usuário para o servidor de autenticação. O endpoint /oauth constrói o redirecionamento no método oauthUrl(...) em uma ação do OAuth, conforme mostrado no OauthUrl da caixa de depósito.

O parâmetro state que contém o state_url criptografado precisa ser transmitido ao Looker Action Hub.

Como salvar o estado com o URI de redirecionamento do hub de ações

No endpoint /oauth, um redirect_uri para o hub de ações também é criado e transmitido ao método oauthUrl(...) da ação. Esse redirect_uri está no formato /actions/src/actions/my_maction/oauth_redirect e é o endpoint usado se a autenticação retornar um resultado.

Esse endpoint vai chamar o método oauthFetchInfo(...), que precisa ser implementado pelo método OauthAction para extrair as informações necessárias e tentar receber ou salvar qualquer estado ou auth recebido do servidor de autenticação.

O state descriptografa o state_url criptografado e o usa para enviar state por POST de volta ao Looker. Na próxima vez que um usuário fizer uma solicitação para essa ação, o estado recém-salvo será enviado ao Hub de Ações do Looker.

Adicionando seus arquivos de ação ao repositório do Looker Action Hub

Depois que o arquivo de ação for escrito, no repositório do Looker Action Hub:

  1. Adicione o arquivo de ação (por exemplo, my_action.ts) a actions/src/actions/index.ts.

    import "./my_action/my_action.ts"

  2. Adicione todos os requisitos de pacote do Node.js que você usou na gravação da ação. Exemplo:

    yarn add aws-sdk
yarn add express

  3. Instale as dependências do Node.js do servidor do hub de ações do Looker.

    yarn install

  4. Execute todos os testes que você criou.

yarn test

Como testar uma ação

Para realizar o teste completo, é possível executar a ação na sua instância do Looker hospedando um servidor de hub de ação particular. Esse servidor precisa estar na Internet pública com um certificado SSL válido e ser capaz de iniciar e receber conexões ou solicitações HTTPS de e para o Looker. Para isso, você pode usar uma plataforma baseada na nuvem, como a Heroku, conforme mostrado no exemplo a seguir. Como alternativa, use qualquer plataforma que atenda aos requisitos mencionados acima.

Como configurar um servidor do hub de ações locais

Neste exemplo, vamos realizar a ação desenvolvida no repositório do GitHub looker-open-source/actions/src/actions e confirmar o código em um novo branch do Git. Recomendamos que você trabalhe em recursos usando ramificações para acompanhar seu código e, se quiser, criar facilmente um PR com o Looker.

  1. Para começar, crie sua ramificação e, em seguida, prepare e confirme seu trabalho. Exemplo:

    git checkout -b my-branch-name
git add file-names
git commit -m commit-message

  2. Neste exemplo, para enviar uma ramificação ao Heroku, configure o repositório do Git com o Heroku como uma opção remota na linha de comando:

    heroku login
heroku create
git push heroku

  3. O Heroku retornará o URL público que agora hospeda o hub de ações para seu uso. Acesse o URL ou execute heroku logs para confirmar se o hub de ações está em execução. Se você esquecer o URL público, execute o seguinte na linha de comando:

    heroku info -s | grep web_url

    O Heroku vai retornar seu URL público. Por exemplo: https://my-heroku-action-server-1234.herokuapp.com

  4. Na linha de comando, defina o URL base do hub de ações:

    heroku config:set ACTION_HUB_BASE_URL="https://my-heroku-action-server-1234.herokuapp.com"

  5. Defina o marcador do hub de ações:

    heroku config:set ACTION_HUB_LABEL="Your Action Hub"

  6. O Looker usa um token de autorização para se conectar ao hub de ações. Gere o token na linha de comando:

    heroku run yarn generate-api-key

    Se você não usar o Heroku, como estamos nesse exemplo, use:

    yarn generate-api-key

    O Heroku retornará seu token de autorização. Por exemplo: Authorization: Token token="abcdefg123456789"

  7. Defina o secret do hub de ações usando a chave secreta:

    heroku config:set ACTION_HUB_SECRET="abcdefg123456789"

    As implantações hospedadas pelo cliente podem exigir a configuração de variáveis de ambiente adicionais não documentadas aqui.

  8. Para adicionar a ação na instância local do Looker, acesse Administrador > Ações.

    • Na parte de baixo da lista de ações, clique em Adicionar hub de ações.
    • Insira o URL do Action Hub e, opcionalmente, uma chave secreta.
    • Encontre sua ação na lista Ações do menu Administrador do Looker.
    • Clique em Ativar.

Se a ação exigir que tipos específicos de dados sejam transmitidos do Looker, configure os modelos para incluir o parâmetro tags adequado.

Agora está tudo pronto para você testar sua ação.

Testar ações no nível do painel e da consulta

Na instância do Looker, configure o modelo do LookML com tags, se necessário. Crie e salve um Look. No Look salvo, clique no menu no canto superior direito e selecione Enviar com sua ação como destino. Se você tiver um formulário para entrega, o Looker vai renderizá-lo na janela Enviada.

Clique em Enviar teste para enviar os dados. O status da ação será exibido no Histórico do programador, no painel Administrador. Se encontrar um erro, ele vai aparecer no painel Administrador, e o Looker vai enviar um e-mail com a mensagem de erro para o usuário que enviou a ação.

Como testar ações no nível da célula

Configure um campo LookML com as tags adequadas para sua ação. Na sua instância do Looker, execute uma consulta que inclua esse campo. Encontre o campo na tabela de dados. Clique no … na célula e selecione Enviar no menu suspenso. Se você receber erros, será necessário fazer uma atualização completa na tabela de dados depois de resolvê-los.

Publicar e ativar uma ação personalizada

Há duas opções de publicação para ações personalizadas:

Depois que a ação for publicada, você poderá ativá-la na página Ações no painel Administrador.

Publicar no Looker Action Hub

Essa abordagem é a mais fácil e funciona para qualquer ação que você queira disponibilizar para quem usa o Looker.

Depois que sua ação for testada, envie um PR para o repositório looker-open-source/actions no GitHub.

  1. Digite este comando:

    git push <your fork> <your development branch>

  2. Crie sua solicitação de envio com o repositório looker-open-source/actions como destino.

  3. Preencha o Marketplace do Looker e Formulário de envio do hub de ações. Para mais informações sobre os requisitos do formulário, consulte Como enviar conteúdo para o Marketplace do Looker.

    O Looker vai analisar seu código de ação. Reservamo-nos o direito de recusar sua declaração de relações públicas, mas podemos ajudá-lo com quaisquer problemas que você tiver e oferecer sugestões de melhoria. Em seguida, mesclamos o código no repositório looker-open-source/actions e o implantamos no actions.looker.com. Depois que o código for implantado, ele vai estar disponível para todos os clientes do Looker.

  4. Ative a ação na sua instância do Looker para que ela apareça como uma opção de entrega de dados.

Como publicar em um servidor de hub de ações particular

Se você tiver ações personalizadas que são particulares da sua empresa ou do caso de uso, não adicione sua ação ao repositório looker-open-source/actions. Em vez disso, crie um hub de ações particular usando o mesmo framework Node.js usado para testar sua ação.

É possível configurar o servidor interno do hub de ações na própria infraestrutura ou em uma plataforma de aplicativos baseada na nuvem (nosso exemplo usou o Heroku). Não se esqueça de bifurcar o hub de ações do Looker para o servidor do hub de ações particulares antes da implantação.

Configurar um modelo do LookML para uso com uma ação

Para ações personalizadas e ações disponíveis no Hub de ações do Looker, é necessário identificar os campos de dados relevantes usando o parâmetro tags no modelo do LookML. A página Ações no painel Administrador mostra informações sobre as tags necessárias para o serviço, se houver.

Por exemplo, uma integração do Twilio Send Message envia uma mensagem para uma lista de números de telefone. Na página Ações do painel Administrador, a integração exibe o subtexto "A ação pode ser usada com consultas que têm um campo marcado com phone".

Isso significa que o serviço Twilio Send Message exige uma consulta que inclua um campo de número de telefone e que use o parâmetro tags para identificar qual campo na consulta contém números de telefone. Para identificar um campo de número de telefone no LookML, especifique tags: ["phone"] para esse campo. O LookML para um campo de número de telefone pode ser assim:

dimension: phone {
  tags: ["phone"]
  type: string
  sql: ${TABLE}.phone ;;
}

Uma integração que não exige tags mostra o subtexto "Ação pode ser usada com qualquer consulta" na página Ações do painel Administrador.

Identifique todos os campos obrigatórios no modelo do LookML com o parâmetro tags para que os usuários possam usar o serviço para enviar dados.

A seguir

Saiba como enviar o conteúdo de um Look ou uma Análise detalhada ou de um painel para um serviço integrado.