Flutter营销自动化插件sfmc_plugin的使用

sfmc_plugin

salesforce.com提供的Salesforce Marketing Cloud (SFMC) - MobilePush SDK for Flutter。Marketing Cloud MobilePush允许您创建和发送通知以鼓励用户使用您的应用程序。

此SFMC Flutter插件包括：

• Push Notifications：通过Marketing Cloud MobilePush或Content Builder或Journey Builder中的推送通知模板创建消息。
• In-App Messages：在用户使用移动应用程序时与他们互动，触发消息在用户打开应用程序时显示。

了解更多关于SFMC Mobile Push SDK的信息：

• SFMC SDK Android
• SFMC SDK iOS

开始使用

首先需要在项目中添加sfmc_plugin。请按照安装指南操作。

建议查看示例源代码。

设置Android

1. 创建MobilePush应用程序：根据文档连接设备到MobilePush应用。

2. 设置Firebase：遵循官方文档完成设置，并将google-services.json文件放置在android/app目录下。

3. 修改build.gradle：

   • 在android/app/build.gradle中添加：

     apply plugin: 'com.google.gms.google-services'
     

   • 在android/build.gradle中添加依赖：

     dependencies {
       classpath 'com.google.gms:google-services:4.3.13'
     }
     

4. 初始化SFMC SDK：更新android/gradle.properties如下：

   MC_APP_ID="<YOUR_SFMC_APP_ID>"
   MC_ACCESS_TOKEN="<YOUR_SFMC_ACCESS_TOKEN>"
   MC_SENDER_ID="<YOUR_FIREBASE_CLOUD_MESSAGING_SENDER_ID_FOR_SFMC>"
   MC_MID="<YOUR_SFMC_MID>"
   MC_SERVER_URL="<YOUR_SFMC_URL>"
   

设置iOS

1. 配置推送服务：根据文档进行配置。

2. 更新info.plist：添加以下内容：

   <key>UIBackgroundModes</key>
   <array>
       <string>fetch</string>
       <string>remote-notification</string>
   </array>
   

3. 设置UNUserNotificationCenter代理：在AppDelegate.m/AppDelegate.swift中添加以下代码：

   Objective-C:

   if ([@available](/user/available)(iOS 10.0, *)) {
     [UNUserNotificationCenter currentNotificationCenter].delegate = (id<UNUserNotificationCenterDelegate>) self;
   }
   

   Swift:

   if #available(iOS 10.0, *) {
     UNUserNotificationCenter.current().delegate = self as? UNUserNotificationCenterDelegate
   }
   

使用Flutter插件

1. 初始化SFMC插件（仅适用于iOS，Android请参阅设置Android部分）：

   var isInitialized = await SfmcPlugin().initialize(
     appId: '<YOUR_APP_ID>',
     accessToken: '<YOUR_ACCESS_TOKEN>',
     mid: '<YOUR_MID>',
     sfmcURL: '<YOUR_SFMC_URL>',
     senderId: '<YOUR_FIREBASE_CLOUD_MESSAGING_SENDER_ID>',
   
     /// Set delayRegistration on iOS only,
     /// delayRegistration on Android is by default true
     delayRegistration: true,
   
     /// Set analytics on iOS only,
     /// analytics on Android is by default true
     analytics: true,
   );
   

2. 设置联系人密钥（唯一标识符）：

   await SfmcPlugin().setContactKey('<Uniquely Identifying Key>');
   

3. 设置属性（用于细分受众和个性化消息）：

   await SfmcPlugin().setProfileAttribute("key", "value");
   
   await SfmcPlugin().clearProfileAttribute("key");
   

示例Demo

import 'package:flutter/material.dart';
import 'package:sfmc_plugin/sfmc_plugin.dart';

void main() async {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

  final String title = "SFMC - Mobile Push";

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

Future handler(MethodCall methodCall) async {
  switch (methodCall.method) {
    case 'handle_url':
      var url = methodCall.arguments['url'];
      // the url is accessible here and can be processed (Applicable to iOS Only)
      return null;
  }
}

class _MyHomePageState extends State<MyHomePage> {
  bool? initStatus;

  void onInit() async {
    SfmcPlugin().setHandler(handler);
    var isInitialized = await SfmcPlugin().initialize(
      appId: '<YOUR_APP_ID>',
      accessToken: '<YOUR_ACCESS_TOKEN>',
      mid: '<YOUR_MID>',
      sfmcURL: '<YOUR_SFMC_URL>',
      senderId: '<YOUR_FIREBASE_CLOUD_MESSAGING_SENDER_ID>',

      /// Set delayRegistration on iOS only,
      /// delayRegistration on Android is by default true
      delayRegistration: true,

      /// Set analytics on iOS only,
      /// analytics on Android is by default true
      analytics: true,
    );

    setState(() {
      initStatus = isInitialized;
    });
  }

  @override
  void initState() {
    onInit();
    super.initState();
  }

  @override
  Widget build(BuildContext context) {
    bool initSucceeded = (initStatus != null && initStatus == true);
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: ListView(
        children: [
          const SizedBox(height: 30,),
          initStatusDisplay(initStatus),
          const SizedBox(height: 15,),
          if (initSucceeded) ContactKeyComponent(),
        ],
      ),
    );
  }

  Widget initStatusDisplay(bool? isInitSuccessful) {
    String text = 'Trying to initialize ...';
    bool isLoading = isInitSuccessful == null;
    if (!isLoading) {
      if (isInitSuccessful) {
        text = "The cloud messaging system has been initialized !";
      } else {
        text = "There was an error during initializing the cloud system !";
      }
    }
    return SizedBox(
      child: Column(
        children: [
          if (isLoading)
            const SizedBox(height: 20, width: 20, child: CircularProgressIndicator(),),
          Text(
            text,
            textAlign: TextAlign.center,
          ),
        ],
      ),
    );
  }

  Widget buildSectionContainer({required Widget child}) {
    return Container(
      margin: const EdgeInsets.symmetric(horizontal: 15, vertical: 5),
      padding: const EdgeInsets.symmetric(horizontal: 10, vertical: 10),
      decoration: BoxDecoration(
          borderRadius: BorderRadius.circular(10),
          border: Border.all(width: 0.5)),
      child: child,
    );
  }
}

贡献

欢迎提交Pull Request！如果您有任何问题或建议，请随时参与本项目的贡献。