合作伙伴连接器要求

查看发布概览，了解发布连接器的优势和所需的承诺级别。要发布合作伙伴连接器，您的连接器必须满足下述所有要求。

Apps 脚本

在提交连接器以供审核之前，请在 Apps 脚本中完成以下操作：

  1. 与以下人员共享 Apps 脚本项目的查看权限：
  2. 创建名为 Production 的部署，并将 Production 部署更新为您要发布的代码版本。
  3. 确认您已将 Production 部署更新为您要审核的代码版本。
  4. 确认清单文件在 Apps 脚本中可见。点击左侧的项目设置 。选中在编辑器中显示“appsscript.json”清单文件复选框。

清单

在连接器的清单中添加以下内容，并确认您的 Apps 脚本项目已配置为在编辑器中显示 appsscript.json 清单文件。

如需了解详情，请参阅社区连接器清单参考。

dataStudio

  1. description 应提供相关信息和说明，以便用户对连接器及其使用方法有基本的了解。如果连接器的说明模糊、不完整，则会遭拒。
  2. addOnUrl 应该是关于连接器的专用托管页面，最好托管在您自己的网域中。该页面必须包含以下内容：
    • 隐私权政策和使用条款或指向此内容的链接（位于 addOnUrl 所在的网域中）。
    • 用户使用连接器时需要了解的详细信息。
    • 注册链接（如果需要帐号才能使用连接器）。
    • 最好在您的网域中托管内容。不允许在 https://sites.google.com/ 上托管。
    • 查看现有合作伙伴（Funnel、Supermetrics、CallRail）的示例页面。
  3. supportUrl 应该是用于获取连接器支持的托管页面。不得为电子邮件地址或 mailto 链接。
  4. logoUrl 应指向托管在您控件下的静态图片。您不能在 *.gstatic.com、*.ggpht.com、*.google.com、*.googleusercontent.com 等网域上使用 Google 服务提供的图片。使用 Google Cloud Storage 从 *.googleapis.com 网域传送图片是可以接受的，建议您选择此托管方式。
    • 带有动画图标的连接器将被拒绝。使用静态图片。
    • 建议至少使用一张 48x48 像素的图片。
    • 避免使用在缩小到 48x48 像素后难以阅读的纯文字图片。
  5. 使用连接器连接的所有来源填充 sources 属性。如需了解详情，请参阅清单参考中的来源。
    • 您可以在数据注册表代码库中查看现有的来源列表。如果代码库中不存在您要连接的来源，请向数据注册表代码库发送拉取请求以添加来源。如果代码库中不存在清单中的源代码，您的连接器将无法通过审核流程。
    • 这是连接器的其他元数据，会在资源库中针对搜索功能编入索引。当用户在资源库中搜索特定来源时，您的连接器将显示在搜索结果中。
  6. 为 shortDescription、authType、feeType、privacyPolicyUrl 和 termsOfServiceUrl 提供值。
  7. name 应直接表示连接器的用途。一个清晰的名称有助于用户确定您的连接器是否满足其需求。避免在名称中使用“连接器”一词，因为用户已经知道他们是在查看连接器。
    • 请勿添加意在吸引用户注意或可能改变连接器位置的特殊字符或不可见字符。
  8. 请勿在清单中的任何位置（例如 GDS、DS 等）使用 Looker Studio 的简写名称。
  9. 任何清单字段（description、shortDescription、name 等）中都不允许使用表情符号。一般来说，不要为了吸引人们注意您的连接器而添加特殊或不可见字符。
  10. 如果您的连接器具有固定架构，请为连接器创建报告模板并将其添加到清单中。为报告启用“通过链接共享”。

urlFetchWhitelist

  1. 将 UrlFetchApp 调用的端点数量限制为执行连接器功能所必需的数量。将 urlFetchWhitelist 属性添加到清单的根级别。如需了解详情，请参阅 urlFetchWhitelist 参考。
    • 包含用于 UrlFetchApp 服务的所有端点。
    • 如果您的连接器不使用 UrlFetchApp 服务提取资源，请将 urlFetchWhitelist 设置为空列表 []。
    • 如果您的连接器未连接到一组固定端点或端点前缀不同，请省略 urlFetchWhitelist 属性，并在提交审核请求时在 urlFetchWhitelist 表单字段中提供详细信息。

oauthScopes

  1. 在清单中设置明确的 OAuth 范围。没有明确 OAuth 范围的连接器将被拒绝。

连接器

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

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

发布您的合作伙伴连接器