In custom code campaigns, you create custom JavaScript code to add or manipulate any element on your page or app. You can change, move, swap, or otherwise maneuver any element with almost no limitations.
Create a custom code campaign
- Go to Web Personalization › New Campaign and click Custom Code.
- Specify the campaign settings, such as trigger, frequency, and advanced settings.
- Configure the targeting settings of the experience to determine when, where, and to whom the experience is displayed.
Important: If targeting conditions are not set, the campaign will execute on every page of your website.
- Create variations using templates, based on other experiences, or using a data feed. When you are done with each variation, click Save Variation.
- Set the allocation, primary metric, and advanced experience settings.
- Configure the traffic allocation of each variation and the control group.
- Click Save Experience.
- Click the + icon to create an additional targeted experience.
- Click Preview to see how your campaign will appear, and click Save and Publish when you are ready to go live.
Custom code campaign settings
- Page Load: Execute the code immediately upon page-load of the relevant pages (that you set in the targeting step for each variation).
- Time on Page: Execute the code only after a defined amount of time has passed since the page loaded.
- Exit Intent: Execute the code when a visitor exhibits exit intent by moving the mouse cursor outside the webpage area (desktop only).
- Event: Execute the code when a specific event is fired on the page.
- Advanced: Set multiple selections or combinations of triggers, using those described in this list or the following:
- Element click: Execute the code when a visitor clicks a specific element on the page, defined using a CSS selector.
- Element mouseover: Execute the code when a visitor hovers over a specific element on the page, defined using a CSS selector.
- Element load: Execute the code when a specific element loads on the page, defined using a CSS selector.
- External component: Execute the code when an external component, such as a jQuery, loads.
Frequency
- Once per pageview: Visitors see the campaign every time they meet the targeting conditions, upon every pageload.
- Once per session: Visitors see the campaign when they first meet the targeting conditions, and then no longer see it for the remainder of their session.
- Once per day/week/month: Visitors see the campaign when they meet the targeting conditions, and then no longer see it for the remainder of the day, week, or month, depending on the timeframe selection.
- Once per user: Visitors see the campaign only once, when they first meet the targeting conditions.
Note: The frequency settings are applied at the experience level, so if you select Once per user for a campaign that has two targeted experiences – one targeted to new visitors and the other to returning visitors – the user will receive the corresponding experience once as a new user, and then upon returning to the site and meeting the returning visitor condition.
Advanced settings
- Fire a Google Analytics event (legacy): Only visible if the Google Analytics integration is enabled. You can disable this option to prevent reporting data about a specific recommendation to Google Analytics.
- Track campaign performance in your analytics platform: Fires events for any analytics extensions and custom code you have implemented. If you disable this option, it won't fire events to any of your analytics implementations.
- Serve on Every SPA Event: Relevant for single-page applications that don’t generate a browser refresh with every screen change. If you need the recommendation to relaunch or reevaluate its targeting conditions upon every screen change in your SPA, fire a track_pageview event and enable this option. For more information on working with SPAs, see Dynamic Yield for Single-Page Applications.
Debugging custom code campaigns
Open your browser’s developer tools and append the campaign’s ID (or multiple IDs for multiple campaigns, separated by commas) to the following URL: https://www.dynamicyield.com/?dy_debugger=11111
Extracting a campaign ID from the URL
The object ID can be extracted from the URL of every custom code, messaging, or dynamic content campaign.
Extracting campaign ID from the campaign list page
You can add the campaign ID to your campaign list page by clicking the Columns dropdown and selecting ID.
Use case: Split tests
Split or redirect tests are used to compare different URLs as a variation. For example, when testing a new homepage layout, you can redirect half of your users to an alternate design. You can use custom code campaigns to perform split tests. For details, see Performing Split Tests.