Deploy a Product Recommendations for Email Experience

Follow these steps to create a Product Recommendations for Email experience.

  1. Click EXPERIENCES in the top navigation bar, and then select Web.

    Callout of the Web option in the EXPERIENCES top navigation menu

  2. Click the drop-down arrow to the right of CREATE EXPERIENCE, and then select Product Recommendations for Email.

    Callout of the 'Product Recommendations for Email' option in the menu available from the 'CREATE EXPERIENCE' button

  3. Click the pencil icon, enter a name for the experience, and then click the green checkmark icon to save the name.

    Animated demonstration of a user clicking the pencil icon beside the experience name field, typing a name, and then clicking the green checkmark icon

  4. Click WHAT and then click ADD ACTION.

    Callout of the WHAT settings and the ADD ACTION button

  5. Click Product Recommendations for Email on the Action Type panel.

    Callout of the 'Product Recommendations for Email' option on the Action Type panel

  6. Click the action template that you want to use.

    Example of the action templates available on the 'Product Recommendations for Email' panel

  7. Configure the required recommendations-related inputs for the action.
    1. Select up to four recommendation strategies to populate the recommendations.

      Callout of the four Recommendation Strategy selectors on the 'Product Recommendations for Email (with slotting)' action template

    2. Set the number of times the action displays recommendations from one strategy before displaying recommendations from the next strategy. For example, an action using recommendation strategies A, B, and C with a set sequence of 2 would pull from result in recommendations pulled in the following order: A, A, B, B, C, C, A, A….

      Callout of the 'Recommendation strategy sequence' field on the 'Product Recommendations for Email (with slotting)' action template

    3. Enter into Minimum products returned the minimum number of recommended products that the product recommendation sources must identify for the action to fire.

      Setting the minimum to zero causes the action to fire in all scenarios, even when no products are recommended. This situation can also result in customers being counted in the experience without seeing recommendations.

      If in step 7a you selected any recommendation strategy with Prepend context item in recommendation enabled, then the context item counts toward meeting the threshold you set in Minimum products returned.

      Callout of the 'Minimum products returned' field on the 'Product Recommendations for Email (with slotting)' action template

    4. Set the maximum number of products the action can recommend.

      If in step 7a you selected any recommendation strategy with Prepend context item in recommendation enabled, then the context item counts toward meeting the threshold you set in Maximum products returned.

      Callout of the 'Maximum products returned' field on the 'Product Recommendations for Email (with slotting)' action template

    5. Optionally, enter into Pinned products the value of the id attribute for each product that you want to always appear at the beginning of the recommendations results.

      If you enter product IDs into Pinned products and if in step 7a you selected one or more recommendation strategies with Prepend context item in recommendation enabled, then the products identified at the action level appear before the context product in the recommendations results.

      Callout of the 'Pinned products' field on the 'Product Recommendations for Email (with slotting)' action template

    6. Optionally, select a product catalog attribute on which duplicate recommended products are removed from the results.

      Ensure that the attribute that you select appears in the product catalogs used in the primary and fallback recommendations sources.

      Callout of the 'Remove duplicate products based on' selector on the 'Product Recommendations for Email (with slotting)' action template

  8. Optionally, select up to five backup recommendation strategies that you want used to supplement the strategies that you selected in step 7a if they can't display enough recommended products to meet the minimum that you set in step 7c.
    1. Click ADD FALLBACK.

      Callout of the ADD FALLBACK button on the 'Product Recommendations for Email (with slotting)' action template

    2. Select a strategy.

      Callout of the recommendation strategy selector for Fallback Strategy 1 on the 'Product Recommendations for Email (with slotting)' action template

    3. Repeat steps 8a and 8b to add as many fallback recommendation strategies as necessary or until you reach the five strategy limit.
  9. As necessary, modify the HTML code for the recommendation item template.

    The Recommendation Item template HTML editor on the 'Product Recommendations for Email (with slotting)' action template

  10. As necessary, adjust the size of the image container.

    Callout of the Width field and Height field on the 'Product Recommendations for Email (with slotting)' action template

  11. Click CREATE.
  12. Click GENERATE EMAIL HTML.

    Callout of the 'GENERATE EMAIL HTML' button

  13. Click COPY TO CLIPBOARD.

    Callout of the 'COPY TO CLIPBOARD' button in the 'Generate Email HTML' modal

  14. Paste the HTML into your ESP email template, and then replace the $customer_id placeholder and, as necessary, the placeholders for any run-time parameters in the generated HTML, with their respective values. See Preparing the Generated HTML for guidance.

    Callouts of the customer_id value placeholder that must be replaced in the generated HTML code

