简介
@atlaskit/analytics-gas-types 是一种用于在 Google Analytics 4 中报告事件和属性的类型定义库。它定义了用于报告到 GA4 的各种事件、参数和属性。
安装
可以通过 npm 进行安装：
npm i @atlaskit/analytics-gas-types
使用
1. 导入 Types
TypeScript 能够识别我们导入的每个类型。导入类型的技术术语叫做 Type Only Imports。
import type { UIAnalyticsEvent, Payload, TrackingEventPayload, } from '@atlaskit/analytics-gas-types';
2. 创建 GA 事件
通过创建 UIAnalyticsEvent 对象，可以将事件和属性报告到 GA4。
-- -------------------- ---- ------- ----- ------ ---------------- - - ------- ---------- -------------- --------- ----------- - -------------- ----------- --------- --- ----------- ------ -- ---------- ----- --展开代码
3. 添加属性
属性是事件的关键部分。它们包含与事件相关的附加信息。 属性位于 attributes 对象中，并遵循特定的名称和类型。
-- -------------------- ---- ------- ----- ------ ---------------- - - ------- ---------- -------------- --------- ----------- - -------------- ----------- --------- --- ----------- ------ -- ---------- ----- --展开代码
根据您要报告的事件类型，可能需要使用不同的属性。 以下是一些示例属性：
duration(number): 操作的持续时间（以毫秒为单位）itemCount(number): 表示项目数（例如，列表中的项目数）componentName(string): 组件名称
4. 增加支付参数
如果您正在报告加入购物车或结算操作等支付事件，则需要一些特殊属性。
以下是一些示例属性：
-- -------------------- ---- ------- ----- -------- ------- - - ---------- -------- ------- ------------------ ---------- - --------- - ------- ---------- --------------- --------- -- -- -- ------ --------- - --------- ------------- ------ -- ------------- ----------- --- ----------- - ----------- ---------- -- ------ - - -------- ----------- ---------- ---------- -------------- ----- ------- ------------- ------ ----------- ------ ------ ----- --------- -- -- -- --展开代码
5. 增加跟踪参数
除要在属性中报告的值之外，还可以将其他参数传递给 Ga4 以更好地了解访问者和事件的上下文。这些参数通常称为 “跟踪参数”。
-- -------------------- ---- ------- ----- ------------- -------------------- - - ----------- -- ----------- ------------- -------- -------- --------------- ----- -------------- -------- ------------ ------- ----------- ----------- ----------- --- --展开代码
6. 发送 GA 事件
最后，我们需要将事件发送到 GA4。 为此，您需要一个客户端 ID 和 Google Analytics API。
-- -------------------- ---- ------- ------ - ------------------ - ---- -------------------------------- ----- ------ - --- -------------------- --------- ----- ------ ---- --- ----- ------- - -- -- - ------------- --------- ----------- - -------------------- ---------------- ------------- -- --- --展开代码
结论
@atlaskit/analytics-gas-types 是使用 Google Analytics 4 并将事件和属性报告到 GA4 的必备工具。我希望这个教程可以帮助您学习它，并对您今后的工作有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/155291
