Flutter通用SDK插件aiactiv_universal_sdk的功能使用

Flutter通用SDK插件aiactiv_universal_sdk的功能使用

安装

要安装aiactiv_universal_sdk，请运行以下命令：

flutter pub add aiactiv_universal_sdk

iOS 配置

你需要在Info.plist文件中添加以下代码，并将FILL_YOUR_WRITE_KEY_HERE替换为你的写入密钥：

<key>AiactivSDKConfig</key>
<dict>
  <key>writeKey</key>
  <string>FILL_YOUR_WRITE_KEY_HERE</string>
</dict>

如果你想要为广告网络使用不同的写入密钥，可以添加另一个键值对：

<key>AiactivSDKConfig</key>
<dict>
  <key>writeKey</key>
  <string>FILL_YOUR_WRITE_KEY_HERE</string>

  <key>writeKeyForAdNetwork</key>
  <string>FILL_YOUR_WRITE_KEY_HERE</string>
</dict>

在UIApplicationDelegate中导入AiactivUniversalSDK模块：

#import <WebKit/WebKit.h>
#import <AiactivUniversalSDK/AiactivUniversalSDK-Swift.h>

在应用委托的application(_:didFinishLaunchingWithOptions:)方法中配置AiactivUniversalSDK共享实例：

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  // 在应用启动后进行自定义配置。

  [Aiactiv startWithConfig:nil];

  return [super application:application didFinishLaunchingWithOptions:launchOptions];
}

Android 配置

你需要在AndroidManifest.xml文件中添加以下代码，将其置于<application>标签内：

<meta-data
  android:name="io.aiactiv.sdk.WRITE_KEY"
  android:value="FILL_YOUR_WRITE_KEY_HERE" />

如果你想要为广告网络使用不同的写入密钥，可以添加另一个meta-data标签：

<meta-data
  android:name="io.aiactiv.sdk.WRITE_KEY"
  android:value="FILL_YOUR_WRITE_KEY_HERE" />

<meta-data
  android:name="io.aiactiv.sdk.WRITE_KEY_ADNETWORK"
  android:value="FILL_YOUR_WRITE_KEY_HERE" />

使用

广告网络

横幅广告（Banner Ad）

import 'package:aiactiv_universal_sdk/aiactiv_universal_sdk.dart';

// ...

BannerAd(
  size: AdSize.custom("320x150"),
  unitID: YOUR_INVENTORY_ID,
  request: const AdRequest(context: {
    // 这是可选的
    "title": "Got Talents show",
    "keywords": "movie, show, hot",
    "screen": "Home",
  }),
  listener: BannerAdListener(
    onAdLoaded: () => print('FLT onAdLoaded'),
    onAdFailedToLoad: (error) => print('FLT onAdFailedToLoad: $error')
  ),
),

预定义尺寸：

也可以使用自定义尺寸，格式为widthxheight。例如：640x480, 300x500…

自适应横幅广告（Adaptive Banner Ad）

import 'package:aiactiv_universal_sdk/aiactiv_universal_sdk.dart';

// ...

BannerAd(
  size: AdSize.custom("320x150"),
  unitID: YOUR_INVENTORY_ID,
  adaptiveSize: YOUR_ADAPTIVE_SIZE, // SDK会根据广告比例自动计算高度
  request: const AdRequest(context: {
    // 这是可选的
    "title": "Got Talents show",
    "keywords": "movie, show, hot",
    "screen": "Home",
  }),
  listener: BannerAdListener(
    onAdLoaded: () => print('FLT onAdLoaded'),
    onAdFailedToLoad: (error) => print('FLT onAdFailedToLoad: $error')
  ),
),

视频广告（Video Ad）

要显示视频广告，你需要使用VideoAdLoader函数从Aiactiv平台获取VAST标签URL，然后使用你自己的播放器播放它。

import 'package:aiactiv_universal_sdk/aiactiv_universal_sdk.dart';

// ...

try {
  // 通过调用VideoAdLoader函数并传递库存ID和广告类型来加载广告
  var vastTagUrl = await VideoAdLoader.loadAd(YOUR_INVENTORY_ID, 'video');
  print('FLT onAdLoader: $vastTagUrl');
  // 然后使用你自己的播放器播放获取到的vastTagUrl
} catch (error) {
  // 如果加载广告时发生错误，打印错误信息
  print('FLT onAdFailedToLoad: $error');
}

原生广告（Native Ad）

NativeAdLoader会获取原生广告数据并手动绑定到你的视图。

import 'package:aiactiv_universal_sdk/aiactiv_universal_sdk.dart';

// ...

/// 原生广告加载器实例。
NativeAdLoader? _nativeAd;

// 创建并加载原生广告
_nativeAd = NativeAdLoader(
    unitID: YOUR_INVENTORY_ID,
    request: const AdRequest(),
    listener: NativeAdListener(onAdLoaded: (NativeAdData nativeAdData) {
      print('FLT onAdLoaded: $nativeAdData');
    }, onAdFailedToLoad: (error) {
      print('onAdFailedToLoad: $error');
    }))
  ..loadAd();

// ...

// 执行广告点击操作
_nativeAd?.performAdClicked((url) {
  print('onAdClicked: $url');
});

原生广告属性：

分析

分析功能会自动初始化并收集数据。你还可以通过以下方法手动跟踪事件：

跟踪事件（Track Events）

import 'package:aiactiv_universal_sdk/aiactiv_universal_sdk.dart';

Analytics.track(String name, [Map<String, Object>? properties]);

要跟踪一个事件，你需要调用Analytics.track()方法并传入两个参数：name 和 properties。

• name 参数是一个字符串，用于命名事件，例如：“文章浏览”、“注册”、"购买"等。
• properties 参数是一个对象，用于包含事件的详细信息，例如：文章标题、产品类型、订单金额等。

// 创建一个对象来包含事件的属性
const postViewEventProperties = {
  title: '文章标题',
  category: '分类1, 分类2',
  keyword: '关键词1, 关键词2, ...',
  ...
};

// 使用创建的属性跟踪事件"文章浏览"
Analytics.track('文章浏览', postViewEventProperties);

识别用户（Identify Events）

import 'package:aiactiv_universal_sdk/aiactiv_universal_sdk.dart';

Analytics.identify(String userId, [Map<String, Object>? traits]);

要识别一个用户，你需要调用Analytics.identify()方法并传入一个参数：userId。

• userId 参数是一个字符串，用于标识你的用户，例如：“PartnerUserID-01”。
• 你还可以传入另一个对象来包含用户额外的信息，例如：用户名、用户类型等。

// 创建一个对象来包含用户的属性
const userTraits = {
    userName: '用户名1',
    userType: '普通用户',
    ...
};

// 使用用户ID和创建的属性识别用户
Analytics.identify('PartnerUserID-01', userTraits)

跟踪屏幕（Screen Events）

import 'package:aiactiv_universal_sdk/aiactiv_universal_sdk.dart';

Analytics.screen(String title, [Map<String, Object>? properties]);

要跟踪一个屏幕，你需要调用Analytics.screen()方法并传入一个参数：title。

• title 参数是一个字符串，用于命名屏幕，例如：“登录屏幕”、"主页屏幕"等。
• 你还可以传入另一个对象来包含屏幕的详细信息，例如：登录方式、帖子数量等。

// 创建一个对象来包含屏幕的属性
const loginScreenProperties = {
    loginMethod: 'FACEBOOK/GOOGLE/OTP/QR',
    ...
};

// 使用屏幕名称和创建的属性跟踪屏幕
Analytics.screen(title: "登录屏幕", properties: loginScreenProperties)