68publishers-cookie-consent

中文文档
1.0.0发布于 2024/06/21MITES Module近 30 天下载 2823

基于orestbida/cookie同意GTM整合的 Cookie 同意包装.

此软件包已被标记为弃用

The package has been moved to @68publishers/cookie-consent.

中文使用文档
文档目录13 节
  1. 目录
  2. 纳入GTM
  3. 配置
  4. 基本选项
  5. 同意和设置模式选项
  6. 饼干选项
  7. 存储选项
  8. 根据综合同意触发事件
  9. 翻译设置
  10. 区域检测
  11. 如何管理修订
  12. 样式表
  13. 页脚本
Cookie Consent Logo

Cookie 同意书

长期整合 orestbida/cookie同意书 在谷歌标签管理器的支持下.


  • : white check mark:容易配置的 GTM 模板
  • : white check mark:由谷歌标准化的可配置存储
  • :white check mark:在更多存储之间同步同意的可能性
  • : white check mark: 默认翻译

目录

纳入GTM

打开 Google 标签管理器 网络管理 并选择您网站的容器. 接下来,通过 Templates 链接并单击按钮 New 在一节内 Tag Templates。 。 。 .

你只需要一个文件 gtm_template.tpl 从此软件包的根目录中。 下载文件并在模板编辑器中导入 :

Right dropdown

在成功导入后点击按钮 Save,离开模板编辑器,然后通过 Tags 链接. 然后用导入的模板创建新标签, 因为触发设置了选项 Consent Initialization - All Pages 并保存下来.

Cookie consent tag

现在您可以打开网站的预览, 正如您看到的饼干部件在这里! 但让我们来配置一下.

配置

: 感叹: 高度推荐锁定软件包版本( 见字段) Package version 在成功配置模板之后。 避免使用 latest 在生产容器!

插件可以使用标记定义内的字段来配置.

基本选项

外地说明
软件包版本软件包版本 68publishers/cookie-consent。有效输入是: latest 或格式版本 x.x.x, (中文(简体) ), x.x.x-beta.x 财务报告和审定财务报表 x.x.x-alpha-x。关于现有版本,请参见 释放。 。 。 .
征得同意页面将被屏蔽, 直到用户动作 .
尽快显示部件部件将在页面负荷中自动显示 。 您必须手动触发部件 CookieConsentWrapper.unwrap().show() 如果选项已禁用.
隐藏来自 bots如果您在检测到一个bot/ crawler/webdriver时不希望插件运行, 则启用 .
订正饼干使用条款的修订编号. 详情 见下文。 。 。 .
延迟显示同意模式前的毫秒数 .

这两节都包含这些领域: Layout, (中文(简体) ), Position, (中文(简体) ), Transition。这些设置影响模式的出现地点及其形状. 同意模式按钮的行为可以通过字段配置 Primary button role, (中文(简体) ), Secondary button role (接受必要的饼干或打开设置模式),以及 Buttons order。 。 。 . 见 部件文档 更多细节.

同意方式也有选择 Show third button 将第三个按钮添加到模式中。 如果次要按钮的作用是 Open settings 第三个按钮的作用是 Accept necessary 而反之亦然.

设置模式有一个带有名称的特殊选项 Settings modal trigger selector。该选项的一个值可以是自动创建打开模式的触发按钮的 CSS 选择器。 检查 实例。 。 。 .

饼干选项

外地说明
Cookie 名称持有用户同意信息的饼干值的名称.
Cookie 域名持有用户同意信息的cookie的域名,例如".example.com". 如果值是空的,则使用"window.location.hostname"变量在浏览器中自动设置.
Cookie 过期几天后饼干就过期了.
启用 cookie 自动清除所有 cookie 都会根据用户的同意和如果启用此选项的所选策略被删除.
饼干自动清扫策略饼干自动清晰特性的策略 .
Cookie 名称将删除或保存的 cookie 名称( 根据选定的策略) .

实施了下列战略:

  1. Clear all except defined* 联合国 - 除了你定义的饼干之外 Cookie names 当用户否认任何存储时,将删除.
  2. Clear defined only* 联合国 -你定义的所有饼干 Cookie names 当用户否认任何存储时,将删除.
  3. Use cookie tables - Cookie清空基于原始的饼干表 插件一体化 《议定书》/《公约》缔约方会议申请 此选项需要.

* 联合国 无需从 Cookie name 字段,因为此饼干永远不会被自动删除.

存储选项

有以下几种储存:

  • 功能存储
  • 安全储存
  • 个性化存储
  • 自动存储
  • 自动用户数据
  • 个人化
  • 分析存储

每个存储器都定义了一个触发器的名称,如果用户表示同意,该触发器将被引用. 不需要在部件中使用或显示每个存储 。 另外,对存储的同意可以与另一个存储的同意同步.

