Sviluppare una visualizzazione personalizzata per Looker Marketplace.

Questa pagina descrive come creare un tipo di visualizzazione personalizzato che possa essere aggiunto a Looker Marketplace e accessibile da altri utenti di Looker. Puoi anche creare una visualizzazione personalizzata direttamente nel tuo progetto senza renderla disponibile per altri clienti Looker.

Tieni presente che devi essere un membro della rete partner di Looker o un cliente di Looker per poter inviare contenuti a Looker Marketplace.

Looker Marketplace è una posizione centralizzata per trovare, eseguire il deployment e gestire molti tipi di contenuti Looker, come Looker BlocksTM, applicazioni, visualizzazioni e altri plug-in.

Con la funzionalità Marketplace di Looker attivata, i clienti di Looker possono installare i plug-in di Looker Marketplace, che includono tipi di visualizzazione da aggiungere alla libreria di visualizzazione nativa di Looker. Le visualizzazioni installate tramite Marketplace sono supportate dal team di Looker.

Per sviluppare una visualizzazione personalizzata e renderla disponibile per tutti i clienti Looker tramite il marketplace di Looker, segui questi passaggi:

  1. Sviluppa una visualizzazione.
  2. Crea un progetto Looker per la visualizzazione.
  3. Esegui il push del progetto Looker in un repository Git.
  4. Prova la funzionalità della visualizzazione.
  5. Invia la visualizzazione a Looker.

Sviluppare un tipo di visualizzazione

Identifica un tipo di visualizzazione che vorresti sviluppare. Verifica che questa visualizzazione non sia già elencata nel Marketplace o come visualizzazione nativa di Looker.

Sviluppa la visualizzazione personalizzata in JavaScript utilizzando l'API Looker Visualizzazione con il tuo ambiente JavaScript.

Creazione di un progetto Looker per la visualizzazione

Crea un progetto Looker per rappresentare la tua visualizzazione personalizzata. Il progetto deve contenere i seguenti file:

  • File LICENSE (File licenza): elenca le licenze con cui viene visualizzata la visualizzazione, utilizzando il testo
    "Questa visualizzazione Looker è distribuita con la seguente licenza:...".

  • File README.md: fornisce una descrizione della visualizzazione, come funziona ed eventuali informazioni aggiuntive.

  • File JavaScript (.js): contiene una versione ridotta del codice JavaScript che hai utilizzato per produrre la visualizzazione. Con Marketplace, i file JS sono inclusi nel progetto, il che consente un controllo delle versioni e una gestione dei pacchetti adeguati.

  • File manifest (manifest.lkml): specifica un id (identificatore univoco) e un label (mostrati nella UI di Looker per questa visualizzazione). Ad esempio:

    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: []
    }
  • File scheda (marketplace.json): configura la scheda del Marketplace per la visualizzazione personalizzata e include un'etichetta per la modalità di visualizzazione della visualizzazione nel Marketplace, la posizione del image_uri, uno slogan che descrive il caso d'uso per la visualizzazione e definisce anche le costanti dei campi del Marketplace inserite dagli utenti durante l'installazione. Ad esempio:
{
  "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"
        }
    }
}

Trasferimento del progetto a Git

Ospita la vista LookML in un repository GitHub accessibile pubblicamente. Supponiamo che tu abbia creato la visualizzazione in un progetto Looker, seguendo questi passaggi per eseguirne il push in un nuovo repository:

  1. Crea un repository GitHub accessibile pubblicamente.
  2. Imposta l'URL del repository del progetto Looker sull'URL del repository GitHub.
  3. Segui le istruzioni Git in Looker per convalidare, eseguire il commit e il deployment del codice in produzione.

Testare la funzionalità della visualizzazione.

Testa la nuova visualizzazione applicandola a un'esplorazione o a un aspetto appropriato nella tua istanza di Looker:

  1. Vai al look o all'esplorazione.
  2. Se stai utilizzando un look, fai clic su Modifica per modificarlo.
  3. Fai clic sul menu con tre puntini nel menu Tipo di visualizzazione per aprire l'elenco a discesa delle visualizzazioni.
  4. Seleziona la visualizzazione personalizzata.
  5. Fai clic su Salva per salvare la modifica apportata al look. Prendi nota di eventuali dashboard che potrebbero essere interessate da questa modifica.

Looker richiede queste funzioni nelle visualizzazioni disponibili da Looker Marketplace:

Funzione Obbligatoria
Supporto per la visualizzazione in dettaglio
Possibilità di ereditare le tavolozze dei colori di Looker
Reattività al browser e alle dimensioni dello schermo
Famiglia di caratteri coerente: font-family: Helvetica, Arial, sans-serif
Dimensioni carattere
Possibilità di attivare Etichette valori ed Etichette assi nel riquadro di configurazione della visualizzazione
Visualizzazione di dati sottoposti a pivot Sì (quando applicabile)
La visualizzazione si aggiorna in base all'interattività dell'utente tramite la funzione updateAsync o is update function
Cancella i messaggi di errore (ad esempio Questa visualizzazione richiede una dimensione e due misure)
Tutte le opzioni nel riquadro di configurazione della visualizzazione apportano una modifica apparente alla visualizzazione
Utilizzo della formattazione value dei campi per impostazione predefinita Sì (quando applicabile)
Viene visualizzato un errore quando una query non restituisce risultati

Inviare la visualizzazione per la revisione

Quando la visualizzazione è pronta per l'invio, segui le istruzioni riportate nell'articolo sull'invio di contenuti a Looker Marketplace per creare la documentazione di supporto per la tua visualizzazione, inviala al team Looker per la revisione e pubblicala su Marketplace Marketplace.