Flutter集成SDK插件singular_flutter_sdk的使用

目录

• 基本集成
• 跟踪事件
• 跟踪收入
• 实现深度链接
• 添加SKAdNetwork支持
• 跟踪卸载

支持的平台

• Android
• iOS

插件版本

• iOS SingularSDK v12.6.0
• Android SingularSDK v12.6.0

基本集成

在Flutter项目中添加Singular SDK插件，首先需要在pubspec.yaml文件中添加以下依赖：

dependencies:
  singular_flutter_sdk: ^1.5.1

然后在项目的终端运行以下命令来获取包：

flutter packages get

在初始化Singular SDK之前，您需要创建一个包含您的API密钥和API密钥的秘密的SingularConfig对象。您可以选择启用各种SDK功能。

示例代码：

import 'package:singular_flutter_sdk/singular.dart';
import 'package:singular_flutter_sdk/singular_config.dart';

void main() {
  SingularConfig config = new SingularConfig('API_KEY', 'API_SECRET');
  config.customUserId = "test@test.com";
  Singular.start(config);
}

跟踪事件

您可以使用event和eventWithArgs方法向Singular发送事件。

示例代码：

Singular.event("eventName");

Singular.eventWithArgs("eventName", {"level-up": "5"});

跟踪收入

报告自定义事件到Singular或报告应用内购买事件。

示例代码：

报告自定义收入事件

Singular.customRevenue("MyCustomRevenue", "USD", 5.50);

报告应用内购买事件

import 'package:singular_flutter_sdk/singular_iap.dart';

// For iOS
final singularPurchaseIOS = SingularIOSIAP(
  product.price,
  product.currencyCode,
  purchase.productId,
  purchase.purchaseId,
  purchase.verificationData.serverVerificationData
);

// For Android
final singularPurchaseAndroid = SingularAndroidIAP(
  product.price,
  product.currencyCode,
  purchase.signature,
  purchase.verificationData.serverVerificationData
);

Singular.inAppPurchase("purchaseEventName", singularPurchaseIOS); // or singularPurchaseAndroid for Android

实现深度链接

为了启用Singular Links，在iOS和Android上查看Singular Links Prerequisites。

处理Singular链接的示例代码：

SingularConfig config = new SingularConfig('API_KEY', 'API_SECRET');
config.singularLinksHandler = (SingularLinkParams params) {
    String deeplink = params.deeplink;
    String passthrough = params.passthrough;
    bool isDeferred = params.isDeferred;
    Map urlParameters = params.urlParameters;
    // 在这里添加处理深度链接的代码
};
Singular.init(config);

iOS先决条件

Objective-C

在AppDelegate.m中添加以下内容：

#import "SingularAppDelegate.h"

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  [GeneratedPluginRegistrant registerWithRegistry:self];
  [SingularAppDelegate shared].launchOptions = launchOptions;
  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

- (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray<id<UIUserActivityRestoring>> *restorableObjects))restorationHandler {
  [[SingularAppDelegate shared] continueUserActivity:userActivity restorationHandler:restorationHandler];
  return YES;
}

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
    [[SingularAppDelegate shared] handleOpenUrl:url options:options];
    return YES;
}

Swift

import singular_flutter_sdk

override func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
    if let singularAppDelegate = SingularAppDelegate.shared() {
        singularAppDelegate.launchOptions = launchOptions
    }
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
}
    
override func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([Any]?) -> Void) -> Bool {
    if let singularAppDelegate = SingularAppDelegate.shared() {
        singularAppDelegate.continueUserActivity(userActivity, restorationHandler:nil)
    }
    return super.application(application, continue:userActivity, restorationHandler: restorationHandler)
}
    
override func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    if let singularAppDelegate = SingularAppDelegate.shared() {
        singularAppDelegate.handleOpen(url, options: options)
    }
   return true
}

Android先决条件

Java

在MainActivity.java中添加以下内容：

import com.singular.flutter_sdk.SingularBridge;

@Override
protected void onNewIntent(@NonNull Intent intent) {
  super.onNewIntent(intent);
  SingularBridge.onNewIntent(intent);
}

Kotlin

import com.singular.flutter_sdk.SingularBridge

override fun onNewIntent(intent: Intent) {
  super.onNewIntent(intent)
  SingularBridge.onNewIntent(intent);
}

添加SKAdNetwork支持

从Singular Flutter SDK版本1.0.15开始，默认情况下启用了skAdNetworkEnabled。要手动启用SKAdNetwork跟踪，请在初始化Singular之前打开配置选项。

示例代码：

SingularConfig config = new SingularConfig('API_KEY', 'API_SECRET');
config.skAdNetworkEnabled = true;
config.manualSkanConversionManagement = true; // 启用手动转换值更新
config.conversionValueUpdatedCallback = (int conversionValue) {
     print('Received conversionValueUpdatedCallback: ' + conversionValue.toString());
};
Singular.init(config);

检索转换值：

Singular.skanGetConversionValue().then((conversionValue) {
     print('conversion value: ' + conversionValue.toString());
});

跟踪卸载

发送APNS/FCM令牌给Singular以跟踪应用程序卸载情况。

示例代码：

// iOS
Singular.registerDeviceTokenForUninstall(apnsToken);

// Android
Singular.registerDeviceTokenForUninstall(fcmToken);