Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit f2b9977

Browse files
author
梁登科
committed
update readme
1 parent 3cbbcdf commit f2b9977

File tree

2 files changed

+28
-161
lines changed

2 files changed

+28
-161
lines changed

‎README.md‎

Lines changed: 26 additions & 159 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
1-
GrowingIO的埋点版本flutter插件.
1+
# flutter_growingio_track
22

3+
[![VersionPub](https://img.shields.io/pub/v/flutter_growingio_track.svg?colorB=blue)](https://pub.dartlang.org/packages/flutter_growingio_track)
34

4-
# 集成
5+
GrowingIO的埋点版本flutter插件.
56

7+
# 一: 集成
8+
## 1. Flutter插件获取安装
9+
根据[dart pub](https://pub.dartlang.org/packages/flutter_growingio_track#-installing-tab-) 文档获取安装
610

7-
## Android集成
11+
## 2. Android集成(Native部分)
812

913
此Flutter插件可支持track版本与auto-track版本的GrowingIO SDK使用, 请根据需要自行选择搭配
1014

11-
### 添加Android依赖
15+
### 1.1 添加Android依赖
1216
#### 依赖纯打点版本
1317
纯打点版本(track)版本, 需要依赖track版本的SDK
1418

1519
dependencies{
1620
implementation 'com.growingio.android:vds-android-agent:track-2.6.0'
1721
}
1822

19-
### 无埋点版本
23+
### 1.2 无埋点版本
2024
无埋点版本(auto-track)版本, 需要依赖于auto-track版本的SDK并且需要配置Gradle插件
2125

2226
*配置ClassPath:*
@@ -43,7 +47,7 @@ GrowingIO的埋点版本flutter插件.
4347
compile 'com.growingio.android:vds-android-agent:autotrack-2.6.0@aar'
4448
}
4549

46-
### 获取projectId与UrlScheme
50+
### 2. 获取projectId与UrlScheme
4751

4852
在GrowingIO官网应用管理创建Android应用, 跳转界面后可以发现包含projectId与UrlSchema的代码片段, 请粘贴到项目对应位置:
4953

@@ -75,7 +79,7 @@ GrowingIO的埋点版本flutter插件.
7579
具体配置请参见项目的example配置
7680

7781

78-
### 初始化SDK
82+
### 3. 初始化SDK
7983

8084
GrowingIO的SDK需要在Application的onCreate中初始化:
8185

@@ -89,7 +93,7 @@ GrowingIO的SDK需要在Application的onCreate中初始化:
8993
如果flutter项目没有自定义Application, 需要用户自己手动添加一个AndroidApplication, 可参照example
9094

9195

92-
### tip
96+
### 4. tip
9397

9498
1. 为什么Android项目里面高亮GrowingIO的类会出现报红色
9599

@@ -101,7 +105,11 @@ GrowingIO的SDK需要在Application的onCreate中初始化:
101105
- 开发者相信很多用户都会使用flutter + native形式的进行开发, 为了同时服务flutter于native
102106

103107

104-
# API
108+
109+
## 3. iOS集成(Native部分)
110+
集成方式见Word文档:Flutter-iOS集成文档
111+
112+
# 二: API
105113

106114
在dart中调用GrowingIO的函数, 需要先import对应的包
107115

@@ -111,45 +119,11 @@ GrowingIO的SDK需要在Application的onCreate中初始化:
111119

112120
1. track发送自定义事件, 对应于cstm事件
113121

114-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
115-
116-
117-
<colgroup>
118-
<col class="org-left" />
119-
120-
<col class="org-left" />
121-
122-
<col class="org-left" />
123-
</colgroup>
124-
<tbody>
125-
<tr>
126-
<td class="org-left">参数</td>
127-
<td class="org-left">是否必填</td>
128-
<td class="org-left">说明</td>
129-
</tr>
130-
131-
132-
<tr>
133-
<td class="org-left">eventId</td>
134-
<td class="org-left">必填</td>
135-
<td class="org-left">事件Id</td>
136-
</tr>
137-
138-
139-
<tr>
140-
<td class="org-left">num</td>
141-
<td class="org-left">否</td>
142-
<td class="org-left">数值, double型</td>
143-
</tr>
144-
145-
146-
<tr>
147-
<td class="org-left">variable</td>
148-
<td class="org-left">否</td>
149-
<td class="org-left">参数, Map型</td>
150-
</tr>
151-
</tbody>
152-
</table>
122+
| 参数 | 是否必填 | 说明 |
123+
|----------|----------|----------------|
124+
| eventId | 是 | 事件Id |
125+
| num | 否 | 数值, double型 |
126+
| variable | 否 | 变量, Map型 |
153127

154128
调用示例:
155129

@@ -181,32 +155,10 @@ GrowingIO的SDK需要在Application的onCreate中初始化:
181155

182156
4. setUserId设置登录用户Id, 对应于cs1字段
183157

184-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
185-
186-
187-
<colgroup>
188-
<col class="org-left" />
189-
190-
<col class="org-left" />
191-
192-
<col class="org-left" />
193-
</colgroup>
194-
<tbody>
195-
<tr>
196-
<td class="org-left">参数</td>
197-
<td class="org-left">类型</td>
198-
<td class="org-left">描述</td>
199-
</tr>
200-
201-
202-
<tr>
203-
<td class="org-left">userId</td>
204-
<td class="org-left">String</td>
205-
<td class="org-left">登录用户Id</td>
206-
</tr>
207-
</tbody>
208-
</table>
209-
158+
| 参数 | 类型 | 描述 |
159+
| ----- | ------ | ----- |
160+
| userId | String | 登录用户Id |
161+
210162
函数原型: setUserId(String userId)
211163

212164
调用示例:
@@ -231,88 +183,3 @@ GrowingIO的SDK需要在Application的onCreate中初始化:
231183
"visitorKey": 'key', "visitorValue": 34
232184
});
233185

234-
## iOS集成
235-
集成方式见Word文档:Flutter-iOS集成文档
236-
## iOS调用
237-
238-
调用方式与安卓一致
239-
调用示例:
240-
241-
import 'package:flutter_growingio_track/growingio_track.dart';
242-
243-
GrowingIO.track('eventId');
244-
GrowingIO.track('testEventId', num: 23.0, variable: {'testKey': 'testValue', 'testNumKey': 233});
245-
GrowingIO.track('eventId', num: 23.0);
246-
GrowingIO.track('eventId', variable: {'testkey': 'testValue', 'testNumKey': 2333});
247-
248-
2. setEvar发送转化变量, 对应于evar事件
249-
250-
函数原型为: setEvar(Map<String, dynamic> variable),
251-
调用示例:
252-
253-
GrowingIO.setEvar({
254-
'testKey': 'testValue', 'testNumKey': 2333.0
255-
});
256-
257-
3. setPeopleVariable发送用户变量, 对应于ppl事件
258-
259-
函数原型为: setPeopleVariable(Map<String, dynamic> variable)
260-
261-
调用示例:
262-
263-
GrowingIO.setPeopleVariable({
264-
'testKey': 'testValue', 'testNumKey': 2333.0
265-
});
266-
267-
4. setUserId设置登录用户Id, 对应于cs1字段
268-
269-
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
270-
271-
272-
<colgroup>
273-
<col class="org-left" />
274-
275-
<col class="org-left" />
276-
277-
<col class="org-left" />
278-
</colgroup>
279-
<tbody>
280-
<tr>
281-
<td class="org-left">参数</td>
282-
<td class="org-left">类型</td>
283-
<td class="org-left">描述</td>
284-
</tr>
285-
286-
287-
<tr>
288-
<td class="org-left">userId</td>
289-
<td class="org-left">String</td>
290-
<td class="org-left">登录用户Id</td>
291-
</tr>
292-
</tbody>
293-
</table>
294-
295-
函数原型: setUserId(String userId)
296-
297-
调用示例:
298-
299-
GrowingIO.setUserId("testUserId");
300-
301-
5. clearUserId清楚登录用户Id
302-
303-
函数原型: clearUserId()
304-
305-
调用示例:
306-
307-
GrowingIO.clearUserId();
308-
309-
6. setVisitor设置访问用户变量, 对应于vstr事件
310-
311-
函数原型: setVisitor(Map<String, dynamic> variable)
312-
313-
调用示例:
314-
315-
GrowingIO.setVisitor({
316-
"visitorKey": 'key', "visitorValue": 34
317-
});
318-

‎pubspec.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: flutter_growingio_track
22
description: Flutter Plugin For GrowingIO track
3-
version: 2.6.0
3+
version: 0.0.1
44
author: ldk <ldkxingzhe@gmail.com>
55
homepage: https://www.growingio.com
66

@@ -18,4 +18,4 @@ dependencies:
1818
flutter:
1919
plugin:
2020
androidPackage: com.growingio.plugin.fluttergrowingiotrack
21-
pluginClass: FlutterGrowingIOTrackPlugin
21+
pluginClass: FlutterGrowingIOTrackPlugin

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /