参数

借助参数,您可以与用户提供的数据进行互动。例如,您可以创建包含报告使用者的输入的计算字段,也可以将值传递回数据源使用的 SQL 查询。使用参数可以提高报告的互动性。您还可以使用参数创建报告模板。

参数的工作原理

参数的作用类似于编程语言中的变量。参数主要有三种用途:

  • 您可以在计算字段中使用参数,以显示基于用户输入的结果。
  • 您可以将参数传递回 BigQuery 数据源中的自定义 SQL 查询。
  • 您可以将参数传递回社区连接器。

参数可以从以下位置获取数据:

  • 为参数定义的默认值
  • 组件属性面板
  • 报告中放置的控件
  • 报告的链接

您可以在报告和数据源编辑器中的字段列表底部找到参数。参数显示为紫色字段。

参数如何在报告中共享您的数据

报告和数据源的编辑者可以访问由参数控制的任何数据。借助参数,报告编辑者可以请求与默认值不同的数据。

在为数据源启用参数之前,请务必了解对参数值的更改可能会如何影响报告中的数据。某些参数可能只会返回相对“安全”的数据,例如新区域的天气。不过,其他参数可能会允许用户请求全新的数据集。

例如,账号编号参数或数据库表的名称可能会返回您不打算共享的数据。这两者中的任何一个都可能会返回不同的架构,而该架构可能与报告中的现有图表不兼容。

创建参数

您可以在以下位置创建参数:

  • 数据源
  • BigQuery 连接器

在数据源中创建参数

  1. 修改数据源
  2. 在右上角,点击添加参数 。 您还可以在修改报告时创建参数,方法是选择一个组件,然后在右下角点击添加参数 。请务必根据所需的数据源选择组件。
  3. 配置参数的选项和默认值。

在修改报告时,您可以使用数据面板中的 +添加参数 链接在所选数据源中创建参数。

在 BigQuery 连接器中创建参数

您可以将参数传递给 BigQuery 连接器中的自定义 SQL 查询。BigQuery 连接器定义了多个标准参数,用于传递报告的开始日期和结束日期以及用户的电子邮件地址(如果有)。您还可以传递自定义参数。详细了解如何连接到 BigQuery

参数和社区连接器

社区连接器可以包含可替换的参数,让报告编辑者能够修改数据源中的默认值。如果您可以修改使用社区连接器构建的数据源的连接,则可以指定报告编辑者可以更改哪些参数:

  1. 修改数据源
  2. 点击左上角的修改连接
  3. 如果连接器提供可修改的参数,这些参数会显示在页面底部。允许您定义自定义参数的连接器会在页面中提供相关说明。
  4. 使用允许在报告中修改 <参数名称> 复选框允许或禁止在报告中修改参数。
  5. 点击右上角的重新连接

使用社区连接器创建数据源后,对该连接器中的参数所做的更改不会自动显示在数据源中。您需要重新连接数据源,才能看到任何新增、移除或更改的参数。

修改现有参数

如需更改现有参数的配置,请执行以下操作:

  1. 修改包含该参数的数据源。
  2. 在字段列表中找到该参数。
  3. 点击参数名称右侧的 @ 符号。
  4. 进行任何更改,然后在右下角点击保存

配置参数

使用这些选项可在数据源中配置参数。如果您使用的是 BigQuery 连接器社区连接器,请参阅相应页面。

参数名称 :您会在报告和数据源的字段列表中看到此名称。您还会在计算字段中使用此名称来引用参数。

参数 ID :默认设置。数据洞察会在内部使用参数 ID 来标识参数。报告查看者不会看到此 ID。

数据类型 :参数可以存储文本、数字或布尔值(true/false)。

允许的值 :指定用户可以输入的值。

如需指定值列表,请选择该选项,然后输入可接受的值以及可选的显示名称。点击添加选项 可向列表中添加更多项。

如需指定允许的值范围,请输入该范围的最小值和最大值。

默认值 :为参数指定起始值。

设置参数值

您可以通过以下方式设置参数的值:

为参数设置默认值

您可以在创建参数修改参数时为参数设置默认值。

使用控件获取用户的输入

控件是允许用户与报告互动的组件。如需将用户输入存储在参数中,请将该参数添加到控件的控件字段 属性:

  1. 修改报告
  2. 点击顶部的 控制图标。 添加控件
  3. 选择要添加的控件类型。
  4. 属性 面板中,选择设置 标签页。
  5. 将参数添加到控件字段

详细了解控件

替换组件中的默认参数值

您可以通过修改报告中的各个组件来替换参数的默认值:

  1. 修改报告
  2. 选择基于包含参数的数据源的组件。
  3. 在组件的“数据”标签页底部,修改默认参数值。

