ConverlayConverlay

追踪事件

使用 converlay.track(eventName, properties) 发送事件。 SDK 自动使用客户端 ID、会话、UTM、点击 ID 和同意状态来丰富每个事件。

API签名

track() signature
converlay.track('event_name', {
  ecommerce: {
    transaction_id: 'ORD-123',
    value: 99.99,
    currency: 'USD',
    items: [
      {
        item_id: 'SKU-001',
        item_name: 'Classic Tee',
        price: 29.99,
        quantity: 2,
      },
    ],
  },
  userData: {
    email: 'customer@example.com',
  },
  pageType: 'product',
})

标准事件名称

使用这些事件名称自动映射到 GA4、Meta 和 TikTok 事件类型:

事件名称何时开火
page_view页面加载或客户端导航
view_item产品详情页
view_item_list收藏或搜索结果页面
add_to_cart商品已添加到购物车
remove_from_cart商品已从购物车中移除
search已提交搜索查询
begin_checkout结账开始
add_payment_info输入付款信息
add_shipping_info输入运输信息
purchase订单已完成

自定义事件

您可以使用任何字符串作为事件名称。自定义事件将按原样转发到支持它们的目标平台。

TrackProperties 字段

领域类型描述
ecommerceEcommerceData交易和物品数据
userDataUserData用于增强匹配的客户 PII(哈希服务端)
pageTypestring页面类型标签(例如“产品”、“产品系列”、“购物车”)
[key: string]unknown任何其他自定义属性

示例

查看项目

typescript
converlay.track('view_item', {
  ecommerce: {
    items: [{
      item_id: 'SKU-001',
      item_name: 'Classic Tee',
      item_variant: 'Blue / Large',
      price: 29.99,
      quantity: 1,
    }],
  },
})

添加到购物车

typescript
converlay.track('add_to_cart', {
  ecommerce: {
    value: 29.99,
    currency: 'USD',
    items: [{
      item_id: 'SKU-001',
      item_name: 'Classic Tee',
      price: 29.99,
      quantity: 1,
    }],
  },
})

购买

typescript
converlay.track('purchase', {
  ecommerce: {
    transaction_id: 'ORD-5678',
    value: 129.99,
    currency: 'USD',
    items: [
      { item_id: 'SKU-001', item_name: 'Classic Tee', price: 29.99, quantity: 2 },
      { item_id: 'SKU-042', item_name: 'Hoodie', price: 70.01, quantity: 1 },
    ],
  },
  userData: {
    email: 'customer@example.com',
    phone: '+15551234567',
    firstName: 'Jane',
    lastName: 'Doe',
  },
})