Marketing Cloud Personalization Web Integration
The Salesforce Interactions SDK is an extensible data capture and collection framework that you can use to track website visitors’ profile data and different user interactions on your website and send that information to Salesforce. The SDK consists of a base SDK and product-specific modules for Marketing Cloud Personalization and Salesforce Data Cloud (formerly Customer Data Platform).
The SDK leverages a unified event data model shared across the Personalization and Data Cloud SDK modules. This unified data model allows for capturing and integrating key business objects and user and behavioral data through event capture in a consistent format across Personalization and Data Cloud. The unified data model also enables you to use a single SDK to integrate with either Personalization, Data Cloud, or both together.
The following table describes the SDK modules to use depending on your use of Personalization and Data Cloud.
|Products Used||Use||SDK Namespace|
|New customers using Personalization only||Personalization module of the Salesforce Interactions SDK|
|Existing customers that have completed their Personalization implementation or have an implementation in progress||Personalization module of the Salesforce Interactions SDK|
|Personalization and Data Cloud||Personalization module of the Salesforce Interactions SDK|
|Data Cloud only||Data Cloud module of the Salesforce Interactions SDK|
- If you’re an existing customer who has completed their Personalization implementation or have an implementation in progress, you can continue to leverage the
Evergagenamespace in your Sitemap and Web and Server-side Campaign Template code.
- We've provided sample code for both SDK namespaces wherever applicable. When copying sample code from articles, ensure that you copy code meant only for the SDK namespace you're using.
To know more about the web integration process and considerations for development planning, see Plan a Web Integration.
The Personalization module of the Salesforce Interactions SDK provides the following features.
- Identity and cookie management for anonymous and named identity tracking
- The Personalization Sitemap for data collection and consent management
- Gears extensions to augment Personalization platform capabilities
- Gears extensions for rendering web campaigns
The following sections introduce each of the preceding features of the Personalization module of the Salesforce Interactions SDK.
The Personalization module of the Salesforce Interactions SDK supports anonymous and named identity tracking using Personalization first-party cookies or by being passed identity information by the website. This system supports the client portion of the Personalization identity system by optionally updating client identity with an encrypted nonce for the primary identity to support merging profile identities across different devices and channels. For comprehensive information on how to specify user identities in Personalization, see User Identity Mapping.
Personalization First-Party Cookies
The Personalization module of the Salesforce Interactions SDK sets the following two cookies.
- A cookie prefixed with
_evga_that stores Personalization Identities such as the
anonymousIdor any persisted ID.
- A cookie prefixed with
_sfid_that stores any consents and their status provided to the Web SDK.
Both cookies end with a string of characters unique to the dataset to which the cookie belongs. These cookies can be cleared for consent management purposes when a user doesn’t consent to cookie tracking. The cookies default to having the secure attribute set, but can be overridden at the dataset level under Settings > General Setup > Advanced Options > Web SDK Cookie Secure Attribute.
The Personalization Sitemap system is a configuration-driven integration layer that executes within and is deployed by the Salesforce Interactions SDK. A Sitemap is developed using APIs provided by the Web SDK. A Sitemap integrates key business objects of a website into the Personalization system through event capture. Key business objects are customizable and include, but aren’t limited to, page type information and catalog items, which both support a deep understanding of user affinities within Personalization. Examples of catalog items include products, article content, categories, and other catalog objects. For more information about the Personalization Sitemap and Data Model, see the Sitemap and Data Model documentation.
The Salesforce Interactions SDK includes functions for resolving and storing consent. The Personalization module of the Salesforce Interactions SDK tracks a user if supplied with either no consent value or any value other than an
OptOut consent with the purpose of
Personalization. When the Personalization module sees an
OptOut consent with the purpose of
Personalization, it doesn’t send events to the user until their consent status changes. The
OptOut consent with the purpose of
Personalization is the only consent that causes a behavior change in the Personalization module. While the module can receive and store other consents, they don’t affect collecting or tracking data.
The SDK stores the most recent consent for a purpose in the
_sfid cookie along with the
lastSentTime for the consent.
Providing user consent to the SDK can happen either during initialization or by using the
The Consent Object
consent defines a consent object that accepts the following fields.
ConsentWithMetadata object has the following shape.
You can use the following methods to update the
Returns consent data with the last updated and sent times.
updateConsents = (consents: Consent | Consent): void
Accepts an array of consent objects or a single consent object. This method updates the consent used by the Personalization module of the Web SDK allowing updating consent after initialization.
The Personalization module of the Salesforce Interactions SDK provides the following helpers for setting consent purpose and consent status.
Consent Management Through the Sitemap
Not all your website's visitors and/or users consent to cookie tracking. To support consent management, the Personalization module of the Salesforce Interactions SDK has been designed to not track activity if a Consent with the Status of
OptOut and the Purpose of
Personalization has been provided.
During initialization, the Personalization module of the Salesforce Interactions SDK can accept a
consents field in the configuration. The
consents field can accept either an array of Consents or a Promise that resolves an array of Consents. When the
consents field is provided during initialization, any resolved consents are used by the Personalization module of the Salesforce Interactions SDK.
The following are examples of providing user consent on initialization.
Updating Consent Using the updateConsents Method
The Personalization module of the Salesforce Interactions SDK also provides functionality to update consents through the
updateConsents method. The
updateConsents method can be called at any time with updated consent for the user.
updateConsents method is called, if a Consent is sent with the status of
OptOut, the Personalization module of the Salesforce Interactions SDK sends an event to Personalization with the updated consents. If a Consent with the Purpose of
Personalization is updated to
OptOut, the Personalization module of the Salesforce Interactions SDK stops sending events.
The following are examples of calling the
Providing Default OptOut Personalization Consent
Since the Personalization module of the Salesforce Interactions SDK doesn’t track users that have provided an
OptOut Personalization consent, we recommend providing an
OptOut Personalization consent by default until a user has Opted in. The following are examples of providing an
OptOut Personalization consent on initialization.
OptOut Personalization consent is provided for a user, no events are tracked. In the preceding example, an
OptOut Personalization Consent is provided with initialization on every page. If you wish to have the Sitemap execute for a user, you must resolve and set the user's actual consent before initializing the Sitemap.
Removing Personalization Cookies
The Personalization module of the Salesforce Interactions SDK provides the following helper functions to remove Personalization cookies. You can use this helper function to remove Personalization cookies in scenarios where a user no longer consents to or explicitly requests to cease cookie tracking, or when you wish to remove cookies after a user logs out of your website.
By default, if the
domain isn’t specified, this helper function tries to remove cookies based on the domain configured in the
SalesforceInteractions.init() function in the
SalesforceInteractions SDK namespace and the
Evergage.init() function in the
domain in the helper function or as part of the detail on the
Gear development is managed by Personalization. You can file Gear development requests as feature requests on the Salesforce IdeaExchange portal for review by the Personalization Product team members.
You can also use Gears extensions in configured web templates to deliver campaign and personalization content directly to website code so that the website can render it. Personalization includes a built-in Handlebars Gear that supports rendering dynamic content into HTML and CSS styles using the Handlebars template language.