マニフェストにより、ビジュアル表示に関する情報が提供され、ビジュアル表示リソースの場所が識別されます。マニフェストは、manifest.json
という名前を付けて、Component ID
として使用されるフォルダの最上位に配置してください。
特に指定がない限り、以下のフィールドを定義する必要があります。
フィールド名 | タイプ | 説明 |
---|---|---|
name |
string |
ビジュアリゼーション パッケージの名前。 |
organization |
string |
組織またはデベロッパーの名前。 |
description |
string |
ビジュアリゼーション パッケージの説明。 |
logoUrl |
string |
ビジュアリゼーション パッケージのロゴ。 |
packageUrl |
string |
パッケージの詳細へのリンク。 |
organizationUrl |
string |
(省略可)組織またはデベロッパーの詳細へのリンク。 |
supportUrl |
string |
このビジュアリゼーションをサポートするページへのリンクまたはサポート用のメールアドレス。 |
privacyPolicyUrl |
string |
(省略可)プライバシー ポリシーへのリンク。 |
termsOfServiceUrl |
string |
(省略可)利用規約へのリンク。 |
devMode |
boolean |
(省略可)true の場合、キャッシュがスキップされます。この値のデフォルトは false です。詳しくは、キャッシュに関するページをご確認ください。 |
components |
Array(object) |
パッケージに含まれるビジュアリゼーション。現在、単一のビジュアリゼーションのみがサポートされています。 |
components[].id |
string |
コンポーネントの ID。スペースを含まない、空でない文字列にします。 |
components[].name |
string |
ビジュアリゼーションの名前。 |
components[].description |
string |
ビジュアリゼーションの説明。 |
components[].iconUrl |
string |
ビジュアリゼーションのアイコン。 |
components[].infoUrl |
string |
(省略可)コンポーネントの詳細へのリンク。 |
components[].resource |
object |
ビジュアリゼーションのリソース。 |
components[].resource.js |
string |
ビジュアリゼーション JavaScript ファイルの Google Cloud Storage 内の場所。例: gs://GCS_BUCKET_NAME/MY_VISUALIZATION.js |
components[].resource.config |
string |
ビジュアリゼーション設定ファイルの Google Cloud Storage 内の場所。例: gs://GCS_BUCKET_NAME/MY_CONFIG.json |
components[].resource.css |
string |
(省略可)ビジュアリゼーション CSS ファイルの Google Cloud Storage 内の場所。例: gs://GCS_BUCKET_NAME/MY_CSS.css |
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"
}
}
]
}