全域用户关联

全域用户关联介绍

全域用户关联，可以将同一用户的不同 ID 打通，以便贯通所有用户行为数据，方便系统地进行用户行为分析，支持用户标识之间的自由关联，同时直接解绑用户标识。

用户标识查看

可以通过「数据融合」→「用户表」→「配置用户关联」，进入配置用户关联页面，查看系统内的用户标识

在「配置用户关联」页面，点击「编辑」按钮，可以对用户标识进行添加、修改等操作。

全域用户关联明确了用户标识的语义，所有用户标识都需要先定义，再使用。如果数据中带了未定义的用户标识，则整条事件会拒绝入库。

预置用户标识清单

API 说明

Web

ID-Mapping 3.0 的各端最低支持版本

Web JS SDK v1.22.3 

当用户注册成功或登录成功时，需要调用 SDK 的 login() 方法。

sensors.login("登录 ID");

当有用户标识需要关联时调用，第一个参数从系统内「配置用户关联」页面获取，第二个参数为对应的具体用户标识的值。

调用接口后，对应的 key 和 value 会缓存在本地，后续采集的事件，均包含缓存的用户标识信息。

sensors.bind('$identity_mobile','187****8991')

当用户标识需要解绑时调用，第一个参数为取消关联的 key，第二个参数为对应的取消关联用户标识的值。

调用接口后，会发送相关的解绑事件，同时会将本地缓存的用户标识信息中，对应的 key-value 清除（若存在）。

sensors.unbind('$identity_mobile','187****8991')

小程序

ID-Mapping 3.0 的各端最低支持版本

微信小程序 SDK v1.17.6

当用户注册成功或登录成功时，需要调用 SDK 的 login() 方法。

sensors.login("登录 ID");

当有用户标识需要关联时调用，第一个参数从系统内「配置用户关联」页面获取，第二个参数为对应的具体用户标识的值。

调用接口后，对应的 key 和 value 会缓存在本地，后续采集的事件，均包含缓存的用户标识信息。

sensors.bind('$identity_mobile','187****8991')

当用户标识需要解绑时调用，第一个参数为取消关联的 key，第二个参数为对应的取消关联用户标识的值。

调用接口后，会发送相关的解绑事件，同时会将本地缓存的用户标识信息中，对应的 key-value 清除（若存在）。

sensors.unbind('$identity_mobile','187****8991')

当获取到用户关联的 OpenID 时调用，参数为对应的关联用户 OpenID 的值。(v1.18.3 及以上版本支持)

调用接口后，对应的 key 和 value 会缓存在本地，后续采集的事件，均包含缓存的 ID 信息。

sensors.bindOpenid('Openid')

当用户解绑 OpenID 时调用，参数为对应的关联用户 OpenID 的值。(v1.18.3 及以上版本支持)

调用接口后，会发送相关的解绑事件，同时会将本地缓存的 ID 信息中，对应的 key-value 清除（若存在）。

sensors.unbindOpenid('Openid')

当用户关联微信用户 UnionID 时调用，参数为对应的关联用户 UnionID 的值。(v1.18.3 及以上版本支持)

调用接口后，对应的 key 和 value 会缓存在本地，后续采集的事件，均包含缓存的 ID 信息。

sensors.bindUnionid('Unionid')

当用户解绑 UnionID 时调用，参数为对应的关联用户 UnionID 的值。(v1.18.3 及以上版本支持)

调用接口后，会发送相关的解绑事件，同时会将本地缓存的 ID 信息中，对应的 key-value 清除（若存在）。

sensors.unbindUnionid('Unionid')

Android

ID-Mapping 3.0 的各端最低支持版本

Android SDK v6.3.0

当用户注册成功或登录成功时，需要调用 SDK 的 login() 方法。

 SensorsDataAPI.sharedInstance().login("登录 ID");

当有用户标识需要关联时调用，第一个参数从系统内「配置用户关联」页面获取，第二个参数为对应的具体用户标识的值。

调用接口后，对应的 key 和 value 会缓存在本地，后续采集的事件，均包含缓存的用户标识信息。

SensorsDataAPI.sharedInstance().bind("$identity_mobile","187****8991")

当用户标识需要解绑时调用，第一个参数为取消关联的 key，第二个参数为对应的取消关联用户标识的值。

调用接口后，会发送相关的解绑事件，同时会将本地缓存的用户标识信息中，对应的 key-value 清除（若存在）。

SensorsDataAPI.sharedInstance().unbind("$identity_mobile","187****8991")

iOS

ID-Mapping 3.0 的各端最低支持版本

iOS SDK v4.3.0

当用户注册成功或者进行登录时，需要调用 SDK 的 login() 方法。

 [[SensorsAnalyticsSDK sharedInstance] login:@"<#登录 ID#>"];

当有用户标识需要关联时调用，第一个参数从系统内「配置用户关联」页面获取，第二个参数为对应的具体用户标识的值。

调用接口后，对应的 key 和 value 会缓存在本地，后续采集的事件，均包含缓存的用户标识信息。

[[SensorsAnalyticsSDK sharedInstance] bind:@"$identity_mobile" value:@"187****8991"];

当用户标识需要解绑时调用，第一个参数为取消关联的 key，第二个参数为对应的取消关联用户标识的值。

调用接口后，会发送相关的解绑事件，同时会将本地缓存的用户标识信息中，对应的 key-value 清除（若存在）。

[[SensorsAnalyticsSDK sharedInstance] unbind:@"$identity_mobile" value:@"187****8991"];

Java

ID-Mapping 3.0 的各端最低支持版本

Java SDK v3.4.3

调用接口后，会发送相关的绑定事件。对应的 key 和 value 不会缓存在本地，后续采集的事件，均不包含绑定的 ID 信息。

bind 接口需要至少传入两个 ID 信息，单一 ID 信息无法完成绑定操作

SensorsAnalyticsIdentity identity = SensorsAnalyticsIdentity.builder()
        .addIdentityProperty("$identity_mobile", "123")
		.addIdentityProperty("$identity_email", "a@a.com")
        .build();
sa.bind(identity);

用户标识取消关联时调用，参数 key 为取消关联的 key，value 为对应的取消关联用户标识的值。

调用接口后，会发送相关的解绑事件。

SensorsAnalyticsIdentity identity = SensorsAnalyticsIdentity.builder()
        .addIdentityProperty("$identity_mobile", "123")
        .build();
sa.unbind(identity);

C#

ID-Mapping 3.0 的各端最低支持版本

C# SDK v2.1.0

调用接口后，会发送相关的绑定事件。对应的 key 和 value 不会缓存在本地，后续采集的事件，均不包含绑定的 ID 信息。

Bind 接口需要传递 Identity 列表，列表中至少要包含 2 个值。

List identities = SensorsAnalyticsIdentityHelper.CreateBuilder()
         .AddIdentityProperty("$identity_mobile", "123")
         .AddIdentityProperty("$identity_email", "a@a.com")
		 .Build();
sa.bind(identities)

用户标识取消关联时调用，参数 key 为取消关联的 key，value 为对应的取消关联用户标识的值。

调用接口后，会发送相关的解绑事件。

SensorsAnalyticsIdentity identity = new SensorsAnalyticsIdentity("$identity_mobile", "123")
sa.unbind(identity);