New Marketplaces

New Marketplace Embed: Implementation, Syntax, Demo, Tags, and Best Practices

This guide covers integrating Engine's New Marketplaces Embed into your website. Also called the "generic offers" embed, it supports smaller product subverticals, including Credit Builders, Earned Wage Access, and Debt Relief.

Review the embed syntax and loading best practices. Address layout shift to optimize performance. Discuss specific implementation details with your Engine team.

This is a high-level guide, and specific implementation details should be discussed with your Engine team.

Standard Embed Implementation

Basic Embed Syntax

Engine's embed code can be placed in any order within your page, but for optimal user experience we recommend placing the script tag within the same div where the content is being rendered.

PLEASE NOTE: Your Engine representative will provide you with your specific code snippet. Do not try to reproduce from the sample snippet outlined below.

<script
  async
src="https://www.moneylion.com/network/{channel}/{zone}/web-component/{component-name}/index.js"
  data-embed-type="auto-mount"
></script>

This is a representative example of what our embed code looks like, and contains placeholders as defined below. Placeholders and will be replaced with precise values in the embed code provided to you.

Embed Components

• Channel: placeholder that will be replaced with precise values in the embed code provided to you.

• Zone: placeholder that will be replaced with precise values in the embed code provided to you.

• Component Name: corresponds to the specific product or Engine experience type that's being rendered.

• data-embed-type: enables Engine's auto-mount functionality; without this attribute, the component will not render.

  • Acceptable Value: "auto-mount"

Customization & Auto Sizing

The web component loads iFrame and will automatically fill the container. Embeds are rendered wherever you include our HTML tag on your page and will responsively scale to fill the space available to it.

New Marketplaces Specific Syntax

Component Name

• generic-offers: universal offers tile embed: it renders one or more cards from Engine’s Offer Catalog (any supported product type) using UUID + product type, and handles real-time availability, monetization rules, and fallback UX for you

New Marketplaces Embed Demo

Credit Builder Embed Demo Link: https://www.moneylion.com/network/cnbc-ml/credit-builders/iframe

Credit Builder Embed

Client Tags for Attribution

Engine Embeds support the ability to add certain tags with varying use cases, which are outlined in this section.

How to Implement Client Tags

To add client tags in an embed, use the following syntax in the data-tags attribute within the embed script:

tag.key_1=value_1&tag.key_2=value_2

Sample Implementation

"<script 
      async src=\"https://www.moneylion.dev/network/{channel}/{zone}/web-component/generic-offers/index.js\" 
      data-tags=\"tag.clientId=c1&tag.source=email\"
      data-embed-type=\"auto-mount\" 
></script>"

In the above example, clientId and source are available as tags for reporting purposes.

Supported Client Tag Keys

Client tag keys are matched exactly, including case. For example - subid and subId are stored as separate tags and will appear as separate keys in your reporting.

Please send each key with consistent casing across all requests, and use the exact spelling shown above.

Below are the client tag keys that are currently supported:

• agentId

• campaignId

• clickId

• clientId

• deviceId

• medium

• sourceId

• subId

• subId1

• subId2

• subId3

• target

• trafficsource

• userId

If a different key is needed, please reach out to your Partner Manager - we may be able to accommodate, but adding nonstandard keys will increase the time it takes Engine to report Client Tag values back to you and is therefore not recommended.

Embed Best Practices & Troubleshooting

Component Not Showing

1. Check the required attribute:

   1. Make sure data-embed-type="auto-mount" is present

2. Check browser console:

   1. Open developer tools and look for error messages

Loading Too Slowly

1. Make sure async attribute is present on the <script> tag

   1. This prevents block page load