开源社区连接器要求

您应首先查看发布概览,了解不同的发布选项以及它们各自的优势和所需的承诺级别。这有助于您为连接器选择正确的发布选项。

如果要将连接器发布为开源社区连接器,则在发出拉取请求之前必须满足以下要求。

  1. readme.md 文件添加到您的代码中。您不需要添加部署链接。请参阅 npm Downloads 的自述文件,了解相关示例。
  2. 添加 JSDoc 注释。
  3. 清单应包含 shortDescriptionauthTypesupportUrlfeeType 的值。
    • 请注意,supportUrl 可以供数据洞察开发者关系团队使用,也可以供您自己使用(如果您选择自行提供支持)。
  4. 您应使用连接器连接的所有来源填充 sources 属性。有关详情,请参阅清单参考中的来源
  5. 您应将连接器中 UrlFetchApp 调用的端点数量限制为执行连接器功能所必需的数量。请将 urlFetchWhitelist 属性添加到清单的根级别。如需了解更多信息,请参阅 urlFetchWhitelist 参考
    • 此属性应包含连接器使用 UrlFetchApp 调用连接的所有网址。
    • 如果您的连接器未执行 UrlFetchApp 调用,则请将此属性值设置为空列表 []
  6. 如果连接器具有固定架构,请为连接器创建报告模板并将其添加到清单中。
  7. 当用户遇到连接器内部错误时,向用户提供具有实际意义且可作为操作依据的错误消息。这也包括用户在配置时输入无效/空白内容的情况。
  8. 确保您和您的连接器遵循数据洞察资源库服务条款(提交者)

满足所有要求后,请点击以下按钮以请求审核您的连接器:

发布您的开源社区连接器