@burnonveya/分析-网络

Veya Analytics SDK为网络服务. 自动检测页面类型、产品印象和推车更改 分批订货 分批订货.

与其核心共享 @builtonveya/analytics-react-native (同一事件分类学,同版本行).

安装

npm/ 纱线/ pnpm

npm install @builtonveya/analytics-web

import veya from '@builtonveya/analytics-web';

await veya.init({ tenantSlug: 'your-tenant-slug' });

脚本标签 (包装一个自成一体的浏览器捆绑 window.veya(中文(简体) )

<script src="https://cdn.jsdelivr.net/npm/@builtonveya/analytics-web@4/dist/veya-analytics.min.js"></script>
<script>
  veya.init({ tenantSlug: 'your-tenant-slug' });
</script>

将主线拉入( P)@4用于自动补丁更新,或精确的版本(@4.0.0为了一个被冻结的建筑.

配置

await veya.init({
  tenantSlug: 'your-tenant-slug',      // required
  endpoint: 'https://analytics.builtonveya.com/v1/events',   // the default
  storeId: 'store-81',                 // if known at init; otherwise call veya.setStore(id, name)
  debug: false,
  autoDetect: true,                    // page-type detection on navigation
  autoTrackProducts: true,             // product impressions
  autoTrackCart: true,                 // cart change detection
  interceptOloApi: false,              // opt-in: patches window.fetch to read Olo order responses
  batchSize: 10,
  flushInterval: 5000,
  sessionTimeout: 1800000,             // 30 minutes
});

音轨

核心SDK提供的一切 默认导出: track, (中文(简体) ), pageView, (中文(简体) ), productView, (中文(简体) ), productClick, (中文(简体) ), addToCart, (中文(简体) ), removeFromCart, (中文(简体) ), updateCartQuantity, (中文(简体) ), setCart, (中文(简体) ), checkoutStart, (中文(简体) ), checkoutStep, (中文(简体) ), addPaymentInfo, (中文(简体) ), checkoutComplete, (中文(简体) ), loginAttempt, (中文(简体) ), loginSuccess, (中文(简体) ), loginFailure, (中文(简体) ), logout, (中文(简体) ), identify, (中文(简体) ), storeSelect, (中文(简体) ), setStore, (中文(简体) ), search, (中文(简体) ), loyaltyLogin, (中文(简体) ), rewardView, (中文(简体) ), rewardApply, (中文(简体) ), rewardRemove, (中文(简体) ), promoApply, (中文(简体) ), promoRemove, (中文(简体) ), setExperiment, (中文(简体) ), error, (中文(简体) ), flush, (中文(简体) ), getSessionId, (中文(简体) ), getVisitorId, (中文(简体) ), getCustomerId。 。 。 .

veya.setStore('81', 'Earthbar Flagship - West Hollywood');
veya.addToCart({ id: 'olo:item:106702642', name: 'The Workout Smoothie', price: 12.95 }, 1);
veya.checkoutComplete({ order_id: '46749…', total: 12.95, items: [...] });

init() 不止一次,有人在飞行时打过电话 直接解开,所以反应 严格模型的双重效果是无害的.

自动事件

准确命名的属性 email, (中文(简体) ), phone, (中文(简体) ), password, (中文(简体) ), ssn, (中文(简体) ), credit_card, (中文(简体) ), cvv, (中文(简体) ), address 或者说 street 从每起事件(以及从 identify() 作为反对派遣的后援 个人资料是错的 只有那些精确的顶级密钥: 不要依赖它来捕捉 delivery_address, (中文(简体) ), streetAddress 或筑巢物体。 允许ZIP / 邮政编码: 发送 address_postal_code (5-digital ZIP)用于交付区分析,从不提供街道地址.

4.0.4的变动

• 通话 identify(), (中文(简体) ), loginSuccess(), (中文(简体) ), logout() 或者说 setExperiment() 在此之前 init() 不再存储空会话 ID, 没有 ID 的存储会话则永远不会恢复 。 之前,这种会议的每一起事件 都因失踪而被否决 session_id。它们对登录状态的影响和实验只有在 init() 开始新的会话,所以请在 await veya.init()。 。 。 .

4.0.3的变动

• PII 后站不再下降 postal_code 财务报告和审定财务报表 zip - 只有街道层面 address 财务报告和审定财务报表 street (加上现有的电子邮件/电话/密码/SSN/卡/CVV密钥). 一个ZIP已经足够粗糙,可以保留,这就是送货区分析的运行过程;4.0.2随街地址一起掉入.

4.0.2的变动

• page_unload 发送于 pagehide 改为 beforeunloadA级 beforeunload 收听者不让Firefox将页面放入后/前缓存,因此后方重新装入了页面而不是恢复; pagehide 而不是,移动浏览器在关闭标签时更可靠地点出它. 新财产 persisted数字 : true 当页面进入后方/前方缓存而不是卸载时.
• 从后方/ 前方缓存恢复的页面 time_on_page 编辑 scroll_depth 阈值,并发送 page_view 何时 autoDetect 开始 之前,我们.., time_on_page 返回从原负载中计数后,滚动深度从此不再开火.
• PII 后站也会下降 address, (中文(简体) ), street, (中文(简体) ), postal_code 财务报告和审定财务报表 zip (4.0.3再保留ZIP键). query 刻意不在列表中:搜索事件用于所输入的内容.
• 已删除 aiEndpoint 财务报告和审定财务报表 useAiClassification 选项:没有读取,以及 aiEndpoint 默认为无法解决的主机. 仍然通过它们的TypeScript代码会遇到过量的财产错误;删除它们.

4.0.1的变动

• session_start 发送( 它被丢弃的原因是 init() 追踪到它,然后自己开始标记),每一次新会话.
• 无自动 page_view 与 autoDetect: false —— 4. 0.0 在每个负载上都送出一个,除了应用程序自己的.
• 新建自动事件 : page_hidden 编号 : page_visible 财务报告和审定财务报表 scroll_depth (见上文).
• 新方法 : addPaymentInfo(paymentMethod, properties?) → add_payment_info 与 { payment_method } 在漏斗阶下 checkout_payment (四会.
• 卸载发送的页面 page_unload 改为 session_end (会话贯穿全程导航).
• 默认 : endpoint 是现场直播 https://analytics.builtonveya.com/v1/events (4.0.0指一个不能解决的宿主); interceptOloApi 现在选择进入.
• 同时 init() 呼叫共享一个运行,而不是设置听众和发送 session_start。 。 。 .

服务器侧渲染

导入服务器上的软件包是安全的: 模块只装入登记器 window.veya 当 a window 存在,直到 init() 运行。 打电话 init() 客户端 效应.

构建和发布( P)

cd sdk/web
npm ci
npm run build      # dist/esm (ESM + types), dist/cjs, dist/veya-analytics[.min].js
npm run smoke      # loads all three outputs and checks the public surface
npm publish        # prepublishOnly runs build + smoke; scope @builtonveya is public

弹出 version 内 package.json 当共享核心改变时,与 React 本地软件包同步.