接口 YmxGdtConvert

提供广告监测、广告归因与广告效果优化能力。

使用前需在 DataNexus 创建行为数据源，获取数据源 ID 与 secret_key
使用前请先调用 initSdk 完成初始化（需在用户同意隐私协议后调用），初始化后请尽快调用 start 启动 SDK，否则影响设备号填充率与归因成功率
除通用的 logAction 外，插件还提供与平台 jsBridge 对齐的 onXxx 行为快捷方法（注册、登录、付费、加购、结算等），内部按对应标准行为类型上报

示例

const gdt = ymx.requirePlugin('ymx-gdt-convert') as YmxGdtConvert;

// 确认隐私协议之后初始化 SDK 并启动（启动后 SDK 开始采集上报个人信息）
ymx.onConfirmPrivacy(async (isAgreed) => {
  // 同意了隐私协议
  if (isAgreed) {
    await gdt.initSdk({
      userActionSetId: 123456,
      secretKey: 'your_secret_key',
      showLog: true
    });
    // 启动 SDK（允许 SDK 采集个人信息，尽快调用）
    await gdt.start();
  }
});

// 上报【注册】行为（快捷方法）
await gdt.onRegister({
  method: 'QQ',
  success: true
});

// 上报【付费】行为（快捷方法），金额单位：分
await gdt.onPurchase({
  type: 'vip',
  name: 'vip12',
  id: 'abc123',
  number: 1,
  channel: 'weixin',
  currency: 'CNY',
  value: 1800,
  success: true
});

// 通用行为上报
await gdt.logAction({
  actionType: 'PURCHASE',
  actionParam: { value: 600 }
});

// 设置业务用户 ID
await gdt.setUserUniqueId({ userUniqueId: 'user_1234' });

interface YmxGdtConvert {
    id: string;
    version: string;
    flush(): Promise<void>;
    initSdk(data: InitSdkData): Promise<void>;
    logAction(data: LogActionData): Promise<void>;
    onAddPaymentChannel(data: AddPaymentChannelData): Promise<void>;
    onAddToCart(data?: AddToCartData): Promise<void>;
    onBindAccount(data: BindAccountData): Promise<void>;
    onCheckout(data?: CheckoutData): Promise<void>;
    onCreateRole(data: CreateRoleData): Promise<void>;
    onLogin(data: LoginData): Promise<void>;
    onPurchase(data?: PurchaseData): Promise<void>;
    onQuestFinish(data?: QuestFinishData): Promise<void>;
    onRateApp(data: RateAppData): Promise<void>;
    onRegister(data: RegisterData): Promise<void>;
    onShare(data: ShareData): Promise<void>;
    onUpdateLevel(data: UpdateLevelData): Promise<void>;
    onViewContent(data?: ViewContentData): Promise<void>;
    removeListener(): Promise<void>;
    setListener(
        listener: (eventName: string, data: any) => void,
    ): Promise<void>;
    setUserUniqueId(data: SetUserUniqueIdData): Promise<void>;
    start(): Promise<void>;
}

层级

JsApiBase
- YmxGdtConvert

属性

`只读`id

id: string

获取插件 ID

`只读`version

version: string

获取插件版本，如 1.2.3

方法

flush

flush(): Promise<void>
立即上报队列中的行为数据

将 SDK 内部待上报队列中的数据立即发送，一般无需手动调用（SDK 会自动上报）。

返回 Promise<void>
示例
```
await gdt.flush();
```
- 定义于 api.d.ts:510

initSdk

initSdk(data: InitSdkData): Promise<void>
初始化转化 SDK

手动初始化，需在用户同意隐私协议后调用并传入数据源参数；已初始化时直接返回。初始化接口仅执行 SDK 初始化，不会进行任何信息收集。
参数
- data: InitSdkData
  初始化参数
返回 Promise<void>
初始化完成
示例
```
// 确认隐私协议之后初始化 SDK（初始化后需调用 start 开始采集上报）
ymx.onConfirmPrivacy(async (isAgreed) => {
  // 同意了隐私协议
  if (isAgreed) {
    await gdt.initSdk({
      userActionSetId: 123456,
      secretKey: 'your_secret_key'
    });
  }
});
```
- 定义于 api.d.ts:452

logAction

logAction(data: LogActionData): Promise<void>
上报行为数据

按行为清单上报用户行为（注册、付费、下单等），行为类型与参数规范见 LogActionData。上报结果可通过 SDK 日志确认（showLog: true 时输出 logAction success/failed）。
参数
- data: LogActionData
  行为上报参数
