Erlang

本指南将会为您介绍如何使用 Erlang SDK 接入您的项目。

提示

在接入前, 请先阅读接入前准备。

最新版本为：1.1.0

更新时间为：2022-07-13

资源下载: 源代码 (opens new window)

一、集成SDK

1. 通过代码方式引入

下载 Erlang SDK，进行解压后可将 thinking_data 文件夹引入项目中，直接调用 SDK 对应的 module 进行使用，具体使用方式可以参考 SDK 中 example 文件夹中的示例文件。

2. 安装Logbus

我们推荐使用SDK+LogBus的形式，完成服务端数据的采集上报.您可以参考以下文档完成Logbus的安装:LogBus使用指南

二、初始化

以下是SDK初始化的示例代码:

%% 必须先调用init，SDK内部进行必要的初始化
ta_consumer_log:init(),
%% 配置写入文件的路径
ta_consumer_log:config_directory(LOG_DIRECTORY),
%% 配置完成之后，开始初始化 thinking_analytics_sdk 模块
%% 初始化SDK，传入上报方式类型
thinking_analytics_sdk:init(thinking_analytics_sdk:consumer_type_log()),

LOG_DIRECTORY为写入本地的文件夹地址。您只需将 LogBus 的监听文件夹地址设置为此处的地址，即可使用 LogBus 进行数据的监听上传。

三、常用功能

为了保证访客 ID 与账号 ID 能够顺利进行绑定，如果您的游戏中会用到访客 ID 与账号 ID，我们极力建议您同时上传这两个 ID，否则将会出现账号无法匹配的情况，导致用户重复计算，具体的 ID 绑定规则可参考用户识别规则一章。

3.1 发送事件

您可以调用track来上传事件，建议您根据先前梳理的文档来设置事件的属性以及发送信息的条件，以下是发送事件的示例代码:

%% 注意account_id 和 distinct_id 必须至少设置其中一个
%% 设置用户的ip地址，TA系统会根据IP地址解析用户的地理位置信息，如果不设置的话，则默认不上报
%% 设置事件发生的时间，如果不设置的话，则默认使用为当前时间。注意：#time的类型必须是timestamp()类型
%% 上报事件
thinking_analytics_sdk:track("account_id", "distinct_id", "EventName", #{"#ip" => "123.123.123.123", "#time" => os:timestamp()}),

• 事件的名称是字符串类型，只能以字母开头，可包含数字，字母和下划线 "_"，长度最大为 50 个字符。
• Key 为该属性的名称，为字符串类型，规定只能以字母开头，包含数字，字母和下划线 "_"，长度最大为 50 个字符，对字母大小写不敏感,TA会统一转化为小写字母
• Value 为该属性的值，支持字符串、数字、布尔、时间、对象、对象组、数组

用户属性的要求与事件属性保持一致

3.2 设置用户属性

对于一般的用户属性，您可以调用 user_set 来进行设置，使用该接口上传的属性将会覆盖原有的属性值，如果之前不存在该用户属性，则会新建该用户属性，类型与传入属性的类型一致，此处以设置用户名为例：

thinking_analytics_sdk:user_set("account_id", "distinct_id", #{"age" => 18, "abc" => ["a", "b", "c"]}),

四、最佳实践

以下示例代码包含以上所有操作，我们推荐按照如下步骤使用:

%% 必须先调用init，SDK内部进行必要的初始化
ta_consumer_log:init(),
%% 配置写入文件的路径
ta_consumer_log:config_directory(LOG_DIRECTORY),
%% 配置完成之后，开始初始化 thinking_analytics_sdk 模块
%% 初始化SDK
thinking_analytics_sdk:init(thinking_analytics_sdk:consumer_type_log()),

%% 注意account_id 和 distinct_id 必须至少设置其中一个
%% 设置用户的ip地址，TA系统会根据IP地址解析用户的地理位置信息，如果不设置的话，则默认不上报
%% 设置事件发生的时间，如果不设置的话，则默认使用为当前时间。注意：#time的类型必须是timestamp()类型
%% 上报事件
thinking_analytics_sdk:track("account_id", "distinct_id", "EventName", #{"#ip" => "123.123.123.123", "#time" => os:timestamp()}),

%% 设置用户属性
thinking_analytics_sdk:user_set("account_id", "distinct_id", #{"age" => 18, "abc" => ["a", "b", "c"]}),