Desenvolver uma visualização personalizada para o Looker Marketplace

Esta página descreve como criar um tipo de visualização personalizado que pode ser adicionado ao Looker Marketplace e acedido por outros utilizadores do Looker. Também pode criar uma visualização personalizada diretamente no seu projeto sem a disponibilizar a outros clientes do Looker.

Tenha em atenção que tem de ser membro da Looker Partner Network ou cliente do Looker para enviar conteúdo para o Looker Marketplace.

O mercado do Looker é uma localização central para encontrar, implementar e gerir muitos tipos de conteúdo do Looker, como blocos do Looker™, aplicações, visualizações e outros plug-ins.

Com a funcionalidade do mercado do Looker ativada, os clientes do Looker podem instalar plug-ins do mercado do Looker, que incluem tipos de visualização a adicionar à biblioteca de visualização nativa do Looker.

Para desenvolver uma visualização personalizada e disponibilizá-la a todos os clientes do Looker através do mercado do Looker, siga estes passos:

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 a visualização para o Looker.

Desenvolver um tipo de visualização

Identifique um tipo de visualização que quer desenvolver. (Confirme que esta visualização ainda não está listada no Marketplace nem como uma visualização nativa do Looker.)

Desenvolva a sua visualização personalizada em JavaScript através da API Looker Visualization com o seu ambiente JavaScript.

Criar um projeto do Looker para a visualização

Crie um projeto do Looker para representar a sua visualização personalizada. O projeto deve conter os seguintes ficheiros:

• Ficheiro LICENSE: apresenta a licença ou as licenças com as quais a visualização é distribuída, usando o texto:

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

• Ficheiro README.md: fornece uma descrição da visualização, como funciona e quaisquer informações adicionais.

• Ficheiro JavaScript (.js): contém uma versão condensada do código JavaScript que usou para produzir a visualização. Com o Marketplace, os ficheiros JS são incluídos no projeto, o que permite uma gestão de pacotes e controlo de versões adequados.

• Ficheiro de manifesto (manifest.lkml): especifica um id (um identificador exclusivo) e um label (apresentado na IU do Looker para esta visualização). Por 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: []
    }

• Ficheiro de ficha (marketplace.json): configura a ficha do Marketplace para a visualização personalizada e inclui uma etiqueta que indica como a visualização vai aparecer no Marketplace, a localização do image_uri, um slogan que descreve o exemplo de utilização da visualização e também define as constantes de campo do Marketplace que os utilizadores introduzem durante a instalação. Por 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"
        }
    }
}

Enviar o projeto para o Git

Alojamento do LookML de visualização num repositório do GitHub acessível publicamente. Partindo do princípio de que criou a visualização num projeto do Looker, siga estes passos para a enviar para um novo repositório:

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

Testar a funcionalidade da visualização

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

1. Navegue para o Look ou o Explorar.
2. Se estiver num visual, clique em Editar para o editar.
3. Clique no menu de três pontos no menu de tipo de visualização para abrir a lista pendente de visualizações.
4. Selecione a visualização personalizada.
5. Clique em Guardar para guardar a alteração ao visual. Tome nota de todos os painéis de controlo que possam ser afetados por esta alteração.

O Looker requer estas funções nas visualizações disponíveis no mercado do Looker:

Enviar a visualização para revisão

Quando a visualização estiver pronta para envio, siga as instruções em Envio de conteúdo para o mercado do Looker para criar documentação de apoio para a visualização, envie-a para a equipa do Looker para revisão e publique-a no mercado do Looker.