返回 Promise<void>
示例
```
// 上报【创建角色】行为
await gdt.logAction({ actionType: 'CREATE_ROLE' });
// 上报【付费】行为，付费金额参数名 value，单位：分
await gdt.logAction({
  actionType: 'PURCHASE',
  actionParam: { value: 600 }
});
```
- 定义于 api.d.ts:498

onAddPaymentChannel

onAddPaymentChannel(data: AddPaymentChannelData): Promise<void>
上报【添加支付渠道】事件

按 ADD_PAYMENT_CHANNEL 行为类型上报（自定义行为类型），参数为支付渠道与是否成功。
参数
- data: AddPaymentChannelData
  添加支付渠道事件参数（channel 必填）
返回 Promise<void>
上报已发起
示例
```
await gdt.onAddPaymentChannel({ channel: '微信', success: true });
```
- 定义于 api.d.ts:729

onAddToCart

onAddToCart(data?: AddToCartData): Promise<void>
上报【加入购物车】事件

按 ADD_TO_CART 标准行为类型上报，参数为商品类型、名称、ID、数量与是否成功。
参数
- 可选data: AddToCartData
  加入购物车事件参数（可选）
返回 Promise<void>
上报已发起
示例
```
await gdt.onAddToCart({
  type: 'xxx',
  name: 'yyy',
  id: '123',
  number: 1,
  success: true
});
```
- 定义于 api.d.ts:667

onBindAccount

onBindAccount(data: BindAccountData): Promise<void>
上报【绑定账号】事件

按 BIND_ACCOUNT 行为类型上报（自定义行为类型），参数为 method（绑定方式）与 success（是否成功）。
参数
- data: BindAccountData
  绑定账号事件参数（method 必填）
返回 Promise<void>
上报已发起
示例
```
await gdt.onBindAccount({ method: 'QQ', success: true });
```
- 定义于 api.d.ts:552

onCheckout

onCheckout(data?: CheckoutData): Promise<void>
上报【开始结算】事件

按 INITIATE_CHECKOUT 标准行为类型上报，参数为商品类型、名称、ID、数量、虚拟货币信息、货币类型与是否成功。
参数
- 可选data: CheckoutData
  开始结算事件参数（可选）
返回 Promise<void>
上报已发起
示例
```
await gdt.onCheckout({
  type: 'xxx',
  name: 'yyy',
  id: '123',
  number: 1,
  isVirtualCurrency: false,
  virtualCurrencyType: '',
  currency: 'CNY',
  success: true
});
```
- 定义于 api.d.ts:691

onCreateRole

onCreateRole(data: CreateRoleData): Promise<void>
上报【创建角色】事件

按 CREATE_ROLE 标准行为类型上报，参数为角色名。
参数
- data: CreateRoleData
  创建角色事件参数（role 必填）
返回 Promise<void>
上报已发起
示例
```
await gdt.onCreateRole({ role: 'aabb' });
```
- 定义于 api.d.ts:587

onLogin

onLogin(data: LoginData): Promise<void>
上报【登录】事件

按 LOGIN 标准行为类型上报，参数为 method（登录方式）与 success（是否成功）。
参数
- data: LoginData
  登录事件参数（method 必填）
返回 Promise<void>
上报已发起
示例
```
await gdt.onLogin({ method: 'QQ', success: true });
```
- 定义于 api.d.ts:538

onPurchase

onPurchase(data?: PurchaseData): Promise<void>
上报【付费】事件

按 PURCHASE 标准行为类型上报，参数为商品类型、名称、ID、数量、支付渠道、货币类型、金额（分）与是否成功。
参数
- 可选data: PurchaseData
  付费事件参数（可选）
返回 Promise<void>
上报已发起
示例
```
await gdt.onPurchase({
  type: 'xxx',
  name: 'yyy',
  id: '123',
  number: 1,
  channel: 'aaa',
  currency: 'CNY',
  value: 1800,
  success: true
});
```
- 定义于 api.d.ts:715

onQuestFinish

onQuestFinish(data?: QuestFinishData): Promise<void>
上报【任务完成】事件

按 QUEST 标准行为类型上报，参数包含任务 ID、类型、名称、数量、描述与是否成功。
参数
- 可选data: QuestFinishData
  任务完成事件参数（可选）
返回 Promise<void>
上报已发起
示例
```
await gdt.onQuestFinish({
  id: 'xxx',
  type: 'yyy',
  name: 'zzz',
  number: 123,
  desc: 'aaa',
  success: true
});
```
- 定义于 api.d.ts:573

