@c15t/scripts 3.0.0-alpha.2 → 3.0.0-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (300) hide show
  1. package/AGENTS.md +129 -63
  2. package/README.md +8 -29
  3. package/SKILL.md +33 -0
  4. package/dist/adobe-analytics.js +2 -0
  5. package/dist/ahrefs-analytics.js +2 -0
  6. package/dist/amplitude.js +2 -0
  7. package/dist/clearbit.js +2 -0
  8. package/dist/cloudflare-web-analytics.js +2 -0
  9. package/dist/cloudflare-zaraz.js +2 -0
  10. package/dist/crisp.js +2 -0
  11. package/dist/databuddy.js +2 -0
  12. package/dist/e2e-test-utils.js +2 -139
  13. package/dist/engine/compile.js +2 -89
  14. package/dist/engine/runtime.js +2 -448
  15. package/dist/events.js +2 -218
  16. package/dist/fathom-analytics.js +2 -0
  17. package/dist/front-chat.js +2 -0
  18. package/dist/google-tag-manager.js +2 -0
  19. package/dist/google-tag.js +2 -0
  20. package/dist/heap.js +2 -0
  21. package/dist/hightouch.js +2 -0
  22. package/dist/hotjar.js +2 -0
  23. package/dist/intercom.js +2 -0
  24. package/dist/klaviyo.js +2 -0
  25. package/dist/linkedin-insights.js +2 -0
  26. package/dist/logrocket.js +2 -0
  27. package/dist/matomo-analytics.js +2 -0
  28. package/dist/meta-pixel.js +2 -0
  29. package/dist/microsoft-clarity.js +2 -0
  30. package/dist/microsoft-uet.js +2 -0
  31. package/dist/mixpanel-analytics.js +2 -0
  32. package/dist/one-dollar-stats.js +2 -0
  33. package/dist/openai-pixel.js +2 -0
  34. package/dist/pinterest-tag.js +2 -0
  35. package/dist/pirsch.js +2 -0
  36. package/dist/plausible-analytics.js +2 -0
  37. package/dist/posthog.js +2 -0
  38. package/dist/promptwatch.js +2 -0
  39. package/dist/reddit-pixel.js +2 -0
  40. package/dist/registry.js +2 -422
  41. package/dist/resolve.js +2 -33
  42. package/dist/rudderstack.js +2 -0
  43. package/dist/rybbit-analytics.js +2 -0
  44. package/dist/segment.js +2 -0
  45. package/dist/snapchat-pixel.js +2 -0
  46. package/dist/tiktok-pixel.js +2 -0
  47. package/dist/types.js +2 -16
  48. package/dist/umami-analytics.js +2 -0
  49. package/dist/vendors/_shared/attributes.js +2 -14
  50. package/dist/vendors/_shared/google-consent.js +2 -27
  51. package/dist/vendors/_shared/install-builders.js +2 -21
  52. package/dist/vendors/_shared/required-id.js +2 -0
  53. package/dist/vendors/_shared/script-url.js +2 -28
  54. package/dist/vendors/ads-and-pixels/linkedin-insights.js +2 -48
  55. package/dist/vendors/ads-and-pixels/meta-pixel.js +2 -153
  56. package/dist/vendors/ads-and-pixels/microsoft-uet.js +2 -110
  57. package/dist/vendors/ads-and-pixels/openai-pixel.js +2 -88
  58. package/dist/vendors/ads-and-pixels/pinterest-tag.js +2 -123
  59. package/dist/vendors/ads-and-pixels/reddit-pixel.js +2 -107
  60. package/dist/vendors/ads-and-pixels/snapchat-pixel.js +2 -87
  61. package/dist/vendors/ads-and-pixels/tiktok-pixel.js +2 -89
  62. package/dist/vendors/ads-and-pixels/x-pixel.js +2 -48
  63. package/dist/vendors/analytics/adobe-analytics.js +2 -49
  64. package/dist/vendors/analytics/ahrefs-analytics.js +2 -27
  65. package/dist/vendors/analytics/amplitude.js +2 -134
  66. package/dist/vendors/analytics/clearbit.js +2 -28
  67. package/dist/vendors/analytics/cloudflare-web-analytics.js +2 -32
  68. package/dist/vendors/analytics/databuddy.js +2 -103
  69. package/dist/vendors/analytics/fathom-analytics.js +2 -35
  70. package/dist/vendors/analytics/google-tag.js +2 -78
  71. package/dist/vendors/analytics/heap.js +2 -134
  72. package/dist/vendors/analytics/hightouch.js +2 -109
  73. package/dist/vendors/analytics/hotjar.js +2 -44
  74. package/dist/vendors/analytics/logrocket.js +2 -58
  75. package/dist/vendors/analytics/matomo-analytics.js +2 -191
  76. package/dist/vendors/analytics/microsoft-clarity.js +2 -100
  77. package/dist/vendors/analytics/mixpanel-analytics.js +2 -93
  78. package/dist/vendors/analytics/one-dollar-stats.js +2 -30
  79. package/dist/vendors/analytics/pirsch.js +2 -67
  80. package/dist/vendors/analytics/plausible-analytics.js +2 -81
  81. package/dist/vendors/analytics/posthog.js +2 -200
  82. package/dist/vendors/analytics/promptwatch.js +2 -29
  83. package/dist/vendors/analytics/rudderstack.js +2 -183
  84. package/dist/vendors/analytics/rybbit-analytics.js +2 -63
  85. package/dist/vendors/analytics/segment.js +2 -65
  86. package/dist/vendors/analytics/umami-analytics.js +2 -39
  87. package/dist/vendors/analytics/vercel-analytics.js +2 -53
  88. package/dist/vendors/email-and-sms/klaviyo.js +2 -0
  89. package/dist/vendors/functional/crisp.js +2 -100
  90. package/dist/vendors/functional/front-chat.js +2 -64
  91. package/dist/vendors/functional/intercom.js +2 -45
  92. package/dist/vendors/tag-managers/cloudflare-zaraz.js +2 -98
  93. package/dist/vendors/tag-managers/google-tag-manager.js +2 -73
  94. package/dist/vercel-analytics.js +2 -0
  95. package/dist/x-pixel.js +2 -0
  96. package/dist-types/adobe-analytics.d.ts +2 -0
  97. package/dist-types/ahrefs-analytics.d.ts +2 -0
  98. package/dist-types/amplitude.d.ts +2 -0
  99. package/dist-types/clearbit.d.ts +2 -0
  100. package/dist-types/cloudflare-web-analytics.d.ts +2 -0
  101. package/dist-types/cloudflare-zaraz.d.ts +2 -0
  102. package/dist-types/crisp.d.ts +2 -0
  103. package/dist-types/databuddy.d.ts +2 -0
  104. package/dist-types/e2e-test-utils.d.ts +2 -0
  105. package/dist-types/engine/compile.d.ts +2 -3
  106. package/dist-types/engine/runtime.d.ts +2 -3
  107. package/dist-types/events.d.ts +2 -46
  108. package/dist-types/fathom-analytics.d.ts +2 -0
  109. package/dist-types/front-chat.d.ts +2 -0
  110. package/dist-types/google-tag-manager.d.ts +2 -0
  111. package/dist-types/google-tag.d.ts +2 -0
  112. package/dist-types/heap.d.ts +2 -0
  113. package/dist-types/hightouch.d.ts +2 -0
  114. package/dist-types/hotjar.d.ts +2 -0
  115. package/dist-types/intercom.d.ts +2 -0
  116. package/dist-types/klaviyo.d.ts +2 -0
  117. package/dist-types/linkedin-insights.d.ts +2 -0
  118. package/dist-types/logrocket.d.ts +2 -0
  119. package/dist-types/matomo-analytics.d.ts +2 -0
  120. package/dist-types/meta-pixel.d.ts +2 -0
  121. package/dist-types/microsoft-clarity.d.ts +2 -0
  122. package/dist-types/microsoft-uet.d.ts +2 -0
  123. package/dist-types/mixpanel-analytics.d.ts +2 -0
  124. package/dist-types/one-dollar-stats.d.ts +2 -0
  125. package/dist-types/openai-pixel.d.ts +2 -0
  126. package/dist-types/pinterest-tag.d.ts +2 -0
  127. package/dist-types/pirsch.d.ts +2 -0
  128. package/dist-types/plausible-analytics.d.ts +2 -0
  129. package/dist-types/posthog.d.ts +2 -0
  130. package/dist-types/promptwatch.d.ts +2 -0
  131. package/dist-types/reddit-pixel.d.ts +2 -0
  132. package/dist-types/registry.d.ts +2 -485
  133. package/dist-types/resolve.d.ts +2 -9
  134. package/dist-types/rudderstack.d.ts +2 -0
  135. package/dist-types/rybbit-analytics.d.ts +2 -0
  136. package/dist-types/segment.d.ts +2 -0
  137. package/dist-types/snapchat-pixel.d.ts +2 -0
  138. package/dist-types/tiktok-pixel.d.ts +2 -0
  139. package/dist-types/types.d.ts +2 -314
  140. package/dist-types/umami-analytics.d.ts +2 -0
  141. package/dist-types/vendors/_shared/attributes.d.ts +2 -35
  142. package/dist-types/vendors/_shared/google-consent.d.ts +2 -47
  143. package/dist-types/vendors/_shared/install-builders.d.ts +2 -30
  144. package/dist-types/vendors/_shared/required-id.d.ts +2 -0
  145. package/dist-types/vendors/_shared/script-url.d.ts +2 -75
  146. package/dist-types/vendors/ads-and-pixels/linkedin-insights.d.ts +2 -92
  147. package/dist-types/vendors/ads-and-pixels/meta-pixel.d.ts +2 -289
  148. package/dist-types/vendors/ads-and-pixels/microsoft-uet.d.ts +2 -105
  149. package/dist-types/vendors/ads-and-pixels/openai-pixel.d.ts +2 -211
  150. package/dist-types/vendors/ads-and-pixels/pinterest-tag.d.ts +2 -295
  151. package/dist-types/vendors/ads-and-pixels/reddit-pixel.d.ts +2 -210
  152. package/dist-types/vendors/ads-and-pixels/snapchat-pixel.d.ts +2 -171
  153. package/dist-types/vendors/ads-and-pixels/tiktok-pixel.d.ts +2 -106
  154. package/dist-types/vendors/ads-and-pixels/x-pixel.d.ts +2 -183
  155. package/dist-types/vendors/analytics/adobe-analytics.d.ts +2 -75
  156. package/dist-types/vendors/analytics/ahrefs-analytics.d.ts +2 -62
  157. package/dist-types/vendors/analytics/amplitude.d.ts +2 -234
  158. package/dist-types/vendors/analytics/clearbit.d.ts +2 -60
  159. package/dist-types/vendors/analytics/cloudflare-web-analytics.d.ts +2 -67
  160. package/dist-types/vendors/analytics/databuddy.d.ts +2 -147
  161. package/dist-types/vendors/analytics/fathom-analytics.d.ts +2 -90
  162. package/dist-types/vendors/analytics/google-tag.d.ts +2 -95
  163. package/dist-types/vendors/analytics/heap.d.ts +2 -316
  164. package/dist-types/vendors/analytics/hightouch.d.ts +2 -285
  165. package/dist-types/vendors/analytics/hotjar.d.ts +2 -73
  166. package/dist-types/vendors/analytics/logrocket.d.ts +2 -101
  167. package/dist-types/vendors/analytics/matomo-analytics.d.ts +2 -41
  168. package/dist-types/vendors/analytics/microsoft-clarity.d.ts +2 -97
  169. package/dist-types/vendors/analytics/mixpanel-analytics.d.ts +2 -113
  170. package/dist-types/vendors/analytics/one-dollar-stats.d.ts +2 -39
  171. package/dist-types/vendors/analytics/pirsch.d.ts +2 -96
  172. package/dist-types/vendors/analytics/plausible-analytics.d.ts +2 -122
  173. package/dist-types/vendors/analytics/posthog.d.ts +2 -175
  174. package/dist-types/vendors/analytics/promptwatch.d.ts +2 -36
  175. package/dist-types/vendors/analytics/rudderstack.d.ts +2 -330
  176. package/dist-types/vendors/analytics/rybbit-analytics.d.ts +2 -82
  177. package/dist-types/vendors/analytics/segment.d.ts +2 -164
  178. package/dist-types/vendors/analytics/umami-analytics.d.ts +2 -93
  179. package/dist-types/vendors/analytics/vercel-analytics.d.ts +2 -66
  180. package/dist-types/vendors/email-and-sms/klaviyo.d.ts +2 -0
  181. package/dist-types/vendors/functional/crisp.d.ts +2 -78
  182. package/dist-types/vendors/functional/front-chat.d.ts +2 -62
  183. package/dist-types/vendors/functional/intercom.d.ts +2 -135
  184. package/dist-types/vendors/tag-managers/cloudflare-zaraz.d.ts +2 -39
  185. package/dist-types/vendors/tag-managers/google-tag-manager.d.ts +2 -96
  186. package/dist-types/vercel-analytics.d.ts +2 -0
  187. package/dist-types/x-pixel.d.ts +2 -0
  188. package/docs/README.md +129 -63
  189. package/docs/assets/v3/bottom-bar.png +0 -0
  190. package/docs/assets/v3/brand-card.png +0 -0
  191. package/docs/assets/v3/brand-preferences.png +0 -0
  192. package/docs/assets/v3/choice-wall.png +0 -0
  193. package/docs/assets/v3/headless-bar-html.png +0 -0
  194. package/docs/assets/v3/headless-bar-mobile.png +0 -0
  195. package/docs/assets/v3/headless-bar.png +0 -0
  196. package/docs/assets/v3/slim-bar.png +0 -0
  197. package/docs/concepts/choose-your-setup.md +87 -0
  198. package/docs/concepts/consent-categories.md +84 -0
  199. package/docs/{guides → concepts}/consent-state.md +89 -105
  200. package/docs/{guides → concepts}/data-fetching.md +31 -27
  201. package/docs/concepts/how-consent-works.md +123 -0
  202. package/docs/concepts/policies.md +71 -0
  203. package/docs/customization/class-names.md +202 -0
  204. package/docs/customization/dark-mode.md +157 -0
  205. package/docs/customization/motion.md +119 -0
  206. package/docs/customization/overview.md +67 -34
  207. package/docs/customization/recipes.md +839 -49
  208. package/docs/customization/slots.md +216 -35
  209. package/docs/customization/stylesheets.md +147 -0
  210. package/docs/customization/tailwind.md +842 -0
  211. package/docs/customization/tokens.md +163 -96
  212. package/docs/customization/translations.md +60 -3
  213. package/docs/frameworks/astro/embeds.md +160 -0
  214. package/docs/frameworks/astro/network-blocker.md +86 -0
  215. package/docs/frameworks/astro/scripts.md +155 -0
  216. package/docs/frameworks/html/embeds.md +142 -0
  217. package/docs/frameworks/html/network-blocker.md +105 -0
  218. package/docs/frameworks/html/scripts.md +164 -0
  219. package/docs/frameworks/javascript/scripts.md +137 -0
  220. package/docs/frameworks/next/embeds.md +90 -0
  221. package/docs/frameworks/next/network-blocker.md +153 -0
  222. package/docs/frameworks/next/scripts.md +196 -0
  223. package/docs/frameworks/nuxt/embeds.md +81 -0
  224. package/docs/frameworks/nuxt/network-blocker.md +97 -0
  225. package/docs/frameworks/nuxt/scripts.md +89 -0
  226. package/docs/frameworks/react/embeds.md +89 -0
  227. package/docs/frameworks/react/network-blocker.md +140 -0
  228. package/docs/frameworks/react/scripts.md +115 -0
  229. package/docs/frameworks/svelte/embeds.md +96 -0
  230. package/docs/frameworks/svelte/network-blocker.md +141 -0
  231. package/docs/frameworks/svelte/scripts.md +144 -0
  232. package/docs/frameworks/sveltekit/embeds.md +103 -0
  233. package/docs/frameworks/sveltekit/network-blocker.md +159 -0
  234. package/docs/frameworks/sveltekit/scripts.md +172 -0
  235. package/docs/frameworks/tanstack-start/embeds.md +96 -0
  236. package/docs/frameworks/tanstack-start/network-blocker.md +145 -0
  237. package/docs/frameworks/tanstack-start/scripts.md +103 -0
  238. package/docs/frameworks/vue/embeds.md +84 -0
  239. package/docs/frameworks/vue/network-blocker.md +99 -0
  240. package/docs/frameworks/vue/scripts.md +93 -0
  241. package/docs/guides/banner-experiments.md +654 -0
  242. package/docs/guides/troubleshooting.md +120 -47
  243. package/docs/guides/verify-consent.md +81 -49
  244. package/docs/integrations/adobe-analytics.md +167 -159
  245. package/docs/integrations/ahrefs-analytics.md +152 -154
  246. package/docs/integrations/amplitude.md +162 -156
  247. package/docs/integrations/building-integrations.md +136 -37
  248. package/docs/integrations/clearbit.md +154 -154
  249. package/docs/integrations/cloudflare-web-analytics.md +156 -156
  250. package/docs/integrations/cloudflare-zaraz.md +209 -261
  251. package/docs/integrations/crisp.md +164 -158
  252. package/docs/integrations/databuddy.md +157 -173
  253. package/docs/integrations/fathom-analytics.md +158 -156
  254. package/docs/integrations/front-chat.md +167 -167
  255. package/docs/integrations/google-maps.md +118 -83
  256. package/docs/integrations/google-tag-manager.md +178 -163
  257. package/docs/integrations/google-tag.md +163 -160
  258. package/docs/integrations/heap.md +163 -155
  259. package/docs/integrations/hightouch.md +161 -157
  260. package/docs/integrations/hotjar.md +159 -155
  261. package/docs/integrations/intercom.md +183 -153
  262. package/docs/integrations/klaviyo.md +486 -0
  263. package/docs/integrations/linkedin-insights.md +174 -150
  264. package/docs/integrations/logrocket.md +160 -156
  265. package/docs/integrations/matomo-analytics.md +188 -178
  266. package/docs/integrations/meta-pixel.md +188 -150
  267. package/docs/integrations/microsoft-clarity.md +163 -155
  268. package/docs/integrations/microsoft-uet.md +148 -154
  269. package/docs/integrations/mixpanel-analytics.md +155 -160
  270. package/docs/integrations/one-dollar-stats.md +166 -165
  271. package/docs/integrations/openai-pixel.md +204 -301
  272. package/docs/integrations/overview.md +137 -80
  273. package/docs/integrations/pinterest-tag.md +191 -183
  274. package/docs/integrations/pirsch.md +169 -159
  275. package/docs/integrations/plausible-analytics.md +172 -158
  276. package/docs/integrations/posthog.md +313 -240
  277. package/docs/integrations/promptwatch.md +154 -154
  278. package/docs/integrations/reddit-pixel.md +185 -157
  279. package/docs/integrations/rudderstack.md +201 -186
  280. package/docs/integrations/rybbit-analytics.md +171 -160
  281. package/docs/integrations/segment.md +182 -154
  282. package/docs/integrations/snapchat-pixel.md +186 -156
  283. package/docs/integrations/tiktok-pixel.md +171 -150
  284. package/docs/integrations/umami-analytics.md +163 -158
  285. package/docs/integrations/vercel-analytics.md +166 -157
  286. package/docs/integrations/x-pixel.md +176 -150
  287. package/docs/integrations/youtube.md +121 -86
  288. package/docs/upgrade-v3.md +496 -467
  289. package/package.json +10 -257
  290. package/dist-types/__tests__/helpers.d.ts +0 -141
  291. package/docs/assets/v3/brand-bar.png +0 -0
  292. package/docs/assets/v3/mobile-card.png +0 -0
  293. package/docs/assets/v3/preferences.png +0 -0
  294. package/docs/frameworks/javascript/script-loader.md +0 -100
  295. package/docs/frameworks/next/script-loader.md +0 -216
  296. package/docs/frameworks/react/script-loader.md +0 -69
  297. package/docs/guides/deployment-modes.md +0 -75
  298. package/docs/guides/shared-consent-controls.md +0 -158
  299. package/docs/integrations/clear-on-revocation.md +0 -167
  300. package/docs/integrations/granular-consent.md +0 -210
