Cómo desarrollar una visualización personalizada para Looker Marketplace

En esta página, se describe cómo crear un tipo de visualización personalizada que se puede agregar a Looker Marketplace y a la que pueden 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 socios de Looker o cliente de Looker para enviar contenido a Looker Marketplace.

Looker Marketplace es una ubicación central para encontrar, implementar y administrar muchos tipos de contenido de Looker, como Looker BlocksTM, aplicaciones, visualizaciones y otros complementos.

Cuando la función Marketplace de Looker está habilitada, los clientes de Looker pueden instalar complementos de Looker Marketplace, que incluyen tipos de visualización para agregar a la biblioteca de visualización nativa de Looker. Las visualizaciones instaladas a través de Marketplace son compatibles con el equipo de Looker.

A fin de desarrollar una visualización personalizada y hacer que esté disponible para todos los clientes de Looker mediante Looker Marketplace, sigue estos pasos:

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

Cómo desarrollar un tipo de visualización

Identifica el tipo de visualización que te gustaría desarrollar. (Confirme que esta visualización aún no aparezca en Marketplace o como una visualización nativa de Looker).

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

Crea 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: Se muestra una lista de las licencias con las que se distribuye la visualización, con el texto
    "Esta visualización de Looker se distribuye con la siguiente licencia:...".

  • README.md: Proporciona una descripción de tu visualización, cómo funciona y cualquier información adicional.

  • Archivo JavaScript (.js): Contiene una versión condensada del código JavaScript que utilizó para generar la visualización. Con Marketplace, los archivos JS se incluyen dentro del proyecto, lo que permite el control de versiones y la administración de paquetes adecuados.

  • Archivo de manifiesto (manifest.lkml): Especifica un id (un identificador único) y un label (que se muestra en la IU 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 para la visualización personalizada. Incluye una etiqueta sobre cómo aparecerá la visualización en Marketplace, la ubicación de image_uri, un eslogan que describe el caso práctico de la visualización y también define las constantes de campo de Marketplace que los usuarios ingresan 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"
        }
    }
}

Envía el proyecto a Git

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

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

Prueba la funcionalidad de la visualización

Pruebe la nueva visualización aplicándola a una instancia adecuada de Explorar o de buscar en su instancia de Looker:

  1. Navega a la opción Explorar o Explorar.
  2. En un Look, haz clic en Edit para editarlo.
  3. Haga clic en el menú de tres puntos en el menú de tipo de visualización para abrir la lista desplegable de visualizaciones.
  4. Seleccione su visualización personalizada.
  5. Haz clic en Save para guardar el cambio en Look. Tenga en cuenta cualquier panel que pueda verse afectado por este cambio.

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

Function Obligatorio
Compatibilidad con la exploración en detalle Sí
Capacidad de heredar las paletas de colores de Looker Sí
Capacidad de respuesta para el navegador y el tamaño de la pantalla Sí
Familia de fuentes coherente: font-family: Helvetica, Arial, sans-serif Sí
Tamaño de fuente Sí
Capacidad de activar o desactivar Etiquetas de valor y Etiquetas de eje en el panel de configuración de visualización Sí
Visualización de datos dinámicos Sí (si corresponde)
Actualizaciones de visualización basadas en la interactividad del usuario con la función updateAsync o is update function Sí
Borrar los mensajes de error (por ejemplo, Esta visualización requiere 1 dimensión y 2 medidas) Sí
Todas las opciones en el panel de configuración de visualización hacen un cambio aparente en la visualización. Sí
Uso del formato value del campo de forma predeterminada Sí (si corresponde)
Se produce un error cuando una consulta no muestra resultados Sí

Cómo enviar la visualización para su revisión

Una vez que tu visualización esté lista para su envío, sigue las instrucciones en Cómo enviar contenido a Looker Marketplace a fin de crear documentación de respaldo para tu visualización, enviar tu visualización al equipo de Looker para su revisión y publicarla en Looker Marketplace.