@contentsquare/tag-sdk

中文文档
1.1.0发布于 2024/10/30ISCTypeScriptESM + CJS零依赖近 30 天下载 5.5万

内容平方标记 SDK

中文使用文档
文档目录7 节
  1. 安装
  2. 如何使用内容方块标记
  3. 先决条件
  4. 使用内容方块标记的步骤
  5. API 参考
  6. injectContentsquareScript(scriptOptions)
  7. 限制

内容quare TAG SDK

这套国家防范机制软件为开发者提供了一种标准化方式,以非阻塞方式从远程加载跟踪TAG 服务器。 依据 内容等量 SDK。 。 。 .

内容quare是一个分析平台,帮助企业了解并优化其网站和移动应用程序的用户体验. 它通过热映射、会话录音和行为分析提供可操作的洞察力,使企业能够确定需要改进的领域并增强网站的整体业绩。 通过方便用户的界面和强大的数据可视化,Concessquare使数据驱动的决策能够促进转换并增强客户的参与.

安装

使用国家防范机制安装软件包:

npm install --save @contentsquare/tag-sdk

如何使用内容方块标记

先决条件

在使用 Contentquare 标记前,请确定您有以下内容:

使用内容方块标记的步骤

遵循以下步骤在您的网站上使用内容quare标签 :

  1. 包含内容方块脚本:在您网站的Javascript/Typescript中,使用所提供的客户端ID来添加内容quare脚本.

    打电话 injectContentsquareScript 函数,其选项如下:.

  • 如果你有一个 clientId数字 :

    // Replace 'YOUR_CLIENT_ID' with your actual Contentsquare Client ID
    injectContentsquareScript({
      clientId: "YOUR_CLIENT_ID",
      async: true, // Optional: Prefer async execution to avoid blocking the DOM when executing the script.
      defer: false, // Optional: Set to true to defer script execution until after the DOM is fully built (before the DOMContentLoaded event).
      integrity: "YOUR_SCRIPT_INTEGRITY_HASH", // Optional: Provide the integrity hash for script security (if required).
    });
    
  • 如果你有一个 siteId数字 :

    // Replace 'YOUR_SITE_ID' with your actual Contentsquare Site ID
    injectContentsquareScript({
      siteId: "YOUR_SITE_ID",
      async: true, // Optional: Prefer async execution to avoid blocking the DOM when executing the script.
      defer: false, // Optional: Set to true to defer script execution until after the DOM is fully built (before the DOMContentLoaded event).
    });
    

    该函数将把内容quare脚本附加到文档中。 头,并将根据所提供的选项相应取出并执行.

  1. 使用量:请参见 内容文件 关于使用Contentquare标签的更多信息.

API 参考

injectContentsquareScript(scriptOptions)

将内容quare 脚本注入文档.head.

  • scriptOptions: 插入脚本的选项.
    • clientId (弦声) - (如果没有网站,则需要 (d) 国家 Contentquare以"a6f73d509"的形式提供的客户端ID.
    • siteId (弦声) - (如果没有客户要求) (d) 国家 站点ID是12345形式的数字ID.
    • defer (boolean) - (optional) 表示脚本是否平行取取,并在文档解析后进行评估. 默认为 false。 。 。 .
    • async (boolean) - (可选) 表示脚本是否平行取取并尽快评估. 默认为 true。 。 。 .
    • integrity (弦) - (可选) 内容quare脚本的完整散列(SRI). 必须是Contentquare产生的.

回返: 附加到的、代表内容quare脚本的脚本元素 document.head。可用于进一步操纵或跟踪装载状态.

限制

  • 这种拖曳模式只能用于现代“Contentsquare 部署”模式(不支持 Clicktale 或任何其他遗留模式).
  • 包内的一些功能会包括内置描述/类型,以便于使用,但并非所有功能都包括在内. 请参看官员 内容文件 关于现有功能及其使用情况的更多信息.

版本与发布记录

@contentsquare/tag-sdk 共发布 5 个版本,首次发布于 2023/07/04;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.0latest2024/10/302 年前
1.0.22023/08/023 年前
1.0.12023/08/023 年前
1.0.02023/07/243 年前
0.0.12023/07/043 年前

关于 @contentsquare/tag-sdk 的常见问题

@contentsquare/tag-sdk 是什么?

内容平方标记 SDK

如何安装 @contentsquare/tag-sdk?

在项目目录运行 npm install @contentsquare/tag-sdk,或使用 pnpm add / yarn add / bun add。

@contentsquare/tag-sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@contentsquare/tag-sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@contentsquare/tag-sdk 可以商用吗?

@contentsquare/tag-sdk 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@contentsquare/tag-sdk 的下载量有多少?

根据 npm 官方下载统计,@contentsquare/tag-sdk 在 2026/10/11 – 2026/11/09 这 30 天内被下载 54,671 次,日均约 1,822 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@contentsquare/tag-sdk 还在维护吗?

最新版本 1.1.0 发布于 2024/10/30(2 年前);至今共发布 5 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/07/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。