配置plugin-manifest.json

配置plugin-manifest.json

plugin-manifest.json

这是一个示例 JSON 描述符文件，供您参考。



现在我们将了解如何定义此文件的属性。


类型


输入类型“personal”表示允许所有用户配置扩展程序，输入“org”表示允许管理员配置扩展程序。

密钥

类型

价值

类型

字符串

接受的价值观：个人、组织

 

语言环境

扩展程序支持的语言。目前，我们仅支持语言环境“en”（英语）。

 

密钥

类型

价值

语言环境*

JSONArray

en

 

服务

创建扩展的 Zoho 产品名称。此处为“PROJECTS”。

 

密钥

类型

价值

服务*

字符串

PROJECTS

 

存储空间

如果此设置为 true，则产品中会为该扩展程序分配存储空间。默认情况下，此值为 false。

 

密钥

类型

价值

 

存储空间*

 

布尔值

 

  • 是

  • 否

 

 

 

whiteListedDomains

此数组中指定的域名可从扩展程序调用。除已建立连接的域名外，其他域名的调用将不会从扩展程序处理。如果您的扩展程序不使用任何第三方服务，则可以将此数组声明为空。

 

密钥

类型

价值

whiteListedDomains*

Array

 

 

模块

扩展程序的模块。我们目前支持小部件。

密钥

类型

价值

模块

JSONObject

例如:

"widgets":[{
"location":"task_tab",
"name":"GDrive for Zoho Projects",
"url":"/app/index.html",
"countkey" : "extensionUniqueKey"
}]

 

 

小部件

此键包含一个对象数组。每个对象都有三个键：'location'、'name' 和 'URL'。

 

密钥

类型

对象详细信息

小部件

JSONArray

密钥

类型

描述

价值

 

location

字符串

产品中必须呈现扩展的位置。

  • 任务_选项卡

  • 问题_选项卡

  • 里程碑_选项卡

  • 项目_选项卡

  • 应用程序_设置

  • top_band

  • 附件_选择器

  • 任务详情_右面板

  • 已发布详情_右面板

  • 蓝图_中

  • 任务_迁移

注意: 位置名称必须是唯一的。

name

String

The name of the widget.

Example: Checklist

url

URL

The relative path of the file that loads the widget.

/app/index.html

icon

String

The icon of the widget.

Icon is mandatory for attachment picker.

 

countkey

（适用于 task_tab、milestone_tab 和 issue_tab）

字符串

 

用于检索小部件数量的唯一 ID。

扩展唯一键

 


Notes
一个扩展程序可以包含多个组件。

注意：扩展程序唯一密钥用于存储/更新扩展程序数据。

 

连接器

与小部件类似，此键也包含一个对象数组。连接器有助于将扩展程序与第三方服务集成。此类第三方服务的授权通常由 Zoho Projects 处理。

  

密钥

类型

对象详细信息

连接器

JSON Array

密钥

类型

描述

价值

 

 

连接器链接名称

String

为第三方服务连接生成的链接名称

连接摘要 JSON 选项卡中生成的 connectionLinkName 参数值。

 

注意：连接名称必须是唯一的。

 

 

连接名称

String

连接名称

连接摘要的 JSON 选项卡中生成的 connectionName 参数的值。

 

 

服务名称

String

第三方服务名称

连接摘要的 JSON 选项卡中生成的 serviceName 参数的值。

 

 

用户访问权限

Boolean

此参数决定扩展是否必须由每个用户单独授权，还是仅由管理员授权。

  • 真

  • 假

 

 

是用户定义服务

Boolean

是否与自定义服务建立了连接？

  • 真

  • 假

 

 

范围

JSON Array

为用户/管理员设置的访问权限。

例如：

["https://www.googleapis.com/auth/drive.readonly"]

 

Notes
一个扩展程序最多可以同时连接到 5 个第三方服务。

 

 

config

当您需要从用户获取更多输入来操作扩展程序时，可以使用此键。例如，您需要第三方服务的用户域名才能使扩展程序正常运行。要获取该域名，您可以使用此键相应地从用户获取输入。

 

密钥

类型

对象详细信息

config

JSONArray

密钥

类型

对象详细信息

价值

 

 

名称

String

范围名称

该名称应该是唯一的。

 

 

类型

String

范围数据类型

  • '文本'

  • '密码'

  • '复选框'

  • '网址'

  • '数字'

  • '多行'

  • '选择框'

  • '隐藏'

 

 

默认

String

范围的默认的价值

注意：此参数是可选的。

 

 

选项

JSON Array

如果选择“选择框”作为类型，则选项是必需的。

示例 ["新功能", "增强功能"]

 

 

是_安全

Boolean

将其设置为“true”可阻止开发人员从扩展访问此配置。

  • true

  • false

 

 

是_强制的

Boolean

该配置是强制的吗？

  • true

  • false

 

 

描述

String

配置简要说明

注意：此参数是可选的。



    • Related Articles

    • 使用 CLI 创建扩展

      概述 Zoho Marketplace 是一个在线商店，您可以在其中上传您为 Zoho 任何产品开发的扩展程序。您也可以将我们商店中提供的扩展程序用于您的业务。本开发者指南将帮助您构建扩展程序并将其部署到我们的 Marketplace。 开始前需要记住的事项 清单文件 每个扩展程序都必须有一个自己的 plugin-manifest.json 文件来定义其行为。定义此文件后，您可以使用 HTML、JavaScript 和 CSS ...

    • 从 XLS/CSV/JSON/MPP 导入

      您现在可以将 MPP/ MPX/ XLS/ JSON/ CSV 文件导入 Zoho Projects 并开始协作。用户一次最多可导入 5000 个任务。 以管理员权限登录 Zoho Projects。 点击顶部导航栏右上角的 。 导航至“数据管理”>“导入”。 导航至“MPP 和其他文件导入”，然后点击“开始导入”。 选择要导入的文件，然后选择一个项目。 点击“导入”即可导入文件。 如果导入的文件包含自定义字段，则将其与布局任务自定义字段（如有）进行映射，然后点击“继续”。 ...

    • 配置连接器

      与可用的第三方服务建立连接 如果您的扩展程序使用第三方服务，则需要配置连接器以与第三方服务建立连接。您可以一次连接到多个第三方服务。用户也可以从 Zoho Projects 创建连接。 导航到“连接”模块 (https://sigma.zoho.com/workspace/[sigmaportalName]/connections)，点击“添加连接”。 在“选择您的服务”选项卡下，选择第三方或内部 Zoho 服务。 如果您没有账户，请在您选择的服务中创建一个账户。 ...

    • 使用云编辑器创建扩展程序

      Zoho Projects 允许您使用云编辑器构建扩展程序，无需预先设置，并可在线管理整个开发流程。 这里有一个网络研讨会，可以帮助您了解如何使用云编辑器。 概述 Zoho Marketplace 是一个在线商店，您可以在其中上传您为 Zoho 任何产品开发的扩展程序。您也可以将我们商店中提供的扩展程序用于您的业务。本开发者指南将帮助您构建扩展程序并将其部署到我们的 Marketplace。 使用 Zoho Sigma 云编辑器创建扩展 创建工作区 ...

    • JS SDK

      先决条件 在调用以下 SDK 方法之前，请在代码中包含 JS 代码 https://js.zohocdn.com/projects/js/client_sdk.min.js。 请在代码中包含 CSS 代码 https://css.zohocdn.com/projects/styles/zps-extn/client_sdk.css，以便使用 Zoho Projects 样式。 init 初始化扩展程序。 zohoprojects.init().then(function(){}); ...