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 trực quan của bạn và xác định vị trí của tài nguyên trực quan hoá. Tệp này phải được đặt 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.

Bạn phải xác định các trường sau (trừ phi có quy định khác):

Tên trường Loại 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 Nội dung mô tả về gói hình ảnh trực quan.
logoUrl string Biểu trưng cho gói trực quan hoá.
packageUrl string Đường liên kết mà người dùng có thể nhấp vào để tìm hiểu thêm về gói
organizationUrl string (Không bắt buộc) Đường liên kết mà người dùng có thể nhấp vào để 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, bỏ qua việc lưu vào bộ nhớ đệm. Giá trị này mặc định là false. Để biết thêm chi tiết, hãy xem Giới thiệu về cách lưu vào bộ nhớ đệm.
components Array(object) Các hình ảnh trực quan có trong gói. Hiện chỉ hỗ trợ một hình ảnh trực quan duy nhất.
components[].id string Mã của thành phần. Đây phải là một chuỗi không trống và không có khoảng trắng.
components[].name string Tên của hình ảnh trực quan.
components[].description string Nội dung mô tả của 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) Đường liên kết mà người dùng có thể nhấp vào để tìm hiểu thêm về thành phần này.
components[].resource object Tài nguyên trực quan hoá.
components[].resource.js string Vị trí của tệp JavaScript trực quan hoá 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 trực quan hoá 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 trực quan hoá trong Google Cloud Storage. Ví dụ: gs://GCS_BUCKET_NAME/MY_CSS.css.

Ví dụ về tệp kê khai 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"
      }
    }
  ]
}