全域用户关联 API（IDM3.0-Golang）

SDK 版本需要 >= v2.1.0

用户关联

用户注册/登录

在全域用户关联业务中，用户标识通过 Bind 接口进行绑定。用户登录时调用 Bind() 绑定，第一个参数从详细的预置 id key 列表中获取，第二个参数为对应的具体用户 ID。例如，给用户（"ABCDEF123456789"）绑定手机号：

接口

// identity 为用户标识
func (sa *SensorsAnalytics) Bind(identity Identity) error

示例

identity := sdk.Identity{
    Identities: map[string]string{
        sdk.LOGIN_ID: "ABCDEF123456789",
        sdk.EMAIL:    "test@sensorsdata.cn",
    },
}
err = sa.Bind(identity)

用户解绑

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

接口

// identity 为用户标识
func (sa *SensorsAnalytics) UnBind(identity Identity) error

示例

identity := sdk.Identity{
    Identities: map[string]string{
        sdk.LOGIN_ID: "ABCDEF123456789",
        sdk.EMAIL:    "test@sensorsdata.cn",
    },
}
err = sa.UnBind(identity)

设置用户属性

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

记录用户属性

使用 ProfileSetById() 设置用户属性：

接口

// identity 为用户标识，properties 为要设置的用户属性
func (sa *SensorsAnalytics) ProfileSetById(identity Identity, properties map[string]interface{}) error

示例

identity := sdk.Identity{
    Identities: map[string]string{
        sdk.LOGIN_ID: "ABCDEF123456789",
    },
}
properties := map[string]interface{}{
    // 用户性别属性（Sex）为男性
    "Sex" : "Male",
    // 用户等级属性（Level）为 VIP
    "UserLevel" : "Elite VIP",
}
 
// 设置用户属性
err := sa.ProfileSetById(identity, properties)

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

记录初次设定的属性

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

接口

// identity 为用户标识，properties 为要设置的用户属性
func (sa *SensorsAnalytics) ProfileSetOnceById(identity Identity, properties map[string]interface{}) error

示例

identity := sdk.Identity{
    Identities: map[string]string{
        sdk.LOGIN_ID: "ABCDEF123456789",
    },
}
// 设置用户渠道属性（AdSource）为 "App Store"
properties := map[string]interface{}{
    "AdSource" : "App Store",
}
err = sa.ProfileSetOnceById(identity, properties)
 
properties = map[string]interface{}{
    "AdSource" : "Search Engine",
}
// 再次设置用户渠道属性（AdSource），设定无效，属性 "AdSource" 的值仍为 "App Store"
err = sa.ProfileSetOnceById(identity, properties)

数值类型的属性

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

接口

// identity 为用户标识，properties 为要设置的用户属性
func (sa *SensorsAnalytics) ProfileIncrementById(identity Identity, properties map[string]interface{}) error

示例

identity := sdk.Identity{
    Identities: map[string]string{
        sdk.LOGIN_ID: "ABCDEF123456789",
    },
}
properties := map[string]interface{}{
    "GamePlayed": 1,
}
// 设置用户游戏次数属性（GamePlayed），将次数累加1次
err := sa.ProfileIncrementById(identity, properties)

列表类型的属性

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

接口

// identity 为用户标识，properties 为要设置的用户属性，这个属性中应该只包含 value 为 [string] 的属性
func (sa *SensorsAnalytics) ProfileAppendById(identity Identity, properties map[string]interface{}) error

示例

identity := sdk.Identity{
    Identities: map[string]string{
        sdk.LOGIN_ID: "ABCDEF123456789",
    },
}
properties := map[string]interface{}{
    // 电影列表
    "Movies" : []string{"Sicario", "Love Letter"},
    // 游戏列表
    "Games" : []string{"Call of Duty", "Halo"},
}
 
// 传入properties，设置用户喜欢的电影属性（movies）和喜欢的游戏属性（games）
// 设置成功后，"Movies" 属性值为 ["Sicario", "Love Letter"]；"Games" 属性值为 ["Call of Duty", "Halo"]
err := sa.ProfileAppendById(identity, properties)
 
// 传入属性名称和需要插入属性的值，设置用户喜欢的电影属性（Movies）
// 设置成功后 "Movies" 属性值为 ["Sicario", "Love Letter", "Dead Poets Society"]
properties = map[string]interface{}{
    "Movies" : []string{"Dead Poets Society"},
}
err = sa.ProfileAppendById(identity, properties)
 
// 传入属性名称和需要插入属性的值，设置用户喜欢的电影属性（Movies），
// 但属性值 "Love Letter" 与已列表中已有元素重复，操作无效，
// "Movies" 属性值仍然为 ["Sicario", "Love Letter", "Dead Poets Society"]
properties = map[string]interface{}{
    "Movies" : []string{"Love Letter"},
}
err = sa.ProfileAppendById(identity, properties)

埋点事件采集

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

追踪事件

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

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

用户通过 TrackById() 接口记录事件，对于任何事件，必须包含用户标志符（Identity）和事件名（event）两个参数。用户可以在 TrackById() 的第三个参数传入一个 map[string]interface{} 对象，为事件添加自定义事件属性。以电商产品为例，可以这样追踪一次购物行为：

接口

// identity 是用户标识，event 是事件名，properties 是自定义事件属性
func (sa *SensorsAnalytics) TrackById(identity Identity, event string, properties map[string]interface{}) error

示例

event := "ViewProduct"
properties := map[string]interface{}{
    "$ip":            "2.2.2.2",
    "ProductId":      "123456",
    "ProductCatalog": "Laptop Computer",
    "IsAddedToFav":   true,
}
 
identity := sdk.Identity{
    Identities: map[string]string{
        sdk.LOGIN_ID: "test@sensorsdata.cn",
    },
}
err = sa.TrackById(identity, event, properties)