@@ -1,40 +1,43 @@
1
1
  ---
2
2
  title: OpenAI Pixel
3
- description: Configure the OpenAI Measurement Pixel for ChatGPT Ads with c15t
4
- v3, manage marketing permission and verify conversion delivery.
3
+ description: Load the ChatGPT Ads Measurement Pixel only after marketing consent
4
+ with the c15t openaiPixel helper, guard oaiq conversion calls, and check it in
5
+ DevTools.
6
+ icon: chatgpt
5
7
  group: integrations
6
8
  ---
7
9
 
8
- ## Configure OpenAI Pixel
10
+ ## Configure the OpenAI Pixel
9
11
 
10
- Copy your Pixel ID from the conversions tab in OpenAI Ads Manager. The helper
11
- initializes `oaiq` and loads the SDK when marketing permission allows it.
12
+ Copy the pixel ID from the conversions tab in OpenAI Ads Manager. Remove the
13
+ standalone OpenAI installation snippet, because the helper creates the `oaiq`
14
+ queue and initializes the pixel itself.
12
15
 
13
- | Package manager | Command |
14
- | :-------------- | :-------------------------- |
15
- | npm | `npm install @c15t/scripts` |
16
- | pnpm | `pnpm add @c15t/scripts` |
17
- | yarn | `yarn add @c15t/scripts` |
18
- | bun | `bun add @c15t/scripts` |
16
+ | Package manager | Command |
17
+ | :-------------- | :------------------------------------- |
18
+ | npm | `npm install @c15t/integrations@alpha` |
19
+ | pnpm | `pnpm add @c15t/integrations@alpha` |
20
+ | yarn | `yarn add @c15t/integrations@alpha` |
21
+ | bun | `bun add @c15t/integrations@alpha` |
19
22
 