您还可以在报告和页面级层修改参数:

  1. 修改报告
  2. 依次选择文件 > 报告设置页面 > 当前页面设置
  3. 修改参数值。

参数继承

参数遵循与过滤条件属性相同的继承规则。具体而言,优先级较高的组件上的参数会替换优先级较低的组件上的参数。优先级顺序(从最低到最高)如下:

  1. 数据源(默认)
  2. 报告
  3. 页面
  4. 群组
  5. 单个图表或控件

通过报告的网址设置参数,开发者和高级用户可以构建可通过编程方式配置的报告。

数据洞察报告参数及其对应的值会作为网址编码的 JSON 字符串传递,并使用“params”查询参数附加到报告网址。

如需了解详情,请参阅开发者指南

管理报告参数

默认情况下,您无法 通过报告网址修改报告中的参数。

如需选择允许报告用户修改哪些参数,请执行以下操作:

  1. 修改报告
  2. 依次选择资源 > 管理变量(参数)
  3. 允许在报告网址中修改 列中,选中您要允许的参数。

此页面还会显示每个参数的网址参数。这是您在构建编码的参数对象时使用的名称,而不是参数名称。您可以点击“修改”铅笔图标来修改此名称。报告中的每个网址参数都必须是唯一的。

修改网址参数名称不会影响参数在报告中的使用方式。

使用参数

创建参数后,您可以在计算字段和报告组件中使用参数,就像使用维度和指标一样。

在计算字段中使用参数

您可以在计算字段中使用参数,就像使用维度或指标一样。

包含参数的计算字段。点击即可展开。

例如,假设您想让用户输入上个季度的销售额的乘数,以直观呈现预测销售额。

首先,创建用于保存预测乘数的参数:

  1. 登录数据洞察。
  2. 修改数据源。
  3. 点击右上角的添加参数
  4. 为参数命名(例如“预测乘数”)。
  5. 数据类型 设置为数字
  6. 为简单起见,将允许的值 选项设置为任意值

    您可以使用其他选项让用户从值列表中进行选择,也可以将用户的输入限制在某个值范围内。
  7. 默认值 设置为 1。
  8. 点击保存
  9. 如需返回到数据源字段列表,请点击左侧的所有字段

接下来,创建计算字段:

  1. 点击右上角的添加字段
  2. 为字段命名(例如“包含参数的销售额预测”)。
  3. 在公式中,将数据源中的“销售额”字段乘以 Forecast multiplier 参数。例如,如果您的数据源包含一个名为 Revenue 的字段,请输入以下内容:

    Revenue * Forecast multiplier
  4. 点击保存

接下来,添加一个控件来收集用户的输入:

  1. 修改或创建报告。
  2. 如有必要,请将数据源添加到报告中。
  3. 点击顶部的 控制图标。 /> 添加控件
  4. 选择输入框 控件。

    借助输入框控件,您可以直接输入参数值。其他类型的控件可让您从列表中进行选择、使用滑块或使用复选框切换布尔值。
  5. 在右侧的数据属性 中,添加您之前创建的 Forecast multiplier 参数。

最后,在图表中直观呈现参数化计算字段。

  1. 点击顶部的 添加图表图标。 添加图表
  2. 为简单起见,请选择记分卡
  3. 在右侧的数据属性 中,将 Sales forecast with parameter 计算字段添加为指标。

现在,试一下:

  1. 点击右上角的查看
  2. 预测乘数 控件中输入一个数字,然后按 Enter 键。
  3. 您会看到记分卡中的值发生变化,因为它会乘以您输入的值。

在可视化图表中使用参数

您可以向图表添加参数,就像添加维度或指标一样。如果您将数字参数用作指标,其值会被汇总。

在报告中显示或隐藏参数

您可以显示或隐藏在数据源中创建的参数:

  1. 修改数据源。
  2. 找到该参数。
  3. 点击参数右侧的 更多选项。“选项”。
  4. 点击显示 (如果参数当前处于隐藏状态)或隐藏 (如果参数当前处于显示状态)。

隐藏参数会将其从数据 面板的字段列表中移除,并破坏使用该参数的所有组件。如果参数在计算字段中使用,则公式会使用参数的默认值。

复制包含参数的组件

复制组件会复制其在属性面板中设置的参数值。您可以通过修改组件来替换副本的参数。

修复无效参数

如果连接器中的参数配置发生更改,则使用这些参数的任何图表都可能会损坏。例如,连接器的开发者可能会移除替换参数值的功能,而您在报告中提供的值不再返回有效数据。在这种情况下,您会在受该更改影响的任何图表中看到错误消息。

如需解决此问题,请找到包含现在无效的参数的组件。然后,在该组件的“数据属性”的“参数”部分中,点击修复无效值

请注意,参数可以在报告、页面和群组级层以及各个图表上设置,因此您可能需要在多个位置查找并修复错误。

控件简介