Developer Guide
Visit our Knowledge BaseDeveloper CommunityRequest a Demo

Implementation Overview

Suggest Edits

This article describes the basic components of Dynamic Yield implementation. Most of the components have the possibility of both client-side and server-side implementation, so consult with your account manager or business team as needed to determine which is right for you.

Script or Experience API?

You can place the Dynamic Yield script on your website to collect information and render campaigns for 1-to-1 personalization, segmented behavioral targeting, testing and optimization, and more.

Or, you can use our server-side Experience API endpoints that you call from your site's code, for the same personalization and data collection capabilities our website script provides. When you receive the data, it's up to you to do what you need with it on your site.

Our recommended implementation is to use both: You always have the choice of using script-based implementations in some areas and server-side API implementations in others.

The implementation flow

The following are the basic components needed for a fully optimized implementation:

1. Create sections

A section represents your website or app in Experience OS, and is the center of all your Dynamic Yield activity. This is done in the Experience OS console, and is described in our Knowledge Base.

2. Onboard a product feed

This is your product catalog. You'll need to set up how and how often to sync it with Dynamic Yield.

Developer assistance is required for:

3. Manage page context and pageview reporting

Dynamic Yield tracks user visits on different page types to measure personalization success, calculate product recommendations, and much more.

Developer assistance is required for:

4. Render campaigns

Script-based campaigns are created and deployed entirely in the Experience OS console. Experience API campaigns are created in Experience OS, but called via the Choose endpoint.

Developer assistance is required for:

5. Track events

Events can be implemented via a short code snippet on the website, or use the Reporting Events endpoint.

Developer assistance is required for: Both implementation methods require dev assistance. See List of Standard Events for details.

6. Set cookies by the backend application (websites only)

The Dynamic Yield script stores user information in cookies and local storage to create targeted experiences on the web. Make sure to set the user cookie by the backend application serving your website on your domain, to ensure user tracking that is not affected by the browser's cookie expiration policies. If you have users from regions that require you to get permission to use cookies, you should also implement active cookie consent mode on your website.

7. Manage users

Set up your user identity and session management, and make sure your implementation follows all privacy regulations.

Developer assistance is required for:

  • If you're using the Dynamic Yield script, manage the cookies used to store user and session information.
  • If you're using Experience APIs, implement events that identify users.

Updated 9 months ago