🎨 优化 AdSpark 对应的帮助文档

FlutterAds · Jun 17, 2024 · 2a02380 · 2a02380
1 parent 936c794
commit 2a02380
Show file tree

Hide file tree

Showing 5 changed files with 252 additions and 41 deletions.
diff --git a/docs/start/guide/adspark/_meta.json b/docs/start/guide/adspark/_meta.json
@@ -1,4 +1,6 @@
 [
     "install",
-    "go"
+    "go",
+    "event_system",
+    "event_custom"
 ]
diff --git a/docs/start/guide/adspark/event_custom.mdx b/docs/start/guide/adspark/event_custom.mdx
@@ -0,0 +1,70 @@
+import { normalizeImagePath } from 'rspress/runtime';
+
+# 📌 自定义事件
+
+
+:::tip{title="💡 小提示"}
+
+ - 参考示例在`flutter_adspark/example` 下，可以先跑一下示例，看看需要哪些事件
+ - 自定义事件，插件内也内置了一些常用的可使用，参数自己决定
+ - Pro 版客户，如有问题随时联系我，提供技术支持
+
+:::
+
+## 自定义事件
+
+事件名称可以使用内置的也可以自己定义，参数是 `Map` 类型根据业务定义即可
+
+### 使用内置名称
+
+``` dart
+/// [eventName] 事件名称
+/// [params] 参数信息
+FlutterAdspark.addEvent(GrownEventType.order, params: {
+                        "orderId": "54323454323",
+                        "amount": 2000,
+                        "count": 1,
+                      });
+```
+
+### 自定义名称
+
+``` dart
+/// [eventName] 事件名称
+/// [params] 参数信息
+FlutterAdspark.addEvent("flutterads_adspark_click", params: {
+                        "name": "178083838",
+                        "amount": 200
+                      });
+```
+
+## 内置事件清单
+
+| 事件        | 调用                                  | 事件名称                             |
+|-------------|---------------------------------------|--------------------------------------|
+| 注册        | GrownEventType.register               | grown_attribution_event_register     |
+| 付费        | GrownEventType.purchase               | grown_attribution_event_purchase     |
+| 关键行为    | GrownEventType.key_behavior           | grown_attribution_event_key_behavior |
+| 下单        | GrownEventType.order                  | grown_attribution_event_order        |
+| 下载        | GrownEventType.download               | grown_attribution_event_download     |
+| 应用内拉起  | GrownEventType.deeplink               | grown_attribution_event_deelink      |
+| 授权        | GrownEventType.authorization          | grown_attribution_event_authorization|
+| 广告变现    | GrownEventType.ad_purchase            | grown_attribution_event_ad_purchase  |
+| 次留        | GrownEventType.retention_2d           | grown_attribution_event_retention_2d |
+| 添加购物车  | GrownEventType.add_to_cart            | grown_attribution_event_add_to_cart  |
+| 表单提交    | GrownEventType.form_submit            | grown_attribution_event_form_submit  |
+| 拉活        | GrownEventType.app_re_active_wake_up  | grown_attribution_event_app_re_active_wake_up |
+| 自定义激活  | GrownEventType.custom_activition      | grown_attribution_event_custom_activition |
+| 自定义注册  | GrownEventType.custom_register        | grown_attribution_event_custom_register |
+
+
+## 官方文档
+
+- [穿山甲～Android](https://bytedance.larkoffice.com/wiki/Yh8qwfiiIivBaKkYFYAcZedTnJf)
+- [穿山甲～iOS](https://bytedance.larkoffice.com/wiki/YcpCwVKdFi0VUxk4EAjc6TuJnre)
+- [巨量广告～文档](https://event-manager.oceanengine.com/docs/8650/195169)
+
+
+
+
+
diff --git a/docs/start/guide/adspark/event_system.mdx b/docs/start/guide/adspark/event_system.mdx
@@ -0,0 +1,171 @@
+import { normalizeImagePath } from 'rspress/runtime';
+
+# 🎯 系统事件
+
+
+:::tip{title="💡 小提示"}
+
+ - 参考示例在`flutter_adspark/example` 下，可以先跑一下示例，看看需要哪些事件
+ - 系统内置事件，也是根据业务需要去调用，参数必须按要求传
+ - Pro 版客户，如有问题随时联系我，提供技术支持
+
+:::
+
+## 👱🏻‍♂️ 账户信息
+
+
+### 注册事件
+
+``` dart
+/// [method] 注册方式
+/// [isSuccess] 是否成功
+FlutterAdspark.registerEvent("wechat", true);
+```
+
+### 登录事件
+
+``` dart
+/// [method] 登录方式
+/// [isSuccess] 是否成功
+FlutterAdspark.loginEvent("wechat", true);
+```
+
+### 设置用户标识
+
+``` dart
+/// [userUniqueId] 设置您自己的账号体系ID或设备ID, 并保证其唯一性
+FlutterAdspark.setUserUniqueID("userId_001");
+```
+
+### 清除用户标识
+
+``` dart
+FlutterAdspark.setUserUniqueID(null);
+```
+
+### 绑定社交账号
+
+``` dart
+/// [accountType] 账户类型
+/// [isSuccess] 是否成功
+FlutterAdspark.accessAccountEvent("wechat", true);
+```
+
+## 🛒 购物支付
+
+### 添加到购物车事件
+
+``` dart
+/// 添加到购物车事件
+/// [contentType] 商品类型
+/// [contentName] 商品名称
+/// [contentId] 商品ID
+/// [contentNum] 商品数量
+/// [isSuccess] 是否成功
+FlutterAdspark.addCartEvent("gift", "flower", "008", 2, true);
+```
+
+### 购买事件
+
+``` dart
+/// [contentType] 商品类型
+/// [contentName] 商品名称
+/// [contentId] 商品ID
+/// [contentNum] 商品数量
+/// [paymentChannel] 支付渠道
+/// [currency] 货币
+/// [isSuccess] 是否成功
+/// [currencyAmount] 货币数量
+FlutterAdspark.purchaseEvent("gift", "flower", "008", 2, "wechat", "¥", true, 99);
+```
+
+### 添加支付渠道
+
+``` dart
+/// [paymentChannel] 支付渠道
+/// [isSuccess] 是否成功
+FlutterAdspark.accessPaymentChannelEvent("wechat", true);
+```
+
+### 结账购买事件
+
+``` dart
+/// [contentType] 商品类型
+/// [contentName] 商品名称
+/// [contentId] 商品ID
+/// [contentNum] 商品数量
+/// [isVirtualCurrency] 是否虚拟货币
+/// [virtualCurrency] 虚拟货币
+/// [currency] 货币
+/// [isSuccess] 是否成功
+/// [currencyAmount] 货币数量
+FlutterAdspark.checkOutEvent("gift", "flower", "008", 2, false, "%%", "¥", true, 99);
+```
+
+### 添加到收藏事件
+
+``` dart
+/// [contentType] 商品类型
+/// [contentName] 商品名称
+/// [contentId] 商品ID
+/// [contentNum] 商品数量
+/// [isSuccess] 是否成功
+FlutterAdspark.addToFavoriteEvent("gift", "flower", "008", 2, true);
+```
+
+### 查看商品事件
+
+``` dart
+/// [contentType] 商品类型
+/// [contentName] 商品名称
+/// [contentId] 商品ID
+FlutterAdspark.viewContentEvent("gift", "flower", "008");
+```
+
+
+## 🎮 游戏关卡
+
+### 完成任务/副本/关卡事件
+
+``` dart
+/// [questId] 任务ID
+/// [questType] 任务类型
+/// [questName] 任务名称
+/// [questNo] 任务编号
+/// [isSuccess] 是否成功
+/// [description] 描述
+FlutterAdspark.questEvent("0001", "新手任务", "新手村砍野猪", 3, true, "其他描述");
+```
+
+### 创建游戏角色事件
+
+``` dart
+/// [gameRoleId] 游戏角色ID
+FlutterAdspark.createGameRoleEvent("11001");
+```
+
+### 更新等级事件
+
+``` dart
+/// [level] 等级
+FlutterAdspark.updateLevelEvent(3);
+```
+
+### 更新等级事件
+
+``` dart
+/// [level] 等级
+FlutterAdspark.updateLevelEvent(3);
+```
+
+
+## 官方文档
+
+- [穿山甲～Android](https://bytedance.larkoffice.com/wiki/Yh8qwfiiIivBaKkYFYAcZedTnJf)
+- [穿山甲～iOS](https://bytedance.larkoffice.com/wiki/YcpCwVKdFi0VUxk4EAjc6TuJnre)
+- [巨量广告～文档](https://event-manager.oceanengine.com/docs/8650/195169)
+
+
+
+
+
diff --git a/docs/start/guide/adspark/go.mdx b/docs/start/guide/adspark/go.mdx
@@ -20,12 +20,13 @@ import 'package:flutter_adspark/flutter_adspark.dart';
 
 /// [appId] 应用ID
 /// [channel] 渠道
-bool? result= await FlutterAdspark.init("appid", "huawei");
+/// [autoTrackEnabled] 是否开启自动采集
+bool? result= await FlutterAdspark.init("appid", "huawei", true);
 ```
 
 ## 事件上报
 
-> 激活事件由 SDK 初始化成功后自动触发
+> 激活事件由 SDK 初始化成功后自动触发，不需要自己上报
 
 ### 系统事件
 
@@ -36,8 +37,6 @@ bool? result= await FlutterAdspark.init("appid", "huawei");
 FlutterAdspark.registerEvent("wechat", true);
 ```
 
-> 其他事件参考[官方文档](#官方文档)
-
 ### 自定义事件
 
 ``` dart
@@ -50,44 +49,12 @@ FlutterAdspark.addEvent(GrownEventType.order, params: {
                       });
 ```
 
+## 更多事件
 
-### 常用事件
-
-> 如果够用，则直接使用，不沟通则自己传字符串即可
+> 内置了很多的事件和一些默认的事件名称，详细看下面的文档
 
-``` dart
-class GrownEventType {
-  //注册
-  static var register = "grown_attribution_event_register";
-  //付费
-  static var purchase = "grown_attribution_event_purchase";
-  //关键行为
-  static var key_behavior = "grown_attribution_event_key_behavior";
-  //下单
-  static var order = "grown_attribution_event_order";
-  //下载
-  static var download = "grown_attribution_event_download";
-  //应用内拉起
-  static var deeplink = "grown_attribution_event_deelink";
-  //授权
-  static var authorization = "grown_attribution_event_authorization";
-  //广告变现
-  static var ad_purchase = "grown_attribution_event_ad_purchase";
-  //次留
-  static var retention_2d = "grown_attribution_event_retention_2d";
-  //添加购物车
-  static var add_to_cart = "grown_attribution_event_add_to_cart";
-  //表单提交
-  static var form_submit = "grown_attribution_event_form_submit";
-  //拉活
-  static var app_re_active_wake_up =
-      "grown_attribution_event_app_re_active_wake_up";
-  //自定义激活
-  static var custom_activition = "grown_attribution_event_custom_activition";
-  //自定义注册
-  static var custom_register = "grown_attribution_event_custom_register";
-}
-```
+- [系统内置事件](/start/guide/adspark/event_system)
+- [自定义事件](/start/guide/adspark/event_custom)
 
 ## 官方文档
 

diff --git a/docs/start/guide/adspark/install.mdx b/docs/start/guide/adspark/install.mdx
@@ -48,6 +48,7 @@ import { normalizeImagePath } from 'rspress/runtime';
 |--|--|--|--|
 | ![](https://raw.githubusercontent.com/FlutterAds/flutter_adspark/master/example/images/img001.png) | ![](https://raw.githubusercontent.com/FlutterAds/flutter_adspark/master/example/images/img002.png) | ![](https://raw.githubusercontent.com/FlutterAds/flutter_adspark/master/example/images/img003.png) | ![](https://raw.githubusercontent.com/FlutterAds/flutter_adspark/master/example/images/img004.png) |
 
+> 仅 `debug` 模式会显示，线上 `release` 模式会自动关闭
 
 ## 通过本地安装插件