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

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

É necessário ser membro da Looker Partner Network ou cliente do Looker para enviar conteúdo ao Marketplace do Looker.

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

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

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

1. Desenvolva 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 ao Looker.

Desenvolver um tipo de visualização

Identifique um tipo de visualização que você gostaria de desenvolver. Confirme se ela ainda 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.

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 de licença: 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 sua 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 sua visualização. Com o Marketplace, os arquivos JS são incluídos no projeto, o que permite o controle de versões e o gerenciamento de pacotes adequados.

• Arquivo de manifesto (manifest.lkml): especifica um id (um identificador exclusivo) e um label (mostrado 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 informações do produto (marketplace.json): configura a página de detalhes do Marketplace para a visualização personalizada e inclui um rótulo para 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 de visualização em um repositório do GitHub de acesso público. Supondo que você tenha criado a visualização em um projeto do Looker, siga estas etapas para enviá-la a um novo repositório:

1. Crie um repositório do GitHub de acesso público.
2. Defina o URL do repositório do seu projeto do Looker como o URL do seu 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

Para testar a nova visualização, aplique-a a um Explore ou Look apropriado na sua instância do Looker:

1. Navegue até o recurso "Look" ou "Explore".
2. Se estiver em um Look, clique em Editar para editá-lo.
3. Clique no menu de três pontos do 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 Look. Observe os painéis que podem ser afetados por essa mudança.

O Looker exige estas 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
Capacidade de resposta em relação ao navegador e ao tamanho da tela	Sim
Família de fontes consistente: font-family: Helvetica, Arial, sans-serif	Sim
tamanho da fonte	Sim
Capacidade de alternar Rótulos de valor e Rótulos de eixos no painel de configuração de visualização.	Sim
Visualização de dados dinâmicos	Sim (quando aplicável)
A visualização é atualizada 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 medições)	Sim
Todas as opções no painel de configuração de 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 revisão

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