sdk_conversion 的使用

对于使用 Beeviral 平台的企业客户，如果您拥有自己的移动应用程序，并希望通过该应用程序执行指标转换，Beeviral 提供了一个插件来简化此任务，无需直接处理其 API，通过简单且明确的方法抽象这些复杂性。

如何开始使用？

插件主要由两个方法组成：

ConversionService.initialize:

此方法负责初始化插件，并应在执行其他任何方法之前调用。它接收两个参数：

• 第一个参数接收每个 Beeviral 客户独有的令牌，您可以在设置 > 集成菜单中找到该令牌，所需令牌位于“API Token”框内。

• 第二个参数接收一个名为 ConversionOptions 的类，该类接收一个名为 statusOfConversion 的参数，默认情况下将指标发送以进行处理为“已推荐”，但您可以根据需要配置为其他可用状态之一；

此选项类的第二个参数用于配置推荐点击的有效期，默认情况下没有有效期。

ConversionService.doConversion:

此方法负责实际执行所需的指标转换，并且只有在前面描述的方法已经执行的情况下才能调用，否则会返回错误。它接收以下必填字段和可选字段作为参数：

• name: 定义推荐人的姓名（必填）
• email: 定义推荐人的电子邮件（可选）
• phone: 定义推荐人的电话号码（可选）
• status: 定义状态，可以是“推荐”、“转换”、“无效”等（可选）
• orderid: 定义内部ID，通常是购买或兑换的ID（可选）
• externalid: 定义唯一的外部标识符（外部键）（可选）
• bvid: 定义指标ID（可选）
• valorconversao: 定义转换值（如果适用）（可选）
• contentclient: 定义与指标相关的额外字段，必须通过 JSON 格式的字符串传递（可选）
• contentsale: 定义与推荐相关的额外字段，必须通过 JSON 格式的字符串传递（可选）

以下是完整的示例代码：

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  void performConversion() async {
    // 初始化插件
    await ConversionService.initialize(
      "your_unique_api_token_here", // 替换为您的唯一 API Token
      ConversionOptions(
        statusOfConversion: "Indicado", // 默认为"Indicado"
        validClickTime: null, // 默认没有有效时间限制
      ),
    );

    // 执行转换
    await ConversionService.doConversion(
      name: "张三", // 必填
      email: "zhangsan@example.com", // 可选
      phone: "12345678901", // 可选
      status: "Indicado", // 可选
      orderid: "order12345", // 可选
      externalid: "ext_id_001", // 可选
      bvid: "bv_001", // 可选
      valorconversao: 100.00, // 可选
      contentclient: '{"field1": "value1"}', // 可选
      contentsale: '{"product": "example_product"}', // 可选
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("sdk_conversion 示例"),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: performConversion,
          child: Text("执行转换"),
        ),
      ),
    );
  }
}