Como desenvolver uma visualização personalizada para o Marketplace do Looker

Esta página descreve como criar um tipo de visualização personalizada que pode ser adicionado ao Looker Marketplace e acessado por outros usuários do Looker. Também é possível criar uma visualização personalizada diretamente no seu projeto sem disponibilizá-la para outros clientes do Looker.

Você precisa ser membro da rede de parceiros do Looker ou cliente do Looker para enviar conteúdo ao Marketplace do Looker.

O Marketplace do Looker é um local central para encontrar, implantar e gerenciar muitos tipos de conteúdo do Looker, como blocos do Looker™, aplicativos, visualizações e outros plug-ins.

Com o recurso Marketplace do Looker ativado, os clientes podem instalar plug-ins do Marketplace do Looker, que incluem tipos de visualização para adicionar à biblioteca de visualização nativa do Looker.

Para desenvolver uma visualização personalizada e disponibilizá-la a todos os clientes do Looker pelo Marketplace, siga estas etapas:

  1. Desenvolver uma visualização.
  2. Crie um projeto do Looker para a visualização.
  3. Envie o projeto do Looker para um repositório Git.
  4. Teste a funcionalidade da visualização.
  5. Envie sua visualização para o Looker.

Como desenvolver um tipo de visualização

Identifique um tipo de visualização que você quer desenvolver. Confirme se essa visualização não está listada no Marketplace ou como uma visualização nativa do Looker.

Desenvolva sua visualização personalizada em JavaScript usando a API Looker Visualization com seu ambiente JavaScript.

Como criar um projeto do Looker para a visualização

Crie um projeto do Looker para representar sua visualização personalizada. O projeto precisa conter os seguintes arquivos:

  • Arquivo LICENSE: lista as licenças com que a visualização é distribuída, usando o texto:

    This Looker visualization is distributed with the following license:...

  • Arquivo README.md: fornece uma descrição da visualização, como ela funciona e outras informações.

  • Arquivo JavaScript (.js): contém uma versão condensada do código JavaScript usado para produzir a visualização. Com o Marketplace, os arquivos JS são incluídos no projeto, o que permite o gerenciamento adequado de versões e pacotes.

  • Arquivo de manifesto (manifest.lkml): especifica um id (um identificador exclusivo) e um label (exibido na interface do Looker para essa visualização). Exemplo:

    constant: vis_id {
        value: "default_id"
        export: override_optional
    }
    constant: vis_label {
        value: "default_label"
        export: override_optional
    }
    visualization: {
        id: "@{vis_id}"
        label: "@{vis_label}"
        file: "my_local.js"
        sri_hash: "my_sri_hash"
        dependencies: []
    }
  • Arquivo de listagem (marketplace.json): configura a listagem do Marketplace para a visualização personalizada e inclui um rótulo para mostrar como a visualização vai aparecer no Marketplace, o local do image_uri, um slogan que descreve o caso de uso da visualização e também define as constantes de campo do Marketplace que os usuários inserem durante a instalação. Exemplo:
{
  "label": "Gauge Visualization",
  "category_label": "plug-ins",
  "branding": {
    "image_uri": "https://marketplace-api.looker.com/visualization-screenshots/gauge_icon.png",
    "tagline": "Use the Gauge visualization to display a measure and progress to a goal."
  },
   "constants": {
        "vis_label": {
            "label": "Visualization Label",
            "description": "This label will appear in the visualization selector in the Looker Explore UI."
        },
        "vis_id": {
            "label": "Visualization Id",
            "description": "This must be a unique ID across all visualizations.",
            "value_constraint": "visualization"
        }
    }
}

Como enviar o projeto para o Git

Hospede o LookML da visualização em um repositório do GitHub acessível ao público. Supondo que você tenha criado a visualização em um projeto do Looker, siga estas etapas para enviar a um novo repositório:

  1. Crie um repositório do GitHub acessível ao público.
  2. Defina o URL do repositório do projeto do Looker como o URL do repositório do GitHub.
  3. Siga as instruções do Git no Looker para validar, confirmar e implantar seu código na produção.

Como testar a funcionalidade da visualização

Teste a nova visualização aplicando-a a uma Análise ou Visualização adequada na sua instância do Looker:

  1. Navegue até o Look ou a Análise.
  2. Se você estiver em um look, clique em Editar para fazer mudanças.
  3. Clique no menu de três pontos no menu de tipo de visualização para abrir a lista suspensa de visualizações.
  4. Selecione a visualização personalizada.
  5. Clique em Salvar para salvar a mudança no visual. Anote os painéis que podem ser afetados por essa mudança.

O Looker exige essas funções nas visualizações disponíveis no Marketplace do Looker:

Função Obrigatório
Suporte para detalhamento na visualização Sim
Capacidade de herdar as paletas de cores do Looker Sim
Responsividade ao navegador e ao tamanho da tela Sim
Família de fontes consistente: font-family: Helvetica, Arial, sans-serif Sim
Tamanho da fonte Sim
Opção de ativar e desativar os rótulos de valor e rótulos do eixo no painel de configuração da visualização Sim
Visualização de dados mestres Sim (quando aplicável)
Atualizações de visualização com base na interatividade do usuário usando a função updateAsync ou is update function Sim
Mensagens de erro claras (por exemplo, Esta visualização requer uma dimensão e duas medidas) Sim
Todas as opções no painel de configuração da visualização fazem uma mudança aparente na visualização Sim
Uso da formatação value do campo por padrão Sim (quando aplicável)
Um erro é gerado quando uma consulta não retorna resultados Sim

Como enviar a visualização para análise

Quando a visualização estiver pronta para envio, siga as instruções em Enviar conteúdo para o Looker Marketplace para criar a documentação de apoio, enviar a visualização para a equipe do Looker para revisão e publicar no Looker Marketplace.