20
23
  ```ts title="src/consent-scripts.ts"
21
- import { openaiPixel } from '@c15t/scripts/openai-pixel';
24
+ import { openaiPixel } from '@c15t/integrations/openai-pixel';
22
25
 
23
26
  export const scripts = [openaiPixel({ pixelId: 'YOUR_PIXEL_ID' })];
24
27
  ```
25
28
 
26
- Remove the standalone OpenAI installation snippet when using this integration.
27
- c15t creates the `oaiq` queue, initializes the pixel, and loads the SDK.
28
-
29
29
  ## Register the scripts
30
30
 
31
31
  Complete your [framework quickstart](https://c15t.com/docs/frameworks) first. Keep its Inth
32
32
  endpoint, policy, styles and consent UI. Remove the vendor's original script,
33
- SDK initializer or tag-manager entry so c15t owns loading once.
33
+ SDK initializer or tag-manager entry, so the vendor loads only through c15t.
34
34
 
35
- The `scripts` export in `src/consent-scripts.ts` is a configuration, not an
36
- initializer. Add it to your existing consent owner using the registration point
37
- below. These are partial edits to that owner, not additional providers.
35
+ The vendor pages put the helper in `src/consent-scripts.ts`. If your framework
36
+ quickstart already created a scripts file, such as `lib/scripts.ts` in the
37
+ Next.js guide, add the helper to that array instead of creating a second file.
38
+ The `scripts` export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration
39
+ point for your framework below. These are edits to that provider, not a second
40
+ provider.
38
41
 
39
42
  **Next.js**
40
43
 
@@ -55,158 +58,106 @@ router guide. Its manifest, init and save URLs stay in effect. Add
55
58
  </ConsentRoot>
56
59
  ```
57
60
 
58
- For a Pages Router or static-export setup using `ConsentProvider`, add
59
- `scripts` to its existing `options` instead. Keep the router-specific setup
60
- from [Next.js script loading](../frameworks/next/script-loader.md).
61
+ App Router, Pages Router and static export all use this `ConsentRoot` in
62
+ the `'use client'` wrapper `components/consent.tsx`. Keep `scripts` there,
63
+ because a Server Component cannot pass script callbacks to it. See
64
+ [Next.js scripts and embeds](../frameworks/next/scripts.md).
61
65
 
62
66
  **TanStack Start**
63
67
 
64
- In your existing root route component, import the scripts alongside
65
- `ConsentRoot`. Keep the server loader from the [TanStack Start quickstart](https://c15t.com/docs/frameworks/tanstack-start/quickstart).
68
+ Import the configuration into your root route and pass it to the existing
69
+ `ConsentRoot` as a top-level prop. Keep the loader, `backendURL` and
70
+ `initRoute` from the [TanStack Start quickstart](https://c15t.com/docs/frameworks/tanstack-start/quickstart):
66
71
 
67
- ```tsx
68
- import { Outlet } from '@tanstack/react-router';
69
- import { ConsentRoot } from 'c15t/tanstack-start';
72
+ ```tsx title="src/routes/__root.tsx"
70
73
  import { scripts } from '../consent-scripts';
71
74
 
72
- function Root() {
73
- const state = Route.useLoaderData();
74
- return (
75
- <ConsentRoot state={state} backendURL={backendURL} initRoute={false} scripts={scripts}>
76
- <Outlet />
77
- {/* Keep your consent banner, dialog and preferences link here. */}
78
- </ConsentRoot>
79
- );
80
- }
75
+ <ConsentRoot
76
+ state={consent}
77
+ backendURL={backendURL}
78
+ initRoute={false}
79
+ scripts={scripts}
80
+ >
81
81
  ```
82
82
 
83
- This edits the existing route. `Route` and `backendURL` come from its setup;
84
- keep the document shell and head components if they are part of your root.
85
- `initRoute={false}` keeps the quickstart's direct-backend initialization.
86
- If your app mounts a consent server route, retain its existing `initRoute`
87
- instead. Do not return script callbacks from a server function or route loader.
83
+ Import vendor helpers in the root route module, not in a server function.
84
+ A server function's return value must be serializable, and script
85
+ configurations carry callbacks. See
86
+ [TanStack Start scripts](../frameworks/tanstack-start/scripts.md).
88
87
 
89
88
  **React**
90
89
 
91
- Import the scripts into your existing provider component:
90
+ Add the configuration to the existing `ConsentProvider` options, next to
91
+ `mode`:
92
92
 
93
- ```ts
94
- import { ConsentProvider } from 'c15t/react';
93
+ ```tsx title="src/consent.tsx"
95
94
  import { scripts } from './consent-scripts';
96
- ```
97
95
 
98
- Keep the existing options and add `scripts`:
99
-
100
- ```tsx
101
- <ConsentProvider options={{ ...consentOptions, scripts }}>
102
- {children}
103
- </ConsentProvider>
96
+ <ConsentProvider options={{ mode, scripts }}>
104
97
  ```
105
98
 
106
- Here `consentOptions` is your existing configuration, including
107
- `mode: hosted({ url: backendURL })`. Keep the banner, dialog and preferences
108
- link inside the provider. See [React script loading](../frameworks/react/script-loader.md).
99
+ `mode` is the `hosted({ url: 'https://your-project.inth.app' })` value
100
+ from the [React quickstart](https://c15t.com/docs/frameworks/react/quickstart). Keep the banner,
101
+ dialog and preferences link inside the provider. See
102
+ [React scripts and embeds](../frameworks/react/scripts.md).
109
103
 
110
104
  **Nuxt**
111
105
 
112
- Attach one loader from the root `app.vue`, after the Nuxt module has
113
- started its browser runtime. This keeps vendor callbacks in application code rather
114
- than serialized `nuxt.config.ts` runtime configuration.
106
+ Register the scripts under the `c15t` key in `app/app.config.ts`. Adjust the
107
+ relative import to where you created `consent-scripts.ts`:
115
108
 
116
- ```vue title="app/app.vue"
117
- <script setup lang="ts">
118
- import { onUnmounted } from 'vue';
119
- import { createScriptLoader } from 'c15t/modules/script-loader';
109
+ ```ts title="app/app.config.ts"
120
110
  import { scripts } from '../src/consent-scripts';
121
111
 
122
- const nuxtApp = useNuxtApp();
123
- const kernel = useConsentKernel();
124
- let loader: ReturnType<typeof createScriptLoader> | undefined;
125
-
126
- const removeMountedHook = nuxtApp.hook('app:mounted', () => {
127
- loader = createScriptLoader({ kernel, scripts });
112
+ export default defineAppConfig({
113
+ c15t: { scripts },
128
114
  });
129
- onUnmounted(() => {
130
- removeMountedHook();
131
- loader?.dispose();
132
- });
133
- </script>
134
-
135
- <template>
136
- <ConsentRoot />
137
- <NuxtPage />
138
- </template>
139
115
  ```
140
116
 
141
- Merge the setup code into your root and retain its footer and preferences
142
- link. `useConsentKernel` is auto-imported by the c15t Nuxt module. Adjust the
143
- relative script import if your `app.vue` is at the project root. This loader
144
- waits until the module has applied browser persistence and privacy signals,
145
- then reads the current snapshot and observes future changes. Do not also register these scripts
146
- in another loader. See the [Nuxt quickstart](https://c15t.com/docs/frameworks/nuxt/quickstart).
117
+ The Nuxt module merges this over its options in `nuxt.config.ts` and starts
118
+ one script loader in the browser after hydration, once it has applied the
119
+ visitor's stored choice and privacy signals. Keep `scripts` out of
120
+ `nuxt.config.ts`, which reaches the browser as JSON and drops the vendor
121
+ callbacks. Write the vendor IDs into `consent-scripts.ts`. See
122
+ [Nuxt scripts and embeds](../frameworks/nuxt/scripts.md).
147
123
 
148
124
  **Vue**
149
125
 
150
- Use the kernel already provided by the Vue plugin. Merge this setup into
151
- `App.vue`, whose lifetime covers the application:
126
+ Pass the scripts to the existing `c15tVue` plugin call in `src/main.ts`:
152
127
 
153
- ```vue title="src/App.vue"
154
- <script setup lang="ts">
155
- import { onMounted, onUnmounted } from 'vue';
156
- import { createScriptLoader } from 'c15t/modules/script-loader';
157
- import { useConsentKernel } from 'c15t/vue/vue-plugin';
158
- import ConsentRoot from 'c15t/vue/consent-root';
128
+ ```ts title="src/main.ts"
159
129
  import { scripts } from './consent-scripts';
160
130
 
161
- const kernel = useConsentKernel();
162
- let loader: ReturnType<typeof createScriptLoader> | undefined;
163
-
164
- onMounted(() => {
165
- loader = createScriptLoader({ kernel, scripts });
131
+ app.use(c15tVue, {
132
+ backendURL: 'https://your-project.inth.app',
133
+ scripts,
166
134
  });
167
- onUnmounted(() => loader?.dispose());
168
- </script>
169
-
170
- <template>
171
- <ConsentRoot />
172
- <main>Your application</main>
173
- </template>
174
135
  ```
175
136
 
176
- Keep your existing page content and preferences link. The plugin still owns
177
- the kernel and persistence; this component owns only the vendor loader.
178
- Do not register the same scripts in plugin configuration as well. See the
179
- [Vue quickstart](https://c15t.com/docs/frameworks/vue/quickstart).
137
+ Keep your existing backend URL and other options. The plugin starts one
138
+ script loader when the app mounts, after it has applied the visitor's stored
139
+ choice. Do not also call `createScriptLoader` from a component. See
140
+ [Vue scripts and embeds](../frameworks/vue/scripts.md).
180
141
 
181
142
  **Astro**
182
143
 
183
- Point the existing Astro integration at a client module. Keep its `mode`,
184
- `ui` and framework integration from the [Astro quickstart](https://c15t.com/docs/frameworks/astro/quickstart).
185
- Import `fileURLToPath` in your Astro configuration:
186
-
187
- ```js title="astro.config.mjs"
188
- import { fileURLToPath } from 'node:url';
189
- ```
190
-
191
- Add this option to the existing `c15t({ ... })` call. Resolve the path from
192
- the configuration file because Astro injects the import into a virtual module:
193
-
194
- ```js
195
- clientEntrypoint: fileURLToPath(new URL('./src/c15t.client.ts', import.meta.url)),
196
- ```
144
+ Add the scripts to the client entrypoint from the
145
+ [Astro quickstart](https://c15t.com/docs/frameworks/astro/quickstart), the module that the
146
+ integration's `clientEntrypoint` option names. Keep `mode`, `ui` and the
147
+ framework integration in `astro.config.mjs` as they are. If the module
148
+ already exports scripts, combine the two arrays.
197
149
 
198
- Export the scripts from that module:
199
-
200
- ```ts title="src/c15t.client.ts"
150
+ ```ts title="src/consent-client.ts"
201
151
  import type { C15tClientOptionsExtension } from 'c15t/astro';
202
152
  import { scripts } from './consent-scripts';
203
153
 
204
154
  export default { scripts } satisfies C15tClientOptionsExtension;
205
155
  ```
206
156
 
207
- The integration passes this extension to its shared browser runtime. Vendor
208
- helpers contain callbacks, so do not put them in the serialized `scripts`
209
- option in `astro.config.mjs`. Keep one runtime across consent islands and
157
+ Vendor helpers contain callbacks, and the integration options in
158
+ `astro.config.mjs` are serialized into the page, so do not put helpers in
159
+ the integration's `scripts` option. The integration passes the client
160
+ entrypoint to the one runtime every page shares, including across
210
161
  `ClientRouter` navigation.
211
162
 
212
163
  **Svelte**
@@ -219,9 +170,7 @@ pass them as a top-level prop:
219
170
  import { ConsentManagerProvider, hosted } from '@c15t/svelte';
220
171
  import { scripts } from './consent-scripts';
221
172
 
222
- const backendURL = import.meta.env.VITE_C15T_BACKEND_URL;
223
- if (!backendURL) throw new Error('Set VITE_C15T_BACKEND_URL');
224
- const mode = hosted({ url: backendURL });
173
+ const mode = hosted({ url: 'https://your-project.inth.app' });
225
174
  </script>
226
175
 
227
176
  <ConsentManagerProvider {mode} {scripts}>
@@ -243,7 +192,7 @@ and its serializable prefetch data from the [SvelteKit quickstart](https://c15t.
243
192
  import { scripts } from '../consent-scripts';
244
193
 
245
194
  let { children, data } = $props();
246
- const mode = hosted({ url: data.backendURL });
195
+ const mode = hosted({ url: 'https://your-project.inth.app' });
247
196
  </script>
248
197
 
249
198
  <ConsentManagerProvider {mode} {scripts} prefetch={data.prefetch}>
@@ -252,190 +201,144 @@ and its serializable prefetch data from the [SvelteKit quickstart](https://c15t.
252
201
  </ConsentManagerProvider>
253
202
  ```
254
203
 
255
- Import vendor helpers in the layout component, not in `+layout.server.ts`.
256
- For static hosting, keep your browser-only `mode` setup and omit request
257
- prefetch; the `scripts` prop stays the same. If you pass an externally owned
204
+ Import vendor helpers in the layout component, not in `+layout.server.ts`:
205
+ a server load cannot send functions to the browser. Prerendered, static and
206
+ SPA-mode pages use the same `scripts` prop. If you pass an externally owned
258
207
  `runtime` to the provider, register scripts when creating that runtime instead.
259
208
 
260
- **JavaScript**
261
-
262
- Attach the loader to your existing kernel before calling
263
- `kernel.commands.init()`:
264
-
265
- ```ts
266
- import { createScriptLoader } from 'c15t/modules/script-loader';
267
- import { scripts } from './consent-scripts';
268
-
269
- const loader = createScriptLoader({ kernel, scripts });
270
- ```
271
-
272
- Call `loader.dispose()` when that application instance is destroyed.
273
- `kernel` is the hosted kernel from your quickstart. A provider-owned kernel
274
- already has a loader; do not attach a second one. See
275
- [JavaScript script loading](../frameworks/javascript/script-loader.md).
276
-
277
- ## Options
278
-
279
- | Option | Type | Default | Description |
280
- | ----------- | ----------------- | ------------------------------------------- | -------------------------------------------------- |
281
- | `pixelId` | `string` | Required | Your OpenAI Ads Manager Pixel ID. |
282
- | `debug` | `boolean` | `false` | Log SDK activity to the browser console. |
283
- | `user` | `OpenAIPixelUser` | Omitted | User matching fields passed to SDK initialization. |
284
- | `scriptSrc` | `string` | `https://bzrcdn.openai.com/sdk/oaiq.min.js` | Override the SDK URL. |
285
-
286
- ## Consent behavior
287
-
288
- The first SDK request waits for effective `marketing` permission. Under an
289
- opt-in policy, that means waiting for the visitor to grant consent.
290
- `measurement` permission alone does not enable this advertising pixel.
209
+ **HTML**
291
210
 
292
- Before the SDK loads, c15t queues these commands in order:
211
+ The helpers in `@c15t/integrations` are ES modules that need a bundler. On a
212
+ page that loads the c15t script tag, paste the vendor's own snippet instead
213
+ and keep it inert until its category is allowed:
293
214
 
294
- ```js
295
- oaiq('consent', false);
296
- oaiq('init', { pixelId: 'YOUR_PIXEL_ID', debug: false });
297
- oaiq('consent', true);
298
- ```
299
-
300
- The initial denial overrides the SDK's default consent of `true`. Once loaded,
301
- the SDK stays on the page. c15t calls `oaiq('consent', false)` when marketing
302
- permission is denied and `oaiq('consent', true)` when it is granted again.
303
- Granting permission again does not reload or reinitialize the pixel.
304
-
305
- OpenAI documents that denied measurement events are dropped and are not replayed
306
- when consent returns. Consent denial does not unload the SDK or promise to erase
307
- existing attribution cookies. The SDK can still send diagnostic pings while
308
- measurement consent is denied.
309
-
310
- ## User matching
311
-
312
- Add `user` to the existing `openaiPixel` configuration in
313
- `src/consent-scripts.ts` to include customer matching data at initialization.
314
- All fields are optional:
315
-
316
- * `email_sha256`, `phone_number_sha256`, `external_id_sha256`,
317
- `first_name_sha256`, and `last_name_sha256` accept normalized SHA-256 hashes.
318
- * `country`, `city`, `region`, and `postal_code` accept location strings.
319
-
320
- ```ts
321
- openaiPixel({
322
- pixelId: 'YOUR_PIXEL_ID',
323
- user: { country: 'US', region: 'California', postal_code: '94107' },
324
- });
215
+ ```html
216
+ <script type="text/plain" data-c15t-category="measurement">
217
+ // The vendor's snippet, unchanged
218
+ </script>
325
219
  ```
326
220
 
327
- Normalize identifiers according to OpenAI's
328
- [user data rules](https://developers.openai.com/ads/measurement-pixel#send-user-data),
329
- then hash them as lowercase, 64-character SHA-256 hex strings. c15t forwards these
330
- values unchanged. It does not collect customer location or identifiers, or
331
- normalize or hash identifiers for you.
332
-
333
- If user data becomes available after initialization, pass the complete updated
334
- object through `window.oaiq?.('init', { pixelId: 'YOUR_PIXEL_ID', user })`.
335
- User data belongs on `init`, not on individual conversion events. Automatic
336
- advanced matching is configured by OpenAI; it is not an additional SDK init option.
221
+ Use the category this guide names for the vendor. c15t runs the snippet
222
+ once that category is allowed, and reloads the page when the visitor
223
+ withdraws it. Helper options on this page, such as `loadMode`, do not apply
224
+ to a pasted snippet. See [HTML scripts](../frameworks/html/scripts.md).
337
225
 
338
- ## Send conversions
339
-
340
- Installing the pixel does not send a conversion or page view. Check effective
341
- marketing permission using your framework
342
- [consent API](https://c15t.com/docs/frameworks) before calling `openaiPixelEvent` from an
343
- application event handler. The helper checks API availability, not permission;
344
- the loaded SDK applies the consent signal supplied by c15t.
226
+ **JavaScript**
345
227
 
346
- This partial example belongs in an order-completion handler after that
347
- permission check. It sends an order value of $25.99:
228
+ Pass the scripts to `init()` from `@c15t/browser`, next to your backend
229
+ URL:
348
230
 
349
231
  ```ts
350
- import { openaiPixelEvent } from '@c15t/scripts/openai-pixel';
351
-
352
- openaiPixelEvent(
353
- 'order_created',
354
- { type: 'contents', amount: 2599, currency: 'USD' },
355
- { event_id: 'order_123', opt_out: true },
356
- );
357
- ```
358
-
359
- The helper supports every documented browser event and its corresponding data
360
- shape. The optional fourth argument to the SDK, passed as the helper's third
361
- argument, supports `event_id` for browser/server deduplication and `opt_out` for
362
- opting an event out of future user-level personalization.
363
-
364
- Calls made before the queue exists are dropped. A callable `window.oaiq` does
365
- not mean marketing permission is still granted. Stop application event calls
366
- when permission is denied, even though the SDK remains loaded.
367
-
368
- `window.oaiq` is also typed for `init`, `consent`, `measure`, and `measureSingle`.
369
- The event helper uses `measure`, which sends to every initialized pixel. To target
370
- one initialized pixel, use:
232
+ import { init } from '@c15t/browser';
233
+ import { scripts } from './consent-scripts';
371
234
 
372
- ```ts
373
- window.oaiq?.(
374
- 'measureSingle',
375
- 'YOUR_PIXEL_ID',
376
- 'page_viewed',
377
- { type: 'contents' },
378
- );
235
+ const consent = init({
236
+ backendURL: 'https://your-project.inth.app',
237
+ scripts,
238
+ });
379
239
  ```
380
240
 
381
- See OpenAI's [supported events](https://developers.openai.com/ads/supported-events)
382
- for payload fields. `app_installed` and `app_opened` require the Conversions API
383
- and are not supported by the browser pixel.
241
+ Keep the backend URL from your quickstart. With
242
+ `createConsentRuntime` from `c15t/runtime`, pass `scripts` to it instead.
243
+ A kernel you create yourself needs a loader from
244
+ `c15t/modules/script-loader`. Attach one loader per kernel. See
245
+ [JavaScript scripts](../frameworks/javascript/scripts.md).
384
246
 
385
- ### Custom events
386
-
387
- Custom events require `custom_event_name`. After checking marketing permission,
388
- you can verify a custom event with a clearly named payload:
247
+ ## Options
389
248
 
390
- ```ts
391
- import { openaiPixelEvent } from '@c15t/scripts/openai-pixel';
392
-
393
- openaiPixelEvent(
394
- 'custom',
395
- { type: 'custom' },
396
- {
397
- custom_event_name: 'c15t_integration_test',
398
- event_id: crypto.randomUUID(),
399
- opt_out: true,
400
- },
401
- );
249
+ | Option | Default | Behavior |
250
+ | ----------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
251
+ | `pixelId` | Required | Pixel ID passed to `oaiq('init', ...)`. The helper trims it. Empty or whitespace-only values throw. |
252
+ | `debug` | `false` | Logs SDK activity, including queued and dropped events, to the browser console. |
253
+ | `user` | None | User matching fields passed to `init`: `email_sha256`, `phone_number_sha256`, `external_id_sha256`, `first_name_sha256`, `last_name_sha256`, `country`, `city`, `region` and `postal_code`. |
254
+ | `scriptSrc` | `https://bzrcdn.openai.com/sdk/oaiq.min.js` | SDK URL override. A blank value falls back to the default. |
255
+
256
+ c15t forwards `user` unchanged. Normalize and hash identifiers yourself as
257
+ OpenAI's
258
+ [user data rules](https://developers.openai.com/ads/measurement-pixel#send-user-data)
259
+ describe. If user data arrives after initialization, call
260
+ `window.oaiq('init', { pixelId, user })` again with the complete object.
261
+
262
+ ## Loading and revocation
263
+
264
+ `openaiPixel` uses the `marketing` category. Before marketing is allowed, c15t
265
+ defines no `oaiq` function and loads nothing from OpenAI. Measurement
266
+ permission alone does not load the pixel. When marketing becomes allowed, the
267
+ helper queues `oaiq('consent', false)`, `init` and `oaiq('consent', true)`,
268
+ then loads `oaiq.min.js`. The first call overrides the SDK's default consent of
269
+ `true`.
270
+
271
+ On revocation the helper keeps the SDK and calls `oaiq('consent', false)`. If
272
+ the visitor allows marketing again before the page reloads, it calls
273
+ `oaiq('consent', true)` without reinitializing the pixel. OpenAI drops events
274
+ sent while consent is denied and does not replay them later. The SDK can still
275
+ send diagnostic pings while consent is denied.
276
+
277
+ ## Guard your own oaiq calls
278
+
279
+ The helper sends no page view or conversion, so every event comes from your
280
+ code. After revocation `window.oaiq` still exists, so its presence does not
281
+ mean marketing is allowed. Check the permission first, then that the queue
282
+ exists:
283
+
284
+ ```ts title="src/track-order.ts"
285
+ export function trackOrder(marketingAllowed: boolean, orderId: string) {
286
+ if (!marketingAllowed || typeof window.oaiq !== 'function') return;
287
+ window.oaiq(
288
+ 'measure',
289
+ 'order_created',
290
+ { type: 'contents', amount: 2599, currency: 'USD' },
291
+ { event_id: orderId }
292
+ );
293
+ }
402
294
  ```
403
295
 
404
- ## Verify the integration
405
-
406
- Use a fresh session with an opt-in policy and set `debug: true` in your existing
407
- `openaiPixel` configuration while testing.
408
-
409
- 1. Before granting `marketing`, verify that the OpenAI SDK does not load and no
410
- measurement request is sent. Granting only `measurement` should not load it.
411
- 2. Grant `marketing` and perform an action that calls your event handler. For a
412
- page view, send `page_viewed` with `{ type: 'contents' }`.
413
- 3. Open Event Stream in Ads Manager and find the event. Inspect requests to
414
- `https://bzr.openai.com/v1/sdk/events` in the Network panel and check the
415
- response status. An accepted request confirms transport, not attribution to
416
- a ChatGPT ad.
417
- 4. Revoke `marketing` and verify that future application event calls stop. The
418
- SDK remains loaded and may still send diagnostic pings. Grant permission
419
- again and check that the SDK is not loaded twice.
420
- 5. Reload and repeat with the saved choice. Turn off `debug` after testing.
421
-
422
- The browser console reports whether the SDK queued or dropped an event. Follow
423
- the [consent verification guide](../guides/verify-consent.md) for policy and
424
- privacy-signal checks.
425
-
426
- The c15t live vendor monitor checks consent gating, the queue, the real SDK
427
- response, and runtime initialization. It uses a placeholder Pixel ID and blocks
428
- measurement requests, so monitor runs do not populate your Ads Manager events.
429
-
430
- ## Content Security Policy
431
-
432
- If your site uses a Content Security Policy, allow these sources in the
433
- corresponding directives:
434
-
435
- | Directive | Sources |
436
- | ------------- | -------------------------------------------------------- |
437
- | `script-src` | `https://bzrcdn.openai.com` |
438
- | `connect-src` | `https://bzr.openai.com` and `https://bzrcdn.openai.com` |
439
- | `img-src` | `https://bzr.openai.com` |
440
-
441
- Also allow the CDN in `script-src-elem` if your policy defines that directive.
296
+ Pass the current marketing permission from your framework, for example
297
+ `useConsent('marketing')` in React. `amount` is an integer in the currency's
298
+ minor unit, so `2599` is $25.99. Reuse `event_id` on the server event to
299
+ deduplicate it.
300
+
301
+ `@c15t/integrations/openai-pixel` also exports `openaiPixelEvent`, a typed wrapper
302
+ around `oaiq('measure', ...)`. It drops calls made before the queue exists and
303
+ does not check permission, so apply the same guard before calling it. A
304
+ `custom` event needs `custom_event_name` in its options. To send to one pixel
305
+ when you run several, call `window.oaiq('measureSingle', pixelId, ...)`.
306
+
307
+ ## Verify the OpenAI Pixel
308
+
309
+ Set `debug: true` while you test. After you allow marketing, `oaiq.min.js`
310
+ loads from `bzrcdn.openai.com`. Trigger one guarded event and check that a
311
+ request to `https://bzr.openai.com/v1/sdk/events` succeeds and the event
312
+ appears in Event Stream in Ads Manager. An accepted request confirms delivery,
313
+ not attribution to a ChatGPT ad. Then revoke marketing. Until the page
314
+ reloads, calling `trackOrder` sends nothing. Turn off `debug` when you finish.
315
+
316
+ If your site sets a Content Security Policy, allow `https://bzrcdn.openai.com`
317
+ in `script-src`, both `https://bzr.openai.com` and `https://bzrcdn.openai.com`
318
+ in `connect-src`, and `https://bzr.openai.com` in `img-src`.
319
+
320
+ Test in a private window with an opt-in policy. Open DevTools Network, disable
321
+ the cache and filter by the vendor's domain:
322
+
323
+ 1. Load the page. No request goes to the vendor before you choose.
324
+ 2. Click Reject, then reload. There is still no vendor request.
325
+ 3. Open Privacy settings and allow the helper's category. The vendor script
326
+ loads without a page reload.
327
+ 4. Turn the category off again and save. c15t reloads the page, and the new
328
+ page makes no vendor request.
329
+
330
+ c15t reloads on revocation because removing a script element does not stop
331
+ code that already ran. The vendor's listeners, timers and queued events stay
332
+ alive until the page unloads. If you set `reloadOnConsentRevoked: false`, stop
333
+ the vendor yourself. Register a callback-only script whose `onConsentChange`
334
+ calls the vendor's opt-out API, as shown in
335
+ [custom integrations](./building-integrations.md), and check the
336
+ permission before each of your own event calls. The reload does not delete
337
+ cookies the vendor already set; see
338
+ [clear on revocation for your framework](./overview.md#vendor-switches-and-cookie-cleanup).
339
+
340
+ The helper sets `vendor` to its script ID, so once you declare that vendor a
341
+ visitor can turn it off inside an allowed category. See
342
+ [vendor consent for your framework](./overview.md#vendor-switches-and-cookie-cleanup). The
343
+ [consent verification guide](../guides/verify-consent.md) covers navigation,
344
+ expiry and hosting checks.