ymx-bytedance-convert
    正在准备搜索索引...

    接口 YmxBytedanceConvert

    巨量引擎营销归因（转化 SDK）

    提供启动事件上报、深度转化事件上报与营销归因能力。

    • 插件在用户同意隐私协议后自动初始化并上报启动事件（默认配置，会采集设备信息）
    • 事件上报结果（成功/失败及原因）会通过 setListener 以 eventName event 异步回传， 回调 data 为 { action, data } 结构，action 取值 onEventSendSuccess / onEventSendFailure / onOtherError，推荐在回调中验证上报是否正常
    const bd = ymx.requirePlugin('ymx-bytedance-convert') as YmxBytedanceConvert;

    // 插件在用户同意隐私协议后自动初始化并上报启动事件（无需手动调用）

    // 上报【注册】事件
    await bd.logEventRegister({
      channel: 'weixin',
      success: true
    });

    // 上报【付费】事件
    await bd.logEventPurchase({
      goodsType: 'vip',
      goodsName: 'vip12',
      goodsId: 'abc123',
      count: 1,
      paymentChannel: 'weixin',
      currency: 'CNY',
      amount: 123,
      success: true
    });

    // 上报自定义事件
    await bd.logEvent({
      name: 'update_level',
      values: {
        test: 'test_params'
      }
    });
    interface YmxBytedanceConvert {
        id: string;
        version: string;
        logEvent(data: LogEventData): Promise<void>;
        logEventCreateRole(data: CreateRoleData): Promise<void>;
        logEventGameAddiction(data: GameAddictionData): Promise<void>;
        logEventLevelUpdate(data: LevelUpdateData): Promise<void>;
        logEventLogin(data: LoginData): Promise<void>;
        logEventPurchase(data: PurchaseData): Promise<void>;
        logEventRegister(data: RegisterData): Promise<void>;
        removeListener(): Promise<void>;
        sendLaunchEvent(): Promise<void>;
        setListener(
            listener: (eventName: string, data: any) => void,
        ): Promise<void>;
    }

    层级

    • JsApiBase
      • YmxBytedanceConvert
    索引

    属性

    id version

    方法

    logEvent logEventCreateRole logEventGameAddiction logEventLevelUpdate logEventLogin logEventPurchase logEventRegister removeListener sendLaunchEvent setListener

    属性

    id: string

    获取插件 ID

    version: string

    获取插件版本，如 1.2.3

    方法

    • 上报自定义事件

      上报任意自定义事件（事件名与参数键值对），如关键行为、游戏深度事件等。

      参数

      返回 Promise<void>

      await bd.logEvent({
        name: 'game_addiction',
        values: {
          origin_event: '原始事件名称'
        }
      });

    • 上报创建角色事件（游戏类）

      参数

      返回 Promise<void>

      await bd.logEventCreateRole({ roleId: 'role_001' });

    • 上报关键行为事件（游戏类）

      参数

      返回 Promise<void>

      await bd.logEventGameAddiction({ originEvent: '原始事件名称' });

    • 上报升级事件（游戏类）

      参数

      返回 Promise<void>

      await bd.logEventLevelUpdate({ level: 12 });

    • 上报登录事件

      参数

      返回 Promise<void>

      await bd.logEventLogin({
        method: 'weixin',
        success: true
      });

    • 上报付费事件

      参数

      返回 Promise<void>

      await bd.logEventPurchase({
        goodsType: 'vip',
        goodsName: 'vip12',
        goodsId: 'abc123',
        count: 1,
        paymentChannel: 'weixin',
        currency: 'CNY',
        amount: 123,
        success: true
      });

    • 上报注册事件

      参数

      返回 Promise<void>

      await bd.logEventRegister({
        channel: 'weixin',
        success: true
      });

    • 移除监听器

      返回 Promise<void>

    • 手动上报启动事件

      插件自动初始化时已自动上报启动事件，一般无需手动调用； 仅在自动上报失败或需要补充上报时调用。调用后 SDK 采集设备信息，请确保已获得用户同意。

      返回 Promise<void>

      await bd.sendLaunchEvent();

    • 设置监听器，接收 eventName 事件名称，data 事件数据

      注意： 此接口为覆盖操作，仅保留最后一个监听器，最后的 listener 才能收到事件通知。

      参数

      • listener: (eventName: string, data: any) => void

      返回 Promise<void>

    显示设置

    成员可见性

    目录

    属性
    方法