外地说明
可见和默认状态定义存储是否应当在部件中可见,以及其默认值是什么.
   - 可见,默认启用存储在部件中可见,默认启用 .
   - 可见只读,默认启用( R)存储在部件中可见,总是启用,不能禁用(通常用于 Functionality storage) (中文(简体) ).
   - 可见,默认已禁用存储在部件中可见并默认被禁用 .
   - 隐藏,同步存储在部件中不可见,同意与另一个存储同步.
   - 隐蔽,永远残废存储在部件中不可见, 总是被禁用 。 用于应用程序完全没有使用的存储 .
将同意同步到同意可以与另一个存储同步. 选项仅在选项中可用 Visibility and default state 设置为 Hidden, Synchronized。 。 。 .
如果拒绝存储, 会在之后再次显示模式 x 天数如果拒绝存储, 设置模式将在指定天数后再次打开 。 选项仅在选项中可用 Display in the widget 设置为 Visible, Enabled by default 或者说 Visible, Disabled by default。 。 。 .
事件触发名称将引用于 granted 同意储存。 名称可能不是每个存储器独有的(只引用独特的触发器). 如果选项有空值, 不引用触发 .

如上所述,每个存储可以定义一个触发器,当与存储取得同意时,即可被引用. 在某些情况下,只有当用户同意多种存储类型时,您可能希望一些触发器被发射. 例如,如果你有一个触发器叫 fb_pixel_trigger 并且只有在用户同意的情况下,您才会发射 analytics_storage 编辑 ad_stroage。 。 。 . 那么您的配置可能是这样的:

Revision message translation

翻译设置

该软件包带有下列语言的默认翻译:

从字段取出将加载并可供部件使用的翻译 Locales。每个地方必须用新线来定义. 或者,从版本 1.0.0,也可以输入要下载翻译的URL.

Locale options

在上述例子中,英文的默认翻译被下载,德语的翻译被下载到URL https://www.example.com/public/cc-translations/de.json。 。 。 . 翻译文件必须始终使用JSON格式,其名称必须匹配一个地语.

如果您想要重写默认的翻译, 或者要为新语言添加翻译, 您可以在表格中定义它们 Translations。 。 。 .

区域检测

地方检测可影响以下字段:

外地说明
地方检测战略Browser 以获取用户的浏览器语言或 Document 读取一个值 <html lang="..."> 本页.
语言当检测策略被禁用时, 您必须定义网站语言 。 地块必须是该地块中先前定义的地块之一 Locales。 。 。 .

如何管理修订

默认修订号为 0 而数字可以通过字段更改 Revision。当您改变值时,将再次为所有用户显示同意模式. 您可以定义将在同意模式描述中显示的信息 。 如果您想要使用密钥定义自定义翻译 consent_modal_revision_message 并用密钥重写翻译 consent_modal_description替换占位符 [[revision_message]] 在同意模式说明中加上修改信息.

Revision message translation

说明: cookieconsent 插件 使用占位符 {{revision_message}} gTM 使用此标记来表示变量, 包随占位符而来 [[revision_message]] 换句话说.

样式表

外地说明
包含默认样式表如果选中此项, 部件的默认样式表将会被加载到页面中 。 我们建议继续检查选项,并在下一个选项中添加自定义样式表 .
外部样式表自定义 CSS 样式表列表 。 每行一个URL.
内部样式表自定义 CSS 规则,将在默认样式表和其他外部样式表之后注入页面.

页脚本

外地说明
管理页面脚本如果您想轻松管理已有文件, 请启用 <script> 标签.
脚本选择器用于管理的数据属性名称

版本与发布记录

68publishers-cookie-consent 共发布 72 个版本,首次发布于 2021/12/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.0latest2024/06/212 年前
1.0.0-beta.4beta2024/06/192 年前
1.0.0-beta.32024/06/192 年前
1.0.0-beta.22024/06/192 年前
1.0.0-beta.12024/06/182 年前
1.0.0-beta.02024/06/182 年前

关于 68publishers-cookie-consent 的常见问题

68publishers-cookie-consent 是什么?

基于orestbida/cookie同意GTM整合的 Cookie 同意包装.注意:该包已被作者标记为弃用——The package has been moved to @68publishers/cookie-consent.

如何安装 68publishers-cookie-consent?

在项目目录运行 npm install 68publishers-cookie-consent,或使用 pnpm add / yarn add / bun add。

68publishers-cookie-consent 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/68publishers-cookie-consent 是否存在。

68publishers-cookie-consent 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

68publishers-cookie-consent 可以商用吗?

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

68publishers-cookie-consent 的下载量有多少?

根据 npm 官方下载统计,68publishers-cookie-consent 在 2026/10/04 – 2026/11/02 这 30 天内被下载 2,823 次,日均约 94 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

68publishers-cookie-consent 还在维护吗?

最新版本 1.0.0 发布于 2024/06/21(2 年前);至今共发布 72 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/12/09。作者已将其标记为弃用,新项目建议寻找替代方案。