Desarrollar una visualización personalizada para Looker Marketplace

En esta página se describe cómo crear un tipo de visualización personalizado que se pueda añadir a Looker Marketplace y al que puedan acceder otros usuarios de Looker. También puedes crear una visualización personalizada directamente en tu proyecto sin que esté disponible para otros clientes de Looker.

Ten en cuenta que debes ser miembro de la red de partners de Looker o cliente de Looker para enviar contenido a Looker Marketplace.

Looker Marketplace es una ubicación centralizada para encontrar, implementar y gestionar muchos tipos de contenido de Looker, como Looker Blocks™, aplicaciones, visualizaciones y otros complementos.

Con la función Marketplace de Looker habilitada, los clientes de Looker pueden instalar complementos de Looker Marketplace, que incluyen tipos de visualización que se pueden añadir a la biblioteca de visualizaciones nativa de Looker.

Para desarrollar una visualización personalizada y ponerla a disposición de todos los clientes de Looker a través de Looker Marketplace, sigue estos pasos:

1. Desarrollar una visualización.
2. Crea un proyecto de Looker para la visualización.
3. Inserta el proyecto de Looker en un repositorio de Git.
4. Prueba la funcionalidad de la visualización.
5. Envía tu visualización a Looker.

Desarrollar un tipo de visualización

Identifica el tipo de visualización que quieres desarrollar. Confirma que esta visualización no aparece en Marketplace ni como visualización nativa de Looker.

Desarrolla tu visualización personalizada en JavaScript con la API Visualization de Looker en tu entorno de JavaScript.

Crear un proyecto de Looker para la visualización

Crea un proyecto de Looker para representar tu visualización personalizada. El proyecto debe contener los siguientes archivos:

• Archivo LICENSE: incluye la licencia o las licencias con las que se distribuye la visualización, con el siguiente texto:

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

• Archivo README.md: proporciona una descripción de la visualización, cómo funciona y cualquier información adicional.

• Archivo JavaScript (.js): contiene una versión condensada del código JavaScript que has usado para generar la visualización. Con Marketplace, los archivos JS se incluyen en el proyecto, lo que permite gestionar correctamente las versiones y los paquetes.

• Archivo de manifiesto (manifest.lkml): especifica un id (un identificador único) y un label (que se muestra en la interfaz de usuario de Looker para esta visualización). Por ejemplo:

    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: []
    }

• Archivo de lista (marketplace.json): configura la ficha de Marketplace de la visualización personalizada e incluye una etiqueta que indica cómo aparecerá la visualización en Marketplace, la ubicación del image_uri, una frase que describe el caso práctico de la visualización y las constantes de campo de Marketplace que los usuarios introducen durante la instalación. Por ejemplo:

{
  "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 el proyecto a Git

Aloja tu LookML de visualización en un repositorio de GitHub de acceso público. Si has creado la visualización en un proyecto de Looker, sigue estos pasos para enviarla a un nuevo repositorio:

1. Crea un repositorio de GitHub de acceso público.
2. Define la URL del repositorio de tu proyecto de Looker como la URL de tu repositorio de GitHub.
3. Sigue las instrucciones de Git en Looker para validar, confirmar e implementar tu código en producción.

Probar la funcionalidad de la visualización

Prueba la nueva visualización aplicándola a una exploración o a un Look adecuados de tu instancia de Looker:

1. Ve al Look o al Explorar.
2. Si estás en un Look, haz clic en Editar para editarlo.
3. Haz clic en el menú de tres puntos del menú de tipos de visualización para abrir la lista desplegable de visualizaciones.
4. Selecciona la visualización personalizada.
5. Haz clic en Guardar para guardar el cambio en el aspecto. Apunta los paneles de control que puedan verse afectados por este cambio.

Looker requiere estas funciones en las visualizaciones disponibles en Looker Marketplace:

Enviar la visualización a revisión

Cuando tu visualización esté lista para enviarse, sigue las instrucciones que se indican en el artículo Enviar contenido a Looker Marketplace para crear la documentación complementaria de tu visualización, enviarla al equipo de Looker para que la revise y publicarla en Looker Marketplace.