مرجع بيان مؤثرات عرض المجتمع

يوفر البيان معلومات حول التصور ويحدد موقع موارد التصور الخاصة بك. يجب تسميتها manifest.json و في المستوى الأعلى من المجلد المُستخدم باعتباره Component ID.

يجب تحديد الحقول التالية (ما لم يرد خلاف ذلك):

اسم الحقل النوع الوصف
name string اسم حزمة التصور.
organization string اسم المؤسسة أو المطوّر
description string وصف حزمة العروض المرئية.
logoUrl string شعار لحزمة التصور.
packageUrl string رابط يمكن للمستخدمين النقر عليه للاطّلاع على مزيد من المعلومات حول الحزمة
organizationUrl string (اختياري) رابط يمكن للمستخدمين اتباعه لمعرفة المزيد من المعلومات عن المؤسسة أو المطوّر.
supportUrl string رابط إلى صفحة الدعم أو البريد الإلكتروني لدعم هذا التصور.
privacyPolicyUrl string (اختياري) رابط يؤدي إلى سياسة الخصوصية.
termsOfServiceUrl string (اختياري) رابط إلى بنود الخدمة
devMode boolean (اختياري) إذا كانت القيمة هي "صحيح"، يتم تخطي التخزين المؤقت. يتم ضبط هذه القيمة تلقائيًا على false. لمزيد من التفاصيل، يُرجى الاطّلاع على مقالة لمحة عن التخزين المؤقت.
components Array(object) التصورات المضمنة في الحزمة. لا تتوفّر حاليًا سوى تمثيلات مرئية واحدة.
components[].id string رقم تعريف المكوِّن. ويجب أن تكون سلسلة غير فارغة بدون مسافات.
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"
      }
    }
  ]
}