Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: tapdb #22

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: tapdb #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/tap-fun-db3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,11 +529,11 @@ TapDB.track("#battle", properties);
</Tabs>


## 设置通用事件属性
### 设置通用事件属性

对于某些重要的属性需要在每个上传的事件中出现，用户可以将这些属性设置为全局通用的自定义属性，包括静态通用属性和动态通用属性，静态通用属性为固定值，动态通用属性每次获取的值由用户所设置的计算逻辑产生。这些通用属性在注册之后，会被附带在TapDB上传的事件中。这里需要注意 trackEvent 中传入的属性优先级 > 动态通用属性优先级 > 静态通用属性优先级，也就是说动态通用属性会覆盖同名的静态通用属性。trackEvent 中的属性会覆盖同名的动态通用属性和静态通用属性。

### 添加静态通用属性
#### 添加静态通用属性

例如，添加来源渠道：

Expand Down Expand Up @@ -568,7 +568,7 @@ JSONObject commonProperties = new JSONObject();
</TabItem>
</Tabs>

### 删除静态通用属性
#### 删除静态通用属性

删除单个已添加的事件属性：

Expand Down Expand Up @@ -627,7 +627,7 @@ TapDB.clearStaticProperties();
</TabItem>
</Tabs>

### 添加动态通用属性
#### 添加动态通用属性

如果需要添加的通用属性的值在不同的上传事件中具有动态的赋值逻辑，那么可以调用 registerDynamicProperties 方法，注册相应的取值逻辑。以用户事件调用当前等级为例：

Expand Down Expand Up @@ -686,11 +686,11 @@ TapDB.registerDynamicProperties(



## 事件主体操作
### 事件主体操作

TapDB 目前支持两个事件主体：设备，账号。相应支持主体属性的操作为初始化，更新和累加。累加操作只支持数值类型。需要注意的是，传入的自定义属性需要同预登记属性名保持一致。

### 初始化
#### 初始化

初始化操作用于初始化属性。
已初始化的属性，后续的初始化操作会被忽略。
Expand Down Expand Up @@ -736,7 +736,7 @@ JSONObject properties = new JSONObject();

运行上述代码后，设备表的 `firstActiveServer` 字段值仍为 `server1`。

### 更新
#### 更新

更新操作用于更新属性。
该操作会覆盖原属性值。
Expand Down Expand Up @@ -780,7 +780,7 @@ JSONObject properties = new JSONObject();

运行上述代码后，设备表的 `currentPoints` 字段值为 `42`。

### 累加
#### 累加

累加操作用于增减属性，目前只支持数字属性。
该操作会在原属性值基础上累加数值，原属性不存在时，原属性值计为 0.
Expand Down