Skip to content

Dynamic Yield

Run Dynamic Yield personalization only after visitors allow experience, and send the choice through Active Cookie Consent.

Inth keeps the consent record of each choice, with the visitor’s country and the policy that applied.

Start for free
pnpm add @c15t/integrations
Dynamic YieldWaiting for consent
Before a choice

No request goes to Dynamic Yield, and window.DY is absent.

Turn the switch on, then off, to see what loads.

Before you start

You need an Inth project that connects to your app and c15t in that app. Copy the section ID and data center from your Dynamic Yield snippet.

Ask Dynamic Yield Support to turn on Active Cookie Consent for your section. Dynamic Yield ignores the consent API until then. Complete the c15t quickstart for your framework first.

Open the quickstart for your framework

How consent gets to Dynamic Yield

Before experience has permission, no Dynamic Yield global, preconnect, loader request or storage exists.

After permission, the c15t dynamicYield helper sets DY.userActiveConsent to accepted: true and loads api_dynamic.js. When that script finishes, it loads api_static.js.

When no registration on the page has consent, the helper sets accepted: false and removes its loaders. c15t reloads the page by default.

The scripts load after consent and in sequence. So visitors can see the original page before a campaign applies. Test your campaigns before you use the helper for experiments that run before paint.

Read the Active Cookie Consent API

Installation

Dynamic Yield has one load mode in c15t. The helper waits for experience permission.

Wait for permission. No request goes to Dynamic Yield until the visitor accepts experience. On withdrawal, consent changes to accepted: false.

dynamicYield({ sectionId })

An opt-out policy or no policy gives optional categories permission before a choice. Then Dynamic Yield loads on the first page. This guide uses an opt-in policy.

Setup steps

  1. Install the integration package

    Add the helpers next to c15t. An import alone does not start Dynamic Yield.

    pnpm add @c15t/integrations
  2. Add your section ID

    Match region to the data center of your section. recommendationContext sets the page context before either loader runs.

    src/consent-scripts.ts
    import { dynamicYield } from '@c15t/integrations/dynamic-yield';
    
    export const scripts = [
      dynamicYield({
        recommendationContext: { lng: 'en_GB', type: 'HOMEPAGE' },
        region: 'eu',
        sectionId: 'YOUR_SECTION_ID',
      }),
    ];

    An empty section ID logs an error, and Dynamic Yield does not load. Use one section and region per page.

  3. Register it with your existing setup

    Add scripts to the c15t configuration that you have now. Keep your Inth endpoint, mode, policy, styles and consent UI.

    Add scripts to c15t.config.ts, next to next.config.ts. Keep the rest of your config, such as mode, in the same call. App Router, Pages Router and static export read the same file.

    c15t.config.ts
    import { defineConsentConfig } from 'c15t/next';
    import { scripts } from './src/consent-scripts';
    
    export default defineConsentConfig({ scripts });

    Pass scripts to the ConsentRoot in your root route. Import helpers in the route module, not in a server function: script configurations carry callbacks.

    src/routes/__root.tsx
    import { scripts } from '../consent-scripts';
    
    <ConsentRoot state={consent} scripts={scripts}>

    Add scripts to the options of your ConsentProvider, next to mode. Keep the banner, dialog and preferences link inside the provider.

    src/consent.tsx
    import { scripts } from './consent-scripts';
    
    <ConsentProvider options={{ mode, scripts }}>

    Register scripts under the c15t key in app.config.ts. Keep them out of nuxt.config.ts, which reaches the browser as JSON and drops the helper callbacks.

    app/app.config.ts
    import { scripts } from '../src/consent-scripts';
    
    export default defineAppConfig({
      c15t: { scripts },
    });

    Pass scripts to the c15tVue plugin call you have now. The plugin starts one script loader when the app mounts.

    src/main.ts
    import { c15tVue, manifest } from 'c15t/vue/vue-plugin';
    import { scripts } from './consent-scripts';
    
    app.use(c15tVue, {
      mode: manifest(),
      scripts,
    });

    Add scripts to the client entrypoint, which the integration finds on its own. Keep helpers out of astro.config.mjs: its options are serialized into the page.

    src/c15t.client.ts
    import type { C15tClientOptionsExtension } from 'c15t/astro';
    import { scripts } from './consent-scripts';
    
    export default { scripts } satisfies C15tClientOptionsExtension;

    Pass scripts as a prop to the ConsentProvider you have now. The provider owns the loader and disposes it on unmount.

    src/App.svelte
    <script lang="ts">
      import { ConsentProvider, manifest } from 'c15t/svelte';
      import { scripts } from './consent-scripts';
    </script>
    
    <ConsentProvider mode={manifest()} {scripts}>
      <!-- Your app and consent UI -->
    </ConsentProvider>

    Add scripts to the ConsentRoot in the root layout. Import helpers in the layout component, not in +layout.server.ts: a server load cannot send functions to the browser.

    src/routes/+layout.svelte
    <script lang="ts">
      import { ConsentRoot } from 'c15t/svelte';
      import { scripts } from '../consent-scripts';
    
      let { children, data } = $props();
    </script>
    
    <ConsentRoot state={data.consent} {scripts}>
      {@render children()}
    </ConsentRoot>

    Paste the vendor’s snippet behind consent

    The helpers need a bundler. On a page with the c15t script tag, paste the vendor’s own snippet instead and keep it inert until visitors allow its category. Helper options, such as loadMode, do not apply.

    index.html
    <script type="text/plain" data-c15t-category="experience">
      // The vendor's snippet, unchanged
    </script>

    Pass scripts to init() from @c15t/browser, next to your mode. With createConsentRuntime, pass scripts to it instead.

    src/consent.ts
    import { init, manifest } from '@c15t/browser';
    import { scripts } from './consent-scripts';
    
    const consent = init({
      mode: manifest(),
      scripts,
    });
All frameworks

Remove each Dynamic Yield snippet, tag manager tag and preconnect. Your app updates the context on client navigation, so check consent before your own Dynamic Yield calls.

Verify your setup

Use a private window with an opt-in policy. Open DevTools Network and filter by dynamicyield.com. Then test the three states.

  • Before a choice

    No request goes to Dynamic Yield, and window.DY is absent.

  • After you allow experience

    api_dynamic.js finishes before api_static.js loads. DY.userActiveConsent.accepted is true, and window.DY holds your page context.

  • After you withdraw experience

    Save your choice. c15t reloads the page. The new page sends no request to Dynamic Yield.

The helper does not delete cookies such as _dyid or browser storage from earlier visits. Set up cleanup for your site and test it after withdrawal.

Open the full Dynamic Yield guide