SDK 版本需要 >= v2.0.0

1. 用户关联

在服务端应用中,神策分析也要求为每个事件设置用户的 Distinct Id,这有助于神策分析提供更准确的留存率等数据。

对于注册用户,推荐使用系统中的用户 ID 作为 Distinct Id,不建议使用用户名、Email、手机号码等可以被修改的信息。

所有的 track 和 profile 系列方法都必须同时指定用户 ID 及用户 ID 是否为登录 ID 这两个参数,以便明确告知神策分析用户 ID 的类型。

1.1. 用户注册/登录

用户登录时调用 bind() 绑定,第一个参数从详细的预置 id key 列表中获取。例如,给用户("ABCDEF123456789")绑定手机号:

<?php  
	$identity = new SensorsAnalyticsIdentity(array('$identity_login_id' => 'ABCDEF123456789','$identity_mobile' => '123')) ;
	$sa -> bind($identity); 
?>
PHP


多用户 ID 取消关联时调用  unbind() 解绑,第一个参数为取消关联的 key,第二个参数为对应的取消关联用户 ID

<?php  
	$identity = new SensorsAnalyticsIdentity(array('$identity_mobile' => '123')) ;
	$sa -> unbind($identity); 
?>
PHP

2. 设置用户属性

为了更准确地提供针对人群的分析服务,神策分析 SDK 可以设置用户属性,如年龄、性别等。用户可以在留存分析、分布分析等功能中,使用用户属性作为过滤条件或以用户属性作为维度进行多维分析。

2.1. 记录用户属性

使用 profile_set_by_id() 设置用户属性:

<?php
	$identity = new SensorsAnalyticsIdentity(array('$identity_login_id' => 'iu001'));
    $properties = array(
		# 用户性别属性(Sex)为男性
		'Sex' => 'Male',
		# 用户等级属性(Level)为 VIP
	'UserLevel' => 'Elite VIP',
	);

	# 设置用户属性
	$sa->profile_set_by_id($identity, $properties);
?>
PHP

对于不再需要的用户属性,可以通过 profile_unset_by_id() 接口将属性删除。用户属性中,属性名称与属性值的约束条件与事件属性相同,详细说明请参考 数据格式

2.2. 记录初次设定的属性

对于只在首次设置时有效的属性,我们可以使用 profile_set_once_by_id() 记录这些属性。与 profile_set_by_id() 接口不同的是,如果被设置的用户属性已存在,则这条记录会被忽略而不会覆盖已有数据,如果属性不存在则会自动创建。因此,profile_set_once_by_id() 比较适用于为用户设置首次激活时间、首次注册时间等属性。例如:

<?php
	$identity = new SensorsAnalyticsIdentity(array('$identity_login_id' => 'ABCDEF123456789'));
    # 设置用户渠道属性(AdSource)为 "App Store"
	$sa->profile_set_once_by_id($identity, array('AdSource' => 'App Store'));

	# 再次设置用户渠道属性(AdSource),设定无效,属性 "AdSource" 的值仍为 "App Store"
	$sa->profile_set_once_by_id($identity, array('AdSource' => 'Search Engine'));
?>
PHP

2.3. 数值类型的属性

对于数值型的用户属性,可以使用 profile_increment() 对属性值进行累加。常用于记录用户付费次数、付费额度、积分等属性。例如:

<?php
	$identity = new SensorsAnalyticsIdentity(array('$identity_login_id' => 'ABCDEF123456789'));  
	# 设置用户游戏次数属性(GamePlayed),将次数累加1次
	$sa->profile_increment_by_id($identity, array('GamePlayed' => 1));
?>
PHP

2.4. 列表类型的属性

对于用户喜爱的电影、用户点评过的餐厅等属性,可以记录列表型属性。需要注意的是,列表型属性中的元素必须为 string 类型,且元素的值会自动去重。关于列表类型限制请见 数据格式

<?php  
	$identity = new SensorsAnalyticsIdentity(array('$identity_login_id' => 'ABCDEF123456789'));
 
	// 传入properties,设置用户喜欢的电影属性(movies)和喜欢的游戏属性(games)
	// 设置成功后,"Movies" 属性值为 ["Sicario", "Love Letter"];"Games" 属性值为 ["Call of Duty", "Halo"]
	$sa->profile_append_by_id($identity, array('Movies' => array('Sicario','Love Letter'),'Games' => array('Call of Duty', 'Halo')));
 
	// 传入属性名称和需要插入属性的值,设置用户喜欢的电影属性(Movies)
	// 设置成功后 "Movies" 属性值为 ["Sicario", "Love Letter", "Dead Poets Society"]
	$sa->profile_append_by_id($identity, array('Movies' => array('Dead Poets Society')));
 
	// 传入属性名称和需要插入属性的值,设置用户喜欢的电影属性(Movies),
	// 但属性值 "Love Letter" 与已列表中已有元素重复,操作无效,
	// "Movies" 属性值仍然为 ["Sicario", "Love Letter", "Dead Poets Society"]
	$sa->profile_append_by_id($identity, array('Movies' => array('Love Letter')));
?>
PHP

3. 埋点事件采集

在 SDK 初始化完成之后,您可以通过以下接口进行数据埋点。

3.1. 追踪事件

第一次接入神策分析时,建议先追踪 3~5 个关键的事件,只需要几行代码,便能体验神策分析的分析功能。例如:

  • 图片社交产品,可以追踪用户浏览图片和评论事件
  • 电商产品,可以追踪用户注册、浏览商品和下订单等事件

用户通过 track_by_id() 接口记录事件,对于任何事件,必须包含用户标志符identity)、事件名event_name)两个参数。同时,用户可以在 track_by_id() 的第三个参数传入一个 object 对象,为事件添加自定义事件属性。以电商产品为例,可以这样追踪一次购物行为:

<?php
	$identity = new SensorsAnalyticsIdentity(array('$identity_login_id' => '123')) ;

	$properties = array(
		# '$time' 属性是系统预置属性,传入毫秒表示的 Timestamp,表示事件发生的时间,如果不填入该属性,则默认使用系统当前时间
		'$time' => (int)(microtime(true) * 1000), # 对于windows用户需要这样定义 '$time' => substr((microtime(true) * 1000), 0, 13)
		# '$ip' 属性是系统预置属性,如果服务端中能获取用户 IP 地址,并填入该属性,神策分析会自动根据 IP 地址解析用户的省份、城市信息
		'$ip' => '123.123.123.123',
		# 商品 ID
		'ProductId' => '123456',
		# 商品类别
		'ProductCatalog' => 'Laptop Computer',
		# 是否加入收藏夹,Boolean 类型的属性
		'IsAddedToFav' => true,
	);

	# 记录用户浏览商品事件
	$sa->track_by_id($identity, 'ViewProduct', $properties);

	$properties = array(
		# 用户 IP 地址
		'$ip' => '123.123.123.123',
		# 商品 ID 列表,list<str> 类型的属性
		'ProductIdList' => array('123456', '234567', '345678'),
		# 订单价格
		'OrderPaid' => 12.10,
	);

	# 记录用户订单付款事件
	$sa->track_by_id($identity, 'PaidOrder', $properties);  
	$sa->flush();
?>
PHP