Skip to content

Commit 10e95ab

Browse files
authored
docs: update docs (#46)
1 parent 366f465 commit 10e95ab

File tree

1 file changed

+2
-31
lines changed

1 file changed

+2
-31
lines changed

README.md

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -18,31 +18,21 @@ Java SDK 源码托管在 [growingio/growingio-java-sdk](https://github.com/growi
1818
GrowingIO提供在Server端部署的SDK,从而可以方便的进行事件上报等操作。
1919
> 支持 java 7+, 如需支持java 6参见 [支持 Java 6 版本环境](#支持-java-6-版本环境)
2020
21-
:::info
21+
2222
Java SDK从1.0.10-cdp版本开始使用v3协议进行事件上报, 使用前确认平台版本支持v3协议
2323

2424
支持的平台版本为 OP-13.6、OP-14.x、OP-2.x 版本
25-
:::
25+
2626

2727
### 集成准备
2828

2929
#### 获取SDK初始化必传参数:AccountID、DataSourceID、Host
3030

31-
:::info
3231
AccountID:项目ID,代表一个项目<br/>
3332
DataSourceID:数据源ID,代表一个数据源<br/>
3433
Host:采集数据上报的服务器地址,非平台地址<br/>
3534

3635
AccountID、DataSourceID 需要在CDP增长平台上新建数据源,或从已创建的数据源中获取, 如不清楚或无权限请联系您的专属项目经理或技术支持
37-
:::
38-
39-
##### 创建
40-
41-
<ImageLoader path="img/common/createapplication" />
42-
43-
##### 查看
44-
45-
<ImageLoader path="img/common/showServerDataSourceID" />
4636

4737
### 依赖
4838

@@ -141,11 +131,9 @@ ab.connection.timeout=5000
141131
ab.read.timeout=5000
142132
```
143133

144-
:::info 注意
145134
请按照您的项目情况修改`api.host``project.id`。<br/>
146135
run.mode 表示运行模式。当值为 test 时,仅输出消息体,不发送采集数据;当值为 production 时, 才向发送采集数据。
147136

148-
:::
149137

150138
#### 事件消息
151139

@@ -202,9 +190,7 @@ private static GrowingAPI project = new GrowingAPI.Builder().setProjectKey("your
202190

203191
发送一个埋点事件。在添加发送的埋点事件代码之前,需在CDP平台事件管理界面创建埋点事件以及关联事件属性。
204192

205-
:::info
206193
* 当需要标记用户ID类型时,请先进行规划,并在平台的数据中心,添加新的用户身份类型,再设置userkey,误设会影响数据质量。
207-
:::
208194

209195
**参数说明**
210196

@@ -262,20 +248,12 @@ GioCdpEventMessage msg = new GioCdpEventMessage.Builder()
262248
.build()
263249
```
264250

265-
:::info
266-
267-
详细使用示例:[埋点事件示例](/knowledge/basicknowledge/trackEventUse#埋点事件示例)
268-
269-
:::
270-
271251
### 登录用户属性事件
272252

273253
以登录用户的身份定义登录用户属性,比如年龄、性别、会员等级等,用于用户信息相关分析。<br/>
274254
在添加登录用户属性代码之前,需要在CDP平台用户管理界面中创建用户属性
275255

276-
:::info
277256
* 当需要标记用户ID类型时,请先进行规划,并在平台的数据中心,添加新的用户身份类型,再设置userkey,误设会影响数据质量。
278-
:::
279257

280258
**参数说明**
281259

@@ -305,13 +283,6 @@ GioCdpUserMessage msg = new GioCdpUserMessage.Builder()
305283
.build();
306284
```
307285

308-
:::info
309-
310-
详细使用示例:[用户属性事件示例](/knowledge/basicknowledge/trackEventUse#用户属性事件示例)
311-
312-
:::
313-
314-
315286
### 维度表
316287

317288
上传一个维度表记录。在添加所需要上传维度表记录代码之前,需要在维度表管理界面中创建对应维度表及其属性

0 commit comments

Comments
 (0)