Tài liệu tham khảo về tệp kê khai hình ảnh trực quan cộng đồng

Tệp kê khai cung cấp thông tin về hình ảnh và xác định vị trí của tài nguyên hình ảnh của bạn. Thư mục này phải có tên là manifest.json và nằm ở cấp cao nhất của thư mục được dùng làm Component ID.

Các trường sau đây phải được xác định (trừ khi có quy định khác):

Tên trường Loại Nội dung mô tả
name string Tên của gói hình ảnh trực quan.
organization string Tên của tổ chức hoặc nhà phát triển.
description string Mô tả gói hình ảnh trực quan.
logoUrl string Biểu trưng cho gói hình ảnh trực quan.
packageUrl string Một đường liên kết mà người dùng có thể truy cập để tìm hiểu thêm về gói này
organizationUrl string (Không bắt buộc) Một đường liên kết mà người dùng có thể truy cập để tìm hiểu thêm về tổ chức hoặc nhà phát triển.
supportUrl string Đường liên kết đến trang hoặc email hỗ trợ để hỗ trợ hình ảnh trực quan này.
privacyPolicyUrl string (Không bắt buộc) Đường liên kết đến chính sách quyền riêng tư.
termsOfServiceUrl string (Không bắt buộc) Đường liên kết đến điều khoản dịch vụ.
devMode boolean (Không bắt buộc) Nếu là true, hãy bỏ qua hoạt động lưu vào bộ nhớ đệm. Giá trị này mặc định là false. Để biết thêm thông tin chi tiết, hãy xem nội dung Giới thiệu về chức năng lưu vào bộ nhớ đệm.
components Array(object) Các hình ảnh có trong gói. Hiện chỉ hỗ trợ một hình ảnh trực quan.
components[].id string Mã nhận dạng của thành phần. Đây phải là một chuỗi không trống và không có dấu cách.
components[].name string Tên của hình ảnh trực quan.
components[].description string Nội dung mô tả về hình ảnh trực quan.
components[].iconUrl string Biểu tượng cho hình ảnh trực quan.
components[].infoUrl string (Không bắt buộc) Một đường liên kết mà người dùng có thể truy cập để tìm hiểu thêm về thành phần này.
components[].resource object Tài nguyên hình ảnh.
components[].resource.js string Vị trí của tệp JavaScript dạng hình ảnh trực quan trong Google Cloud Storage. Ví dụ: gs://GCS_BUCKET_NAME/MY_VISUALIZATION.js.
components[].resource.config string Vị trí của tệp cấu hình hình ảnh trực quan trong Google Cloud Storage. Ví dụ: gs://GCS_BUCKET_NAME/MY_CONFIG.json.
components[].resource.css string (Không bắt buộc) Vị trí của tệp CSS dạng hình ảnh trực quan trong Google Cloud Storage. Ví dụ: gs://GCS_BUCKET_NAME/MY_CSS.css.

Tệp kê khai manifest.json ví dụ

{
  "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"
      }
    }
  ]
}