Skip to main content

Ads and pixels

TikTok Pixel

Configure the TikTok Pixel

Copy your TikTok Pixel ID. The helper adds it to the loader URL as sdkid.

npm install @c15t/integrations@alpha
src/consent-scripts.ts
import { tiktokPixel } from '@c15t/integrations/tiktok-pixel';

export const scripts = [tiktokPixel({ pixelId: 'YOUR_PIXEL_ID' })];

Register the scripts

Complete your framework quickstart first. Keep its Inth endpoint, policy, styles and consent UI. Remove the vendor's original script, SDK initializer or tag-manager entry, so the vendor loads only through c15t.

The vendor pages put the helper in src/consent-scripts.ts. If your framework quickstart already has a scripts array, such as the one in c15t.config.ts in the Next.js guide, add the helper to that array instead of creating a second file. The scripts export is a configuration, not an initializer. Add it to the c15t provider you already have, at the registration point for your framework below. These are edits to that provider, not a second provider.

Add the configuration to scripts in c15t.config.ts, next to next.config.ts:

import { defineConsentConfig } from 'c15t/next';
import { scripts } from './src/consent-scripts';

export default defineConsentConfig({ scripts });

Keep the rest of your config, such as mode and routePrefix, in the same call. ConsentRoot reads the config in the browser, so the layout keeps passing only state. App Router, Pages Router and static export all read the same file. See Next.js scripts and embeds.

Options

OptionDefaultBehavior
pixelIdRequiredPixel ID sent in the loader URL. The helper trims it. Empty or whitespace-only values log an error and the script does not load.
scriptSrchttps://analytics.tiktok.com/i18n/pixel/events.jsLoader base URL override. The helper appends ?sdkid=<pixelId>&lib=ttq. A blank value falls back to the default.

Loading and revocation

tiktokPixel uses the marketing category. Before marketing is allowed, c15t defines no ttq queue and loads nothing from TikTok. When marketing becomes allowed, the helper sets up ttq the way TikTok's base code does, queues one ttq.grantConsent() and ttq.page(), then loads events.js.

On revocation the helper keeps the pixel and calls ttq.revokeConsent(). If the visitor allows marketing again before the page reloads, it calls ttq.grantConsent().

Guard your own ttq calls

The helper sends the page view. Events your code sends through ttq.track or ttq.identify need their own check. After revocation window.ttq still exists, so its presence does not mean marketing is allowed. Check the permission first, then that the pixel is set up:

src/track-purchase.ts
export function trackPurchase(marketingAllowed: boolean, value: number) {
	if (!marketingAllowed || typeof window.ttq?.track !== 'function') return;
	window.ttq.track('CompletePayment', { currency: 'USD', value });
}

Pass the current marketing permission from your framework, for example useConsent('marketing') in React. @c15t/integrations/tiktok-pixel exports no event wrapper.

Verify the TikTok Pixel

After you allow marketing, a request to analytics.tiktok.com/i18n/pixel/events.js carries your pixel ID as sdkid, and the pixel sends one page event. Trigger one guarded event and check that its request appears. Then revoke marketing. Until the page reloads, calling trackPurchase sends nothing.

Test in a private window with an opt-in policy. Open DevTools Network, disable the cache and filter by the vendor's domain:

  1. Load the page. No request goes to the vendor before you choose.
  2. Click Reject, then reload. There is still no vendor request.
  3. Open Privacy settings and allow the helper's category. The vendor script loads without a page reload.
  4. Turn the category off again and save. c15t reloads the page, and the new page makes no vendor request.

c15t reloads on revocation because removing a script element does not stop code that already ran. The vendor's listeners, timers and queued events stay alive until the page unloads. If you set reloadOnConsentRevoked: false, stop the vendor yourself. Register a callback-only script whose onConsentChange calls the vendor's opt-out API, as shown in custom integrations, and check the permission before each of your own event calls. The reload does not delete cookies the vendor already set; see clear on revocation for your framework.

The helper sets vendor to its script ID, so once you declare that vendor a visitor can turn it off inside an allowed category. See vendor consent for your framework. The consent verification guide covers navigation, expiry and hosting checks.