清单参考

清单 (appsscript.json) 是位于 Apps 脚本连接器项目中的 JSON 文件。清单中包含有关在数据洞察中部署和使用连接器所需的社区连接器的信息。详细了解 Apps 脚本中的清单

您的清单应包含以下信息:

属性名称 类型 说明
必需(在 datastudio 属性下)
name string 连接器的名称。
不得超过 28 个字符
company string 组织或开发者的名称。
companyUrl string (link) 指向组织或开发者网站的链接。
logoUrl string (image link) 连接器图标的网址。
尺寸要求:40x40 像素。
addOnUrl string (link) 指向专门的“了解详情”页面的链接,该页面会说明您的连接器的功能及会访问的数据。您应该托管和维护该页面。
该页面必须包含服务条款和隐私权政策或提供指向这些内容的链接。
supportUrl string (link) 指向支持页面(用于为此连接器提供支持)的链接。用户应该能够通过此链接报告与您的连接器相关的问题。您应该托管和维护该页面。
description string 连接器说明。
用户会在您的连接器配置页面看到完整说明。链接是可点击的。
可选(在 datastudio 属性下)
shortDescription string 限制:最多 114 个字符。如果您的连接器已发布,则这段简短说明将显示在连接器的资源库卡片中。使用此属性可简要说明连接器的功能。用户在资源库中浏览连接器时可以查看这段说明。
privacyPolicyUrl string (link) 指向连接器/开发者组织的隐私权政策的链接。
termsOfServiceUrl string (link) 指向连接器/开发者组织的服务条款的链接。
authType list(AuthType) 连接器的身份验证方法类型。请参阅下面的 AuthType
feeType list(FeeType) 表示连接器的费用类型。请参阅下面的 FeeType
sources list(Sources) 此连接器可以连接到的数据源列表。请参阅下面的来源
templates Object 可用于此连接器的模板列表。只能有一个默认模板,默认模板通过设置 default 键确定。该值应该是将用作模板的数据洞察报告的报告 ID。请参阅有关如何提供报告模板的指南。
forceViewersCredentials boolean 是否应对从此连接器创建的数据源强制使用查看者凭据。此属性为可选属性,默认为 false。如需详细了解查看者凭据,请参阅数据源凭据
useQueryConfig boolean 此连接器是否会针对 `getData()` 返回查询配置。请参阅高级服务
可选(根级属性)
urlFetchWhitelist list(string) 连接器使用的 HTTPS 网址前缀列表。提取的任何网址端点必须与此列表中的一个前缀匹配。这有助于保护用户数据。如需了解详情,请参阅将网址列入白名单

AuthType

身份验证方法类型的值可以是以下任一值:

枚举值 说明
NONE 表示连接器不需要进行身份验证。
OAUTH2 表示连接器使用 OAuth 2.0 进行身份验证。
KEY 表示连接器使用 API 密钥进行身份验证。
USER_PASS 表示连接器使用用户名/密码进行身份验证。
USER_TOKEN 表示连接器使用用户名/令牌进行身份验证。

FeeType

费用类型的值可以是以下任何一项:

枚举值 说明
FREE 表示连接器完全是免费使用的。
FREE_TRIAL 表示连接器有免费试用选项。
PAID 表示用户需要付费才能使用连接器。

来源

指来源的枚举列表。您可以在我们的数据注册表存储区中查看现有的来源列表。如果存储区中不存在您要连接的来源,请向数据注册表存储区发送拉取请求以添加来源。来源名称只能包含大写字符和下划线(例如 Google Analytics(分析)对应的是 GOOGLE_ANALYTICS)。在您的社区连接器清单中,请使用数据源 ID 属性的,例如 GOOGLE_ANALYTICS

社区连接器的清单示例

以下是已完成的清单示例:

data-studio/appsscript.json
{
      "dataStudio": {
        "name": "Nucleus by Hooli",
        "company": "Hooli Inc.",
        "companyUrl": "https://hooli.xyz",
        "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
        "addonUrl": "https://hooli.xyz/data-studio-connector",
        "supportUrl": "https://hooli.xyz/data-studio-connector/support",
        "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
        "shortDescription": "Connect to your data using Nucleus middle out optimization",
        "privacyPolicyUrl": "https://hooli.xyz/privacy",
        "termsOfServiceUrl": "https://hooli.xyz/tos",
        "authType": ["NONE"],
        "feeType": ["PAID"],
        "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
        "templates": {
          "default": "872223s89f5fdkjnd983kjf"
        }
      },
      "urlFetchWhitelist": [
        "https://api.hooli.xyz/",
        "https://hooli.xyz/"
      ]
    }