@c15t/scripts 3.0.0-alpha.1 → 3.0.0-alpha.3
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.
- package/AGENTS.md +129 -59
- package/README.md +8 -29
- package/SKILL.md +33 -0
- package/dist/adobe-analytics.js +2 -0
- package/dist/ahrefs-analytics.js +2 -0
- package/dist/amplitude.js +2 -0
- package/dist/clearbit.js +2 -0
- package/dist/cloudflare-web-analytics.js +2 -0
- package/dist/cloudflare-zaraz.js +2 -0
- package/dist/crisp.js +2 -0
- package/dist/databuddy.js +2 -0
- package/dist/e2e-test-utils.js +2 -137
- package/dist/engine/compile.js +2 -89
- package/dist/engine/runtime.js +2 -448
- package/dist/events.js +2 -0
- package/dist/fathom-analytics.js +2 -0
- package/dist/front-chat.js +2 -0
- package/dist/google-tag-manager.js +2 -0
- package/dist/google-tag.js +2 -0
- package/dist/heap.js +2 -0
- package/dist/hightouch.js +2 -0
- package/dist/hotjar.js +2 -0
- package/dist/intercom.js +2 -0
- package/dist/klaviyo.js +2 -0
- package/dist/linkedin-insights.js +2 -0
- package/dist/logrocket.js +2 -0
- package/dist/matomo-analytics.js +2 -0
- package/dist/meta-pixel.js +2 -0
- package/dist/microsoft-clarity.js +2 -0
- package/dist/microsoft-uet.js +2 -0
- package/dist/mixpanel-analytics.js +2 -0
- package/dist/one-dollar-stats.js +2 -0
- package/dist/openai-pixel.js +2 -0
- package/dist/pinterest-tag.js +2 -0
- package/dist/pirsch.js +2 -0
- package/dist/plausible-analytics.js +2 -0
- package/dist/posthog.js +2 -0
- package/dist/promptwatch.js +2 -0
- package/dist/reddit-pixel.js +2 -0
- package/dist/registry.js +2 -392
- package/dist/resolve.js +2 -33
- package/dist/rudderstack.js +2 -0
- package/dist/rybbit-analytics.js +2 -0
- package/dist/segment.js +2 -0
- package/dist/snapchat-pixel.js +2 -0
- package/dist/tiktok-pixel.js +2 -0
- package/dist/types.js +2 -16
- package/dist/umami-analytics.js +2 -0
- package/dist/vendors/_shared/attributes.js +2 -14
- package/dist/vendors/_shared/google-consent.js +2 -27
- package/dist/vendors/_shared/install-builders.js +2 -21
- package/dist/vendors/_shared/required-id.js +2 -0
- package/dist/vendors/_shared/script-url.js +2 -28
- package/dist/vendors/ads-and-pixels/linkedin-insights.js +2 -48
- package/dist/vendors/ads-and-pixels/meta-pixel.js +2 -153
- package/dist/vendors/ads-and-pixels/microsoft-uet.js +2 -110
- package/dist/vendors/ads-and-pixels/openai-pixel.js +2 -88
- package/dist/vendors/ads-and-pixels/pinterest-tag.js +2 -0
- package/dist/vendors/ads-and-pixels/reddit-pixel.js +2 -107
- package/dist/vendors/ads-and-pixels/snapchat-pixel.js +2 -87
- package/dist/vendors/ads-and-pixels/tiktok-pixel.js +2 -89
- package/dist/vendors/ads-and-pixels/x-pixel.js +2 -48
- package/dist/vendors/analytics/adobe-analytics.js +2 -49
- package/dist/vendors/analytics/ahrefs-analytics.js +2 -27
- package/dist/vendors/analytics/amplitude.js +2 -134
- package/dist/vendors/analytics/clearbit.js +2 -28
- package/dist/vendors/analytics/cloudflare-web-analytics.js +2 -32
- package/dist/vendors/analytics/databuddy.js +2 -103
- package/dist/vendors/analytics/fathom-analytics.js +2 -35
- package/dist/vendors/analytics/google-tag.js +2 -66
- package/dist/vendors/analytics/heap.js +2 -134
- package/dist/vendors/analytics/hightouch.js +2 -109
- package/dist/vendors/analytics/hotjar.js +2 -44
- package/dist/vendors/analytics/logrocket.js +2 -58
- package/dist/vendors/analytics/matomo-analytics.js +2 -191
- package/dist/vendors/analytics/microsoft-clarity.js +2 -100
- package/dist/vendors/analytics/mixpanel-analytics.js +2 -93
- package/dist/vendors/analytics/one-dollar-stats.js +2 -0
- package/dist/vendors/analytics/pirsch.js +2 -67
- package/dist/vendors/analytics/plausible-analytics.js +2 -81
- package/dist/vendors/analytics/posthog.js +2 -200
- package/dist/vendors/analytics/promptwatch.js +2 -29
- package/dist/vendors/analytics/rudderstack.js +2 -183
- package/dist/vendors/analytics/rybbit-analytics.js +2 -63
- package/dist/vendors/analytics/segment.js +2 -56
- package/dist/vendors/analytics/umami-analytics.js +2 -39
- package/dist/vendors/analytics/vercel-analytics.js +2 -53
- package/dist/vendors/email-and-sms/klaviyo.js +2 -0
- package/dist/vendors/functional/crisp.js +2 -100
- package/dist/vendors/functional/front-chat.js +2 -0
- package/dist/vendors/functional/intercom.js +2 -45
- package/dist/vendors/tag-managers/cloudflare-zaraz.js +2 -98
- package/dist/vendors/tag-managers/google-tag-manager.js +2 -59
- package/dist/vercel-analytics.js +2 -0
- package/dist/x-pixel.js +2 -0
- package/dist-types/adobe-analytics.d.ts +2 -0
- package/dist-types/ahrefs-analytics.d.ts +2 -0
- package/dist-types/amplitude.d.ts +2 -0
- package/dist-types/clearbit.d.ts +2 -0
- package/dist-types/cloudflare-web-analytics.d.ts +2 -0
- package/dist-types/cloudflare-zaraz.d.ts +2 -0
- package/dist-types/crisp.d.ts +2 -0
- package/dist-types/databuddy.d.ts +2 -0
- package/dist-types/e2e-test-utils.d.ts +2 -0
- package/dist-types/engine/compile.d.ts +2 -3
- package/dist-types/engine/runtime.d.ts +2 -3
- package/dist-types/events.d.ts +2 -0
- package/dist-types/fathom-analytics.d.ts +2 -0
- package/dist-types/front-chat.d.ts +2 -0
- package/dist-types/google-tag-manager.d.ts +2 -0
- package/dist-types/google-tag.d.ts +2 -0
- package/dist-types/heap.d.ts +2 -0
- package/dist-types/hightouch.d.ts +2 -0
- package/dist-types/hotjar.d.ts +2 -0
- package/dist-types/intercom.d.ts +2 -0
- package/dist-types/klaviyo.d.ts +2 -0
- package/dist-types/linkedin-insights.d.ts +2 -0
- package/dist-types/logrocket.d.ts +2 -0
- package/dist-types/matomo-analytics.d.ts +2 -0
- package/dist-types/meta-pixel.d.ts +2 -0
- package/dist-types/microsoft-clarity.d.ts +2 -0
- package/dist-types/microsoft-uet.d.ts +2 -0
- package/dist-types/mixpanel-analytics.d.ts +2 -0
- package/dist-types/one-dollar-stats.d.ts +2 -0
- package/dist-types/openai-pixel.d.ts +2 -0
- package/dist-types/pinterest-tag.d.ts +2 -0
- package/dist-types/pirsch.d.ts +2 -0
- package/dist-types/plausible-analytics.d.ts +2 -0
- package/dist-types/posthog.d.ts +2 -0
- package/dist-types/promptwatch.d.ts +2 -0
- package/dist-types/reddit-pixel.d.ts +2 -0
- package/dist-types/registry.d.ts +2 -458
- package/dist-types/resolve.d.ts +2 -9
- package/dist-types/rudderstack.d.ts +2 -0
- package/dist-types/rybbit-analytics.d.ts +2 -0
- package/dist-types/segment.d.ts +2 -0
- package/dist-types/snapchat-pixel.d.ts +2 -0
- package/dist-types/tiktok-pixel.d.ts +2 -0
- package/dist-types/types.d.ts +2 -314
- package/dist-types/umami-analytics.d.ts +2 -0
- package/dist-types/vendors/_shared/attributes.d.ts +2 -35
- package/dist-types/vendors/_shared/google-consent.d.ts +2 -47
- package/dist-types/vendors/_shared/install-builders.d.ts +2 -30
- package/dist-types/vendors/_shared/required-id.d.ts +2 -0
- package/dist-types/vendors/_shared/script-url.d.ts +2 -75
- package/dist-types/vendors/ads-and-pixels/linkedin-insights.d.ts +2 -92
- package/dist-types/vendors/ads-and-pixels/meta-pixel.d.ts +2 -289
- package/dist-types/vendors/ads-and-pixels/microsoft-uet.d.ts +2 -105
- package/dist-types/vendors/ads-and-pixels/openai-pixel.d.ts +2 -211
- package/dist-types/vendors/ads-and-pixels/pinterest-tag.d.ts +2 -0
- package/dist-types/vendors/ads-and-pixels/reddit-pixel.d.ts +2 -210
- package/dist-types/vendors/ads-and-pixels/snapchat-pixel.d.ts +2 -171
- package/dist-types/vendors/ads-and-pixels/tiktok-pixel.d.ts +2 -106
- package/dist-types/vendors/ads-and-pixels/x-pixel.d.ts +2 -183
- package/dist-types/vendors/analytics/adobe-analytics.d.ts +2 -75
- package/dist-types/vendors/analytics/ahrefs-analytics.d.ts +2 -62
- package/dist-types/vendors/analytics/amplitude.d.ts +2 -234
- package/dist-types/vendors/analytics/clearbit.d.ts +2 -60
- package/dist-types/vendors/analytics/cloudflare-web-analytics.d.ts +2 -67
- package/dist-types/vendors/analytics/databuddy.d.ts +2 -147
- package/dist-types/vendors/analytics/fathom-analytics.d.ts +2 -90
- package/dist-types/vendors/analytics/google-tag.d.ts +2 -93
- package/dist-types/vendors/analytics/heap.d.ts +2 -316
- package/dist-types/vendors/analytics/hightouch.d.ts +2 -285
- package/dist-types/vendors/analytics/hotjar.d.ts +2 -73
- package/dist-types/vendors/analytics/logrocket.d.ts +2 -101
- package/dist-types/vendors/analytics/matomo-analytics.d.ts +2 -41
- package/dist-types/vendors/analytics/microsoft-clarity.d.ts +2 -97
- package/dist-types/vendors/analytics/mixpanel-analytics.d.ts +2 -113
- package/dist-types/vendors/analytics/one-dollar-stats.d.ts +2 -0
- package/dist-types/vendors/analytics/pirsch.d.ts +2 -96
- package/dist-types/vendors/analytics/plausible-analytics.d.ts +2 -122
- package/dist-types/vendors/analytics/posthog.d.ts +2 -175
- package/dist-types/vendors/analytics/promptwatch.d.ts +2 -36
- package/dist-types/vendors/analytics/rudderstack.d.ts +2 -330
- package/dist-types/vendors/analytics/rybbit-analytics.d.ts +2 -82
- package/dist-types/vendors/analytics/segment.d.ts +2 -158
- package/dist-types/vendors/analytics/umami-analytics.d.ts +2 -93
- package/dist-types/vendors/analytics/vercel-analytics.d.ts +2 -66
- package/dist-types/vendors/email-and-sms/klaviyo.d.ts +2 -0
- package/dist-types/vendors/functional/crisp.d.ts +2 -78
- package/dist-types/vendors/functional/front-chat.d.ts +2 -0
- package/dist-types/vendors/functional/intercom.d.ts +2 -135
- package/dist-types/vendors/tag-managers/cloudflare-zaraz.d.ts +2 -39
- package/dist-types/vendors/tag-managers/google-tag-manager.d.ts +2 -94
- package/dist-types/vercel-analytics.d.ts +2 -0
- package/dist-types/x-pixel.d.ts +2 -0
- package/docs/README.md +129 -59
- package/docs/assets/v3/bottom-bar.png +0 -0
- package/docs/assets/v3/brand-card.png +0 -0
- package/docs/assets/v3/brand-preferences.png +0 -0
- package/docs/assets/v3/choice-wall.png +0 -0
- package/docs/assets/v3/headless-bar-html.png +0 -0
- package/docs/assets/v3/headless-bar-mobile.png +0 -0
- package/docs/assets/v3/headless-bar.png +0 -0
- package/docs/assets/v3/slim-bar.png +0 -0
- package/docs/concepts/choose-your-setup.md +87 -0
- package/docs/concepts/consent-categories.md +84 -0
- package/docs/concepts/consent-state.md +357 -0
- package/docs/{guides → concepts}/data-fetching.md +31 -27
- package/docs/concepts/how-consent-works.md +123 -0
- package/docs/concepts/policies.md +71 -0
- package/docs/customization/class-names.md +202 -0
- package/docs/customization/dark-mode.md +157 -0
- package/docs/customization/motion.md +119 -0
- package/docs/customization/overview.md +67 -33
- package/docs/customization/recipes.md +839 -47
- package/docs/customization/slots.md +216 -35
- package/docs/customization/stylesheets.md +147 -0
- package/docs/customization/tailwind.md +842 -0
- package/docs/customization/tokens.md +166 -36
- package/docs/customization/translations.md +61 -3
- package/docs/frameworks/astro/embeds.md +160 -0
- package/docs/frameworks/astro/network-blocker.md +86 -0
- package/docs/frameworks/astro/scripts.md +146 -0
- package/docs/frameworks/html/embeds.md +142 -0
- package/docs/frameworks/html/network-blocker.md +105 -0
- package/docs/frameworks/html/scripts.md +164 -0
- package/docs/frameworks/javascript/scripts.md +119 -0
- package/docs/frameworks/next/embeds.md +90 -0
- package/docs/frameworks/next/network-blocker.md +153 -0
- package/docs/frameworks/next/scripts.md +196 -0
- package/docs/frameworks/nuxt/embeds.md +81 -0
- package/docs/frameworks/nuxt/network-blocker.md +97 -0
- package/docs/frameworks/nuxt/scripts.md +89 -0
- package/docs/frameworks/react/embeds.md +89 -0
- package/docs/frameworks/react/network-blocker.md +140 -0
- package/docs/frameworks/react/scripts.md +115 -0
- package/docs/frameworks/svelte/embeds.md +96 -0
- package/docs/frameworks/svelte/network-blocker.md +141 -0
- package/docs/frameworks/svelte/scripts.md +137 -0
- package/docs/frameworks/sveltekit/embeds.md +103 -0
- package/docs/frameworks/sveltekit/network-blocker.md +149 -0
- package/docs/frameworks/sveltekit/scripts.md +141 -0
- package/docs/frameworks/tanstack-start/embeds.md +96 -0
- package/docs/frameworks/tanstack-start/network-blocker.md +145 -0
- package/docs/frameworks/tanstack-start/scripts.md +103 -0
- package/docs/frameworks/vue/embeds.md +84 -0
- package/docs/frameworks/vue/network-blocker.md +99 -0
- package/docs/frameworks/vue/scripts.md +93 -0
- package/docs/guides/banner-experiments.md +654 -0
- package/docs/guides/troubleshooting.md +120 -47
- package/docs/guides/verify-consent.md +81 -49
- package/docs/integrations/adobe-analytics.md +168 -160
- package/docs/integrations/ahrefs-analytics.md +153 -155
- package/docs/integrations/amplitude.md +163 -157
- package/docs/integrations/building-integrations.md +136 -37
- package/docs/integrations/clearbit.md +155 -155
- package/docs/integrations/cloudflare-web-analytics.md +157 -157
- package/docs/integrations/cloudflare-zaraz.md +210 -262
- package/docs/integrations/crisp.md +165 -159
- package/docs/integrations/databuddy.md +158 -174
- package/docs/integrations/fathom-analytics.md +159 -157
- package/docs/integrations/front-chat.md +322 -0
- package/docs/integrations/google-maps.md +119 -84
- package/docs/integrations/google-tag-manager.md +179 -164
- package/docs/integrations/google-tag.md +164 -161
- package/docs/integrations/heap.md +164 -156
- package/docs/integrations/hightouch.md +162 -158
- package/docs/integrations/hotjar.md +160 -156
- package/docs/integrations/intercom.md +184 -154
- package/docs/integrations/klaviyo.md +486 -0
- package/docs/integrations/linkedin-insights.md +175 -151
- package/docs/integrations/logrocket.md +161 -157
- package/docs/integrations/matomo-analytics.md +189 -179
- package/docs/integrations/meta-pixel.md +189 -151
- package/docs/integrations/microsoft-clarity.md +164 -156
- package/docs/integrations/microsoft-uet.md +149 -155
- package/docs/integrations/mixpanel-analytics.md +156 -161
- package/docs/integrations/one-dollar-stats.md +306 -0
- package/docs/integrations/openai-pixel.md +205 -302
- package/docs/integrations/overview.md +143 -83
- package/docs/integrations/pinterest-tag.md +329 -0
- package/docs/integrations/pirsch.md +170 -160
- package/docs/integrations/plausible-analytics.md +173 -159
- package/docs/integrations/posthog.md +227 -242
- package/docs/integrations/promptwatch.md +155 -155
- package/docs/integrations/reddit-pixel.md +186 -158
- package/docs/integrations/rudderstack.md +202 -187
- package/docs/integrations/rybbit-analytics.md +172 -161
- package/docs/integrations/segment.md +183 -155
- package/docs/integrations/snapchat-pixel.md +187 -157
- package/docs/integrations/tiktok-pixel.md +172 -151
- package/docs/integrations/umami-analytics.md +164 -159
- package/docs/integrations/vercel-analytics.md +167 -158
- package/docs/integrations/x-pixel.md +177 -151
- package/docs/integrations/youtube.md +122 -87
- package/docs/upgrade-v3.md +490 -354
- package/package.json +12 -236
- package/dist-types/__tests__/helpers.d.ts +0 -141
- package/docs/assets/v3/brand-bar.png +0 -0
- package/docs/assets/v3/mobile-card.png +0 -0
- package/docs/assets/v3/preferences.png +0 -0
- package/docs/frameworks/javascript/script-loader.md +0 -94
- package/docs/frameworks/next/script-loader.md +0 -210
- package/docs/frameworks/react/script-loader.md +0 -63
- package/docs/guides/consent-state.md +0 -60
- package/docs/guides/deployment-modes.md +0 -75
- package/docs/integrations/clear-on-revocation.md +0 -167
- package/docs/integrations/granular-consent.md +0 -208
|
@@ -1,40 +1,43 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: OpenAI Pixel
|
|
3
|
-
description:
|
|
4
|
-
|
|
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
|
|
11
|
-
|
|
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/
|
|
16
|
-
| pnpm | `pnpm add @c15t/
|
|
17
|
-
| yarn | `yarn add @c15t/
|
|
18
|
-
| bun | `bun add @c15t/
|
|
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/
|
|
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
|
|
33
|
+
SDK initializer or tag-manager entry, so the vendor loads only through c15t.
|
|
34
34
|
|
|
35
|
-
The
|
|
36
|
-
|
|
37
|
-
|
|
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
|
-
|
|
59
|
-
`
|
|
60
|
-
|
|
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
|
-
|
|
65
|
-
`ConsentRoot
|
|
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
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
</ConsentRoot>
|
|
79
|
-
);
|
|
80
|
-
}
|
|
75
|
+
<ConsentRoot
|
|
76
|
+
state={consent}
|
|
77
|
+
backendURL={backendURL}
|
|
78
|
+
initRoute={false}
|
|
79
|
+
scripts={scripts}
|
|
80
|
+
>
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
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
|
-
|
|
90
|
+
Add the configuration to the existing `ConsentProvider` options, next to
|
|
91
|
+
`mode`:
|
|
92
92
|
|
|
93
|
-
```
|
|
94
|
-
import { ConsentProvider } from 'c15t/react';
|
|
93
|
+
```tsx title="src/consent.tsx"
|
|
95
94
|
import { scripts } from './consent-scripts';
|
|
96
|
-
```
|
|
97
95
|
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
```tsx
|
|
101
|
-
<ConsentProvider options={{ ...consentOptions, scripts }}>
|
|
102
|
-
{children}
|
|
103
|
-
</ConsentProvider>
|
|
96
|
+
<ConsentProvider options={{ mode, scripts }}>
|
|
104
97
|
```
|
|
105
98
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
link inside the provider. See
|
|
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
|
-
|
|
113
|
-
|
|
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
|
-
```
|
|
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
|
-
|
|
123
|
-
|
|
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
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
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
|
-
|
|
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
|
-
```
|
|
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
|
-
|
|
162
|
-
|
|
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
|
|
177
|
-
the
|
|
178
|
-
Do not
|
|
179
|
-
[Vue
|
|
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
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
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
|
-
|
|
199
|
-
|
|
200
|
-
```ts title="src/c15t.client.ts"
|
|
201
|
-
import type { C15tClientOptionsExtension } from '@c15t/astro';
|
|
150
|
+
```ts title="src/consent-client.ts"
|
|
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
|
-
|
|
208
|
-
|
|
209
|
-
|
|
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
|
|
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:
|
|
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
|
-
|
|
257
|
-
|
|
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
|
-
**
|
|
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
|
-
|
|
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
|
-
```
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
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
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
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
|
-
|
|
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
|
-
|
|
347
|
-
|
|
228
|
+
Pass the scripts to `init()` from `@c15t/browser`, next to your backend
|
|
229
|
+
URL:
|
|
348
230
|
|
|
349
231
|
```ts
|
|
350
|
-
import {
|
|
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
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
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
|
-
|
|
382
|
-
|
|
383
|
-
|
|
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
|
-
|
|
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
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
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
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
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.
|