Flutter通用功能集成插件mbf_universal_sdk的使用

Flutter通用功能集成插件mbf_universal_sdk的使用

_{MBF Universal SDK 是一个用于广告和分析的功能框架。}

安装

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

flutter pub add mbf_universal_sdk

iOS

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

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

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

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

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

在你的 UIApplicationDelegate 中导入 MBFUniversalSDK 模块：

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

在应用委托的方法中配置 MBFUniversalSDK 共享实例：

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

  [MBF startWithConfig:nil];

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

Android

你需要在应用的 AndroidManifest.xml 文件中添加以下代码：

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

如果你想为广告网络使用不同的写入密钥，可以添加另一个元数据：

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

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

使用

广告网络

Banner Ad（横幅广告）

import 'package:mbf_universal_sdk/mbf_universal_sdk.dart';

// ...

BannerAd(
  size: AdSize.custom("320x100"),
  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')
  ),
),

预定义尺寸：

你也可以自定义任何尺寸，例如：640x480, 300x500…

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

import 'package:mbf_universal_sdk/mbf_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 函数从 MBF 平台获取 VAST 标签 URL，然后使用自己的播放器播放它。

import 'package:mbf_universal_sdk/mbf_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');
}

分析

分析会自动初始化并收集数据。你也可以手动跟踪事件。

跟踪事件

import 'package:mbf_universal_sdk/mbf_universal_sdk.dart';

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

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

• name 参数是一个字符串，用于命名事件，例如：“Post view”, “Sign up”, “Purchase” 等。
• properties 参数是一个对象，包含事件的详细信息，例如：文章标题，产品类型，订单价值等。

// 创建一个对象以包含事件的属性
const postViewEventProperties = {
  title: 'Post Title',
  category: 'Category 1, Category 2',
  keyword: 'Keyword 1, Keyword 2, ...',
  ...
};

// 跟踪事件 "Post view" 并传递创建的属性
Analytics.track('Post view', postViewEventProperties);

识别事件

import 'package:mbf_universal_sdk/mbf_universal_sdk.dart';

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

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

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

// 创建一个对象以包含用户的属性
const userTraits = {
    userName: 'Username 1',
    userType: 'Normal',
    ...
};

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

屏幕事件

import 'package:mbf_universal_sdk/mbf_universal_sdk.dart';

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

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

• title 参数是一个字符串，用于命名屏幕，例如：“Login Screen”, “Home Screen” 等。
• 你还可以传递另一个对象以包含有关屏幕的详细信息，例如：登录方法，帖子数量等。

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

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