Provide custom data to a placement

Custom data can be added for a specific placement. These parameters apply to a specific placement, such as a placement-level behavior. Key names are defined on the Key value pairs page.

Prerequisite

Add custom data

There are several approaches to add custom data for a placement: query parameters, HTML attributes, and jwDataStore. The following sections explain how to use each approach.

Query Parameters

Custom data is added through a query string appended to the embed URL.

&custom.abcd1234.view_type=advert

HTML Attributes

⚠️

This approach is required for the header method.

Custom data is added through data attributes added to a JWX placement <div> element.

<div 
    id="jwp-placement-1"
    data-jw-placement-id="plac1234"
    data-jw-media_id_1="medi1234"
    data-jw-playlist_id_1="play1234">
</div>

jwDataStore

Custom data is added through attributes added at the page level.

const jwDataStore = window.jwDataStore || { custom: {} };
jwDataStore.custom.abcd1234 = { view_type: "advert" };
window.jwDataStore = jwDataStore;