Unlike Web experiences, a Product Recommendations for Email experience requires no activation because you send it to customers using your ESP.

Previewing the Email Experience

Follow these steps to preview a Product Recommendations for Email experience complete with the context of a customer ID.

  1. Click PREVIEW on the Experience Editor page.

    Callout of the PREVIEW button on the Experience Editor page

  2. Enter a customer ID value in the Preview modal.

    This identifier is equivalent to the one used by your ESP to identify users. If you enter a valid customer ID, then the preview represents the experience seen by that customer. If you enter an invalid or imaginary customer ID, then the preview appears as if it would for an email recipient with no history.

    Callout of the 'Customer ID' field on the Preview modal

If the preview appears blank, a likely culprit is a syntax error in the template. Another possibility is a lack of returned recommended items due to either an empty catalog or the configurations of the recommendation strategies selected in the WHAT action.

Preparing the Generated HTML

You must make a few modifications to the HTML code that appears in the Generate Email HTML modal before you can use it.

Modifying the link URL or the image URL beyond the ways described in this section can cause the experience to fail.

Customer ID

In each image URL and link URL, you must replace the $customer_id placeholder with your ESP's customer identifier. Often you can replace $customer_id with a subscriber merge token that dynamically resolves to the ESP identifier.

The ESP's customer identifier must be sent to the Monetate platform as part of the Web Track process or some equivalent means.

Callouts of the customer_id value placeholder in each link URL and image URL in the generated HTML code for a three-slot Product Recommendations for Email experience

Depending on the configuration of the recommendation strategies that you selected when creating the experience's action, the generated HTML may contain one or more pass-through parameter–value placeholder pairs. Ensure that you also replace each value placeholder with its respective attribute value(s) that you want to use in the experience.

Item Group ID Run-Time Parameter

If one of the recommendation strategies is configured with Item group ID(s) in run-time parameter (for email) selected for Base Recommendation on, then pt_based_on_item_group_id=$runTimeFilter appears in the generated HTML code for the email.

Callouts of the pass-through parameter for item group IDs and the parameter's value placeholder in the generated HTML code for a three-slot Product Recommendations for Email experience

You must replace the $runTimeFilter placeholder with at least one and no more than five item_group_id values that you pass to Monetate.

The item_group_id value(s) that you use must be in the product catalog associated with each recommendation strategy that is configured with the Item group ID(s) in run-time parameter (for email) setting that you selected when configuring the experience's action. This requirement applies to the recommendation strategies you selected for recommendation strategies A through D in the action template as well as for the optional fallback recommendation strategies. Otherwise, no results will be returned.

If you use multiple values, ensure they're in a properly formed string with each comma replaced with %2C.

Callout of the pass-through parameter for an item group ID parameter with three values in the generated HTML code for a three-slot Product Recommendations for Email experience

Recommendation Run-Time Filters

If you selected one or more recommendation strategies configured with one or more run-time filters, then you must replace the placeholder for each run-time filter parameter (for example, pt_brand=$runTimeFilter) with a value for that attribute that you pass to Monetate.

Callout of each occurence of the $runTimeFilter placeholder in the email experience HTML code

You cannot use multiple attribute values with a recommendation run-time filter.

Other Query String Parameters

You can configure a Product Recommendations for Email experience so that you can track page visits and product purchases that result from it by adding a query string parameter for tracking purposes to the generated HTML.

Add the query string parameter at the end of each image URL and link URL in the generated HTML.

Callout of each occurence of a series of campaign-identifying query string parameters in the generated email experience HTML

When the email recipient clicks a link in the message, they're redirected to its corresponding page on your site as expected, with the query string parameter that you'd added preserved.

Table of Contents