合作伙伴连接器要求

您应首先查看发布概览,了解发布连接器的优势和所需的承诺级别。如果要将连接器发布为合作伙伴连接器,则在请求审核之前必须满足以下要求。

Apps 脚本

  1. 与以下两个地址共享 Apps 脚本项目的查看权限
  2. 创建名为 Production 的部署,并更新 Production 部署,使其包含要发布的代码版本。
  3. 如果您在创建 Production 部署后更新了代码,请确保在提交连接器之前为该部署选择了正确的代码版本。

清单

您必须在连接器的清单中包含以下内容。如需详细了解清单中的各个属性,请参阅清单参考

  1. description 中,确保提供所有必要的信息和说明,以便用户对连接器及其使用方法有一个基本了解。如果连接器的说明模糊、不完整,则会在审核过程中被拒。
  2. addOnUrl 应是关于连接器的专用托管页面,最好托管在您自己的网域上。
    • 该页面必须包含与 addOnUrl 托管在同一网域中的隐私权政策使用条款,或提供指向这些内容的链接。
    • 该页面应包含用户使用连接器时需要了解的任何详细信息。
    • 如果用户需要注册帐号才能使用您的连接器,则该页面应提供注册链接。
    • 该页面不得托管在 https://sites.google.com/ 上。
    • 查看现有合作伙伴(FunnelSupermetricsCallRail)的示例页面。
  3. supportUrl 应是一个托管页面,在该页面上,用户可就您的连接器获得支持。不得为电子邮件地址或 mailto 链接。
  4. 您应使用连接器连接的所有来源填充 sources 属性。如需了解详情,请参阅清单参考中的来源
    • 您可以在我们的数据注册表存储区中查看现有的来源列表。如果存储区中不存在您要连接的来源,请向数据注册表存储区发送拉取请求以添加来源。如果存储区中不存在清单中的来源,则连接器将无法通过审核流程
    • 这是连接器的其他元数据,会在资源库中针对搜索功能编入索引。当用户在资源库中搜索特定数据源时,您的连接器将显示在搜索结果中。
    • 资源库提供“按数据源划分的连接器”界面,让用户可以按数据源查找连接器。
  5. 您应将连接器中 UrlFetchApp 调用的端点数量限制为执行连接器功能所必需的数量。将 urlFetchWhitelist 属性添加到清单的根级别。如需了解详情,请参阅 urlFetchWhitelist 参考
    • 此属性应包含连接器使用 UrlFetchApp 调用连接的所有网址。
    • 如果连接器未执行 UrlFetchApp 调用,请将属性值设为空列表 []
    • 如果连接器未连接到固定网域或端点前缀不同,请忽略清单中的 urlFetchWhitelist 属性。
  6. 清单应包含 shortDescriptionauthTypefeeTypeprivacyPolicyUrltermsOfServiceUrl 的值。
  7. 连接器 name 应能够直接代表连接器的具体功能。这样,用户便可以清楚地知道连接器的功能,从而确定可满足其需求的适当连接器。

模板和报告

  1. 如果连接器具有固定架构,请为连接器创建报告模板并将其添加到清单中。为报告启用“通过链接共享”。
  2. 使用您的连接器创建至少一个演示报告,并将报告提交到数据洞察资源库。该报告可以是模板报告的副本,也可以是展示更广泛的连接器功能的单独报告。
    • 添加演示报告,让您的连接器有资格获得推广机会(获得推荐、在简报和博文中提及以及用作案例研究等)。

连接器

  1. 如果用户需要帐号才能使用连接器,请确保连接器 descriptionaddOnUrl 链接提供了帮助用户创建帐号的说明。
  2. 您的连接器不能处于未完成状态或测试状态。您必须发布完整并可正常运行的连接器。您可以随时更新连接器,但应测试发布给用户的生产部署版本并确保其功能完备。
  3. 当用户遇到连接器内部错误时,向用户提供有意义且实用的错误消息。这包括用户在配置时输入无效/空白内容的情况。
  4. 连接器的 shortDescriptiondescriptionaddOnUrl 链接、supportUrl 链接和 OAuth 页面(如果适用)应该没有拼写错误和语法错误。
  5. getAuthType() 中使用适当的身份验证方法。请勿通过 getConfig() 请求凭据。
  6. 完成 OAuth 客户端验证流程。无论在 getAuthType() 中使用哪种身份验证方法,所有连接器都必须进行验证。验证流程由一个单独的团队负责处理。如需了解详情,请参阅 OAuth API 验证常见问题解答如果您并未完成 OAuth 客户端验证流程,则系统不会发布您的连接器
    • 在 OAuth 验证流程中,配置 OAuth 同意屏幕时,请添加连接器必需的 OAuth 范围如果未能添加所有必需的范围,您可能会通过 OAuth 验证流程,但您的连接器仍将显示未验证的应用屏幕这将导致合作伙伴连接器验证流程失败。
      通过 OAuth 验证流程后,使用新帐号授权并测试您的连接器,以确保它不会向用户显示未验证的应用屏幕
  7. 确保您遵守数据洞察资源库服务条款(提交者)

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

发布您的合作伙伴连接器