onRateApp

onRateApp(data: RateAppData): Promise<void>
上报【评分】事件

按 RATE 标准行为类型上报，参数为评分值。
参数
- data: RateAppData
  评分事件参数（value 必填）
返回 Promise<void>
上报已发起
示例
```
await gdt.onRateApp({ value: 4.9 });
```
- 定义于 api.d.ts:629

onRegister

onRegister(data: RegisterData): Promise<void>
上报【注册】事件

按 REGISTER 标准行为类型上报，参数为 method（注册方式）与 success（是否成功）。
参数
- data: RegisterData
  注册事件参数（method 必填）
返回 Promise<void>
上报已发起
示例
```
await gdt.onRegister({ method: 'QQ', success: true });
```
- 定义于 api.d.ts:524

onShare

onShare(data: ShareData): Promise<void>
上报【分享】事件

按 SHARE 标准行为类型上报，参数为分享渠道与是否成功。
参数
- data: ShareData
  分享事件参数（channel 必填）
返回 Promise<void>
上报已发起
示例
```
await gdt.onShare({ channel: 'WeiXin', success: true });
```
- 定义于 api.d.ts:615

onUpdateLevel

onUpdateLevel(data: UpdateLevelData): Promise<void>
上报【升级】事件

按 UPDATE_LEVEL 标准行为类型上报，参数为等级。
参数
- data: UpdateLevelData
  升级事件参数（level 必填）
返回 Promise<void>
上报已发起
示例
```
await gdt.onUpdateLevel({ level: 12 });
```
- 定义于 api.d.ts:601

onViewContent

onViewContent(data?: ViewContentData): Promise<void>
上报【内容浏览】事件

按 VIEW_CONTENT 标准行为类型上报，参数为内容类型、名称与 ID。
参数
- 可选data: ViewContentData
  内容浏览事件参数（可选）
返回 Promise<void>
上报已发起
示例
```
await gdt.onViewContent({
  type: '装备',
  name: '飞行天使',
  id: '1122'
});
```
- 定义于 api.d.ts:647

removeListener

removeListener(): Promise<void>
移除监听器

返回 Promise<void>
继承自 JsApiBase.removeListener
- 定义于 core.d.ts:3028

setListener

setListener(listener: (eventName: string, data: any) => void): Promise<void>
设置监听器，接收 eventName 事件名称，data 事件数据

注意： 此接口为覆盖操作，仅保留最后一个监听器，最后的 listener 才能收到事件通知。
参数
- listener: (eventName: string, data: any) => void
返回 Promise<void>
继承自 JsApiBase.setListener
- 定义于 core.d.ts:3026

setUserUniqueId

setUserUniqueId(data: SetUserUniqueIdData): Promise<void>
设置业务用户 ID

设置客户自定义的用户 ID，用于后续行为数据与用户关联。
参数
- data: SetUserUniqueIdData
  用户 ID 参数
返回 Promise<void>
示例
```
await gdt.setUserUniqueId({ userUniqueId: 'user_1234' });
```
- 定义于 api.d.ts:478

start

start(): Promise<void>
启动转化 SDK

请在调用 initSdk 后尽快调用，否则影响设备号填充率，降低归因成功率；启动后 SDK 开始采集并上报数据。

返回 Promise<void>
示例
```
await gdt.start();
```
- 定义于 api.d.ts:465

接口 YmxGdtConvert

示例

层级

索引

属性

方法

属性

只读id

只读version

方法

flush

返回 Promise<void>

示例

initSdk

参数

返回 Promise<void>

示例

logAction

参数

返回 Promise<void>

示例

onAddPaymentChannel

参数

返回 Promise<void>

示例

onAddToCart

参数

返回 Promise<void>

示例

onBindAccount

参数

返回 Promise<void>

示例

onCheckout

参数

返回 Promise<void>

示例

onCreateRole

参数

返回 Promise<void>

示例

onLogin

参数

返回 Promise<void>

示例

onPurchase

参数

返回 Promise<void>

示例

onQuestFinish

参数

返回 Promise<void>

示例

onRateApp

参数

返回 Promise<void>

示例

onRegister

参数

返回 Promise<void>

示例

onShare

参数

返回 Promise<void>

示例

onUpdateLevel

参数

返回 Promise<void>

示例

onViewContent

参数

返回 Promise<void>

示例

removeListener

返回 Promise<void>

setListener

参数

返回 Promise<void>

setUserUniqueId

参数

`只读`id

`只读`version