开源社区连接器

通过访问 GitHub 上的数据洞察资源库,您可以探索所有开源社区连接器,也可以发布您自己的连接器。

开源社区连接器可作为参考范本,进行调整后可满足多种不同的使用情形;此外,它们还着重演示了最佳做法。您可以查看这些连接器的代码,以更好地了解社区连接器。您也可以自行部署这些连接器,并在数据洞察中使用它们。

发布开源社区连接器

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

  1. readme.md 文件添加到您的代码中。有关示例,请参阅 npm Downloads 的 readme 文件。该文档会说明用户如何部署和使用连接器。
  2. 添加 JSDoc 注释。
  3. 清单应包含以下几项的值:
    • shortDescription
    • authType
    • supportUrl
    • feeType
  4. 使用连接器连接的所有来源填充 sources 属性。如需了解详情,请参阅清单参考中的来源
  5. 将连接器中 UrlFetchApp 调用的端点数量限制为执行连接器功能所必需的数量。将 urlFetchWhitelist 属性添加到清单的根级别。如需了解详情,请参阅 urlFetchWhitelist reference 参考。
    • 此属性应包含连接器使用 UrlFetchApp 调用连接的所有网址。
    • 如果连接器未执行 UrlFetchApp 调用,请将属性值设为空列表 []
  6. 如果连接器具有固定架构,请为连接器创建报告模板并将其添加到清单中。
  7. 当用户遇到连接器内部错误时,向用户提供有意义且实用的错误消息。这也包括用户在配置时输入无效/空白内容的情况。
  8. 确保您和您的连接器遵循数据洞察资源库服务条款(提交者)

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

发布您的开源社区连接器