Widget

The Pleasepoint widget is a WebComponent that can be embedded into your website to display recommendations.

It can be inserted using HTML or JavaScript. Attributes in HTML are kebab-case, while in JavaScript are camelCase.

This is the basic structure of the widget, please refer to the specific widget documentation for more details:

<pleasepoint-recommendation
        account-id="my_account_id"
        num-recommendations="4"
        cols="2"
        show-slider <!-- optional, default false -->
        <!-- engine-specific attributes -->
        business-rule=""
        business-rule-params='{"param1": ["value1", "value2"]}' <!-- optional -->
        user-reference-id="" <!-- OR --> email=""
        session-id="" <!--optional, see note -->
        event-source-page="" <!-- optional -->
        event-source-block="" <!-- optional -->
></pleasepoint-recommendation>

const widget = pleasepointWidget.create('recommendation', {
    accountId: 'my_account_id',
    numRecommendations: 4,
    cols: 2,
    showSlider: true, // optional, default false
    // engine-specific attributes
    businessRule: '',
    businessRuleParams: {"param1": ["value1", "value2"]}, // optional
    userReferenceId: '', /* OR */ email: '',
    sessionId: '', // optional, see note
    eventSourcePage: '', // optional
    eventSourceBlock: '', // optional
});

// widget is a regular HTML element, insert it into the page as usual
// for example:
document.body.appendChild(widget);

sessionId parameter is optional, if it is not provided, the SDK will autogenerate it and save it in the cookie pleasepoint_session_id for 7 days.

Table of contents