Referencia del manifiesto de visualización de la comunidad

El manifiesto proporciona información sobre la visualización e identifica la ubicación de los recursos de visualización. Debe llamarse manifest.json y ubicarse en el nivel superior de la carpeta que se usa como Component ID.

Se deben definir los siguientes campos (a menos que se indique lo contrario):

Nombre del campo Tipo Descripción
name string Nombre del paquete de visualización.
organization string Es el nombre de la organización o el desarrollador.
description string Descripción del paquete de visualización.
logoUrl string Un logotipo para el paquete de visualización.
packageUrl string Un vínculo que los usuarios pueden seguir para obtener más información sobre el paquete
organizationUrl string Un vínculo que los usuarios pueden seguir para obtener más información sobre la organización o el desarrollador (opcional).
supportUrl string Vínculo a la página o al correo electrónico de asistencia para apoyar esta visualización.
privacyPolicyUrl string (Opcional) Vínculo a la política de privacidad.
termsOfServiceUrl string (Opcional) Vínculo a las Condiciones del Servicio.
devMode boolean (Opcional) Si es verdadero, se omite el almacenamiento en caché. El valor predeterminado es false. Para obtener más información, consulta este artículo.
components Array(object) Las visualizaciones que se incluyen en el paquete. Actualmente, solo se admite una visualización.
components[].id string Es el ID del componente. Debe ser una string no vacía sin espacios.
components[].name string Es el nombre de la visualización.
components[].description string Es una descripción de la visualización.
components[].iconUrl string Un ícono para la visualización
components[].infoUrl string Un vínculo que los usuarios pueden seguir para obtener más información sobre el componente (opcional).
components[].resource object Los recursos de visualización
components[].resource.js string Es la ubicación del archivo JavaScript de visualización en Google Cloud Storage. P.ej., gs://GCS_BUCKET_NAME/MY_VISUALIZATION.js.
components[].resource.config string La ubicación del archivo de configuración de visualización en Google Cloud Storage. P.ej., gs://GCS_BUCKET_NAME/MY_CONFIG.json.
components[].resource.css string La ubicación del archivo CSS de visualización en Google Cloud Storage (opcional). P.ej., gs://GCS_BUCKET_NAME/MY_CSS.css.
único.

Ejemplo de archivo de manifiesto manifest.json

{
  "name": "ABC Visualizations Package",
  "organization": "ABC Inc.",
  "description": "A package of cool visualizations.",
  "logoUrl": "https://url",
  "organizationUrl": "https://url",
  "supportUrl": "https://url",
  "privacyPolicyUrl": "https://url",
  "termsOfServiceUrl": "https://url",
  "packageUrl": "https://url",
  "devMode": false,
  "components": [
    {
      "id": "treemap",
      "name": "Treemap",
      "description": "Zoomable treemap with filter interactions",
      "iconUrl": "https://url.png",
      "infoUrl": "https://url",
      "resource": {
        "js": "gs://myViz-bucket-treemap/viz.js",
        "config": "gs://myViz-bucket-treemap/viz-config.json",
        "css": "gs://myViz-bucket-treemap/viz.css"
      }
    },
    {
      "id": "histogram",
      "name": "Histogram",
      "description": "Histogram with filter interactions",
      "iconUrl": "https://url.png",
      "resource": {
        "js": "gs://myViz-bucket-histogram/viz.js",
        "config": "gs://myViz-bucket-histogram/viz-config.json",
        "css": "gs://myViz-bucket-histogram/viz.css"
      }
    }
  ]
}