页面级变量

定义:页面级变量继承自原页面属性( PS 字段),此变量与页面绑定,可作为维度分解页面浏览量及页面上发生的无埋点事件。

在 GrowingIO 的一个项目中,页面级变量的个数上限为 50 个,暂时不支持扩展。如果您所创建的页面级变量已达上限,请您删除无用的变量后再尝试创建。

页面级变量的持久性范围

页面级变量的持久性范围仅在当前页面内,随着用户操作行为导致页面一旦变化,保存在页面级变量中的值就宣告失效。也就是说,页面级变量作为维度,只能用于分解它们标记的页面(如上述的商品详情页和频道页)上无埋点及埋点指标

页面级变量使用的场景

页面级变量可以用于下述场景

  • 各个不同板块页面的用户访问情况分析。在这种场景下,使用一个页面级变量保存页面所属板块的名称。

  • 各个不同子站点的用户访问情况分析。在这种场景下,使用一个页面级变量保存页面所属子站点的名称。

  • 各个不同类型页面的用户访问情况分析。在这种场景下,使用一个页面级变量保存页面所属的类型名称。例如功能引导页面,购物流程页面等。

分析场景示例一

常用于商品详情页、搜索结果页等由同一个模板(类)填充的多个页面,以便区分这些页面间不同的业务含义。例如商品详情页可用页面级变量来标记:商品名称、商品 ID、品类、价格等信息。如图示:

在按上图所示,为所有商品详情页打上页面级变量的标签后,在 GrowingIO 后台,上述 5 个页面级变量均会成为“维度”,可在各分析图表、工具中选用。例如在事件分析中,即可按商品 ID 来分解页面浏览量:

分析场景示例二

例如,在某门户网站里存在多个频道(新闻、娱乐等),用户可能会浏览新闻类页面,也可能会浏览娱乐类页面,那么在这样的场景下,GrowingIO 推荐设置一个页面级变量来保存页面的类型信息,然后使用类似于下面代码来将这样的页面类型的信息保存在一个页面级变量中。我们为所有的新闻类页面调用下述代码,为它们打上“频道=新闻”这样一个标签,然后在 GrowingIO 后台即可按频道来分解用户的浏览行为。

  • 网站代码

gio(“page.set”, “channel”, “新闻”);

  • Android代码

GrowingIO.setPageVariable(Activity activity, ”channel”, “新闻”);

  • iOS代码

[Growing setPageVariableWithKey:@"channel" andStringValue:@"新闻" toViewController:myViewController];

页面变量的配置和上传

第一步:在 “事件和变量”中完成配置

参考上述场景示例,配合梳理业务需求并完成“指标+维度”的设计,确认需要将哪些变量设置为页面级变量,请勿直接开始代码的部署,需要先到 GrowingIO 后台找到 【数据管理】-【事件和变量】-【页面级变量】 功能,在界面中完成对应的配置。

自定义变量规范

在具体的将自定义变量添加到网站或者移动应用上之前,GrowingIO 要求先在打点管理的界面上进行变量的声明操作,然后在开展具体的添加自定义变量的操作。在自定义变量的声明界面上需要输入下列对所有变量来说通用的信息:

标识符

  • 标识符是代表某一个具体变量的一种具有唯一性要求的符号,标识符用来唯一的代表一个打点事件或者变量,即整个打点系统内部标识符在所有的变量和打点指标之间是唯一的。在新创建任何一种类型的变量的时候,这个新的变量的标识符不能跟任何一个已有变量和打点事件的标识符重复。在一个变量的标识符确定之后,在代码中就可以使用这个标识符来唯一代表该变量,请仔细检查确保声明的标识符和代码中使用标识符一致。如果出现了不一致的情况,GrowingIO 将视为没有收到声明了的变量的数据,而那个在代码中发送的跟声明中标识符不一样的变量的数据会被 GrowingIO 认为没有声明而丢弃。GrowingIO 虽然支持标识符的修改,但是不建议频繁修改,因为每一次标识符的修改都需要在声明界面和代码上同时作出修改,以保证标识符的一致性。

  • 标识符的设置细节规则如下

    • 自定义事件和所有自定义变量类型的标识符整体范围内不允许重名;

    • 标识符仅允许大小写英文、数字、下划线、以及英文冒号,并且不能以数字和冒号开头;

    • 标识符的长度限制在 50 个英文字符之内;

名称

  • 名称是变量具体在使用的时候显示在报表上的一种变量的称呼。客户给变量一个名称,这个名称会出现在报表界面上用以代指当前所设置的变量对应的维度。名称允许用户经常改动,需要注意的是,名称修改以后,对应的报表界面上的维度名称也会跟着修改。

  • 名称的设置细节:名称允许重名,可以使用大小写英文、中文以及各种符号,长度限制在 30 个字符之内。

描述

  • 可以使用较长的一段文字来描述某一个变量设置的目的,意义。

  • 描述的设置细节规则:描述允许重复,可以使用大小写英文、中文以及各种符号,长度限制在 150 个字符之内。

第二步:代码部署

完成了配置后,即可在代码中完成以上设计的 “自定义事件和变量” 的部署。具体的说,就是调用 GrowingIO 提供的 API 接口,上传数据。

API中给出了页面级变量的上传方式

第三步:数据校验

在完成了【数据管理】-【事件与变量】-【页面级变量】的配置,以及代码实施后,我们接下来需要对数据是否成功上传进行校验。校验工作分为两步完成。

数据校验第一步:本地开发环境校验

GrowingIO 提供了 SDK debug 模式以及 debug 工具,来帮助您完成数据的校验。具体请参考 Debugger 最佳实践

数据校验第二步:GrowingIO 后台图表验证

在 GrowingIO 分析后台,找到 “分析” - “新建事件分析”,然后在图表中选择您设计好的 “指标 + 维度”,页面级变量即对应的 "维度",查看是否有数据。当然,您需要首先确保页面级变量确实有被触发。

至此,您已经完成了 “自定义变量” 的上传,如您在配置或添加代码中有任何疑问,请联系您的客户成功经理咨询,或在工单系统中反馈问题。谢谢。