flutter_growingio_track 0.0.3

Flutter Plugin For GrowingIO SDK, is used for calling GrowingIO api in flutter.

flutter_growingio_track

GrowingIO的埋点版本flutter插件.

一: 集成

1. Flutter插件获取安装

根据dart pub文档获取安装

2. Android集成(Native部分)

此Flutter插件运行在Android手机上时依赖于GrowingIO Android SDK(可以是无埋点SDK也可以是埋点SDK)2.6.0及以上, 原生部分请参考Android官方文档集成SDK部分(无埋点) 或 Android官方文档集成SDK部分(埋点)接入集成.

可以参考仓库中的example项目.

3. iOS集成(Native部分)

1, 选择SDK集成方式 (1).>使用 CocoaPods 快速集成

 >添加pod 'GrowingCoreKit' 到Podfile中
 >执行pod update,不要用--no-repo-update选项

(2).手动集成方式

>获取sdk zip包,解压iOS SDK压缩文件
>将Growing.h 和GrowingCoreKit添加到iOS工程  

2，设置URL Scheme与初始化SDK（必选）

  参考官网文档：https://docs.growingio.com/docs/sdk-integration/ios-sdk/#2-she-zhi-url-scheme

4. Tips

4.1 IOS: App Store 提交应用

如果您添加了库AdSupport.framework, GrowingIO则会启用 IDFA，所以在向 App Store 提交应用时，需要：

• 对于问题 Does this app use the Advertising Identifier (IDFA)，选择 YES。
• 对于选项Attribute this app installation to a previously served advertisement，打勾。
• 对于选项Attribute an action taken within this app to a previously served advertisement，打勾。

4.2 IOS: 为什么 GrowingIO使用IDFA

GrowingIO 使用 IDFA 来做来源管理激活设备的精确匹配，让你更好的衡量广告效果。如果你不希望跟踪这个信息，可以选择不引入 AdSupport.framework

4.3 Android: 初始化Android SDK时, GrowingIO类可能会报红色

这个应该是Flutter项目结构的问题， 并不影响运行， 可以放心编译. 不过需要手动import-_-|

4.4 为什么不在flutter中单独初始化

• 因为GrowingIO需要获取Android的Activity生命周期， 为了数据的准确性， 需要在Activity出现前就初始化完成
• 开发者相信很多用户都会使用flutter + native形式的进行开发， 为了同时服务flutter于native

二: API

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

import 'package:flutter_growingio_track/growingio_track.dart';

具体参数限制请参见GrowingIO官网文档。

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

   参数	是否必填	说明
   eventId	是	事件Id
   num	否	数值, double型
   variable	否	变量, Map型

   调用示例:

   import 'package:growingioflutter/growingio_track.dart';
       
   GrowingIO.track('eventId');
   GrowingIO.track('testEventId', num: 23.0, variable: {'testKey': 'testValue', 'testNumKey': 233});
   GrowingIO.track('eventId', num: 23.0);
   GrowingIO.track('eventId', variable: {'testkey': 'testValue', 'testNumKey': 2333});
   

2. setEvar发送转化变量, 对应于evar事件

   函数原型为: setEvar(Map<String, dynamic> variable), 调用示例:

   GrowingIO.setEvar({
     'testKey': 'testValue', 'testNumKey': 2333.0
   });
   

3. setPeopleVariable发送用户变量, 对应于ppl事件

   函数原型为: setPeopleVariable(Map<String, dynamic> variable)

   调用示例:

   GrowingIO.setPeopleVariable({
     'testKey': 'testValue', 'testNumKey': 2333.0
   });
   

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

   参数	类型	描述
   userId	String	登录用户Id

   函数原型: setUserId(String userId)

   调用示例:

   GrowingIO.setUserId("testUserId");
   

5. clearUserId清楚登录用户Id

   函数原型: clearUserId()

   调用示例:

   GrowingIO.clearUserId();
   

6. setVisitor设置访问用户变量, 对应于vstr事件

   函数原型: setVisitor(Map<String, dynamic> variable)

   调用示例:

   GrowingIO.setVisitor({
   	  "visitorKey": 'key', "visitorValue": 34
   	});