Documentation
Search…
Release notes

Version 4.6.0

NEW FEATURES
    Feature menuLogo : add an image in the sdk's menu page
    Feature menuLinks: add as many as links in the sdk's menu page
    Feature apmUrl : after completion of init function, the sdk can detect and launch a deeplink if founded in the url
    New template for the burns page: badge
IMPROVEMENTS
    Game init page listen now to an a tag with href=apm://game/next
    New stats on game pages (game error, game close, etc...)

Version 4.5.1

BUG FIXES
    Issue with backStack resolved
    Issue with tab selection resolved

Version 4.5.0

NEW FEATURES
    Feature "Scratch Game": new game available.
    Feature "waitForInit": if needed, the client website can decided when the SDK is initialized.
    Feature "triggerGame": public method that can trigger a game.
    Feature "swipe": Carousel element now handle swipes movement on mobile devices.
IMPROVEMENTS
    Change all CSS units from "rem" to "em".
    Tabs can be configured directly from the BO.
    Notification can be configured directly from the BO.
    Templates can be configured directly from the BO.
    Translation can be configured directly from the BO.
    TriggerAction can now launch a game an make the user win points at the same time.
    Font and icon can be configured directly from the BO.
    New template available for Mission Screen.
BUG FIXES
    Issue with backstack when user burnt a gift resolved.
    Issue on safari Mobile on games resolved.

Version 4.4.1

IMPROVEMENTS
    stop showing walkthrough Pages when app shouldn't show
    stop showing notification when app shouldn't show
BUG FIXES
    add display none on apm-sticker when data-device-status="anonymous"

Version 4.4.1

Version 4.4.0

NEW FEATURES
    add new game: labyrinth, shooting photo, rocket, shake and win, hide and seek
IMPROVEMENTS
    update client themes
    change the mechanic of lottery and form game
    make sure scripts and links are loaded in page in-app before being displayed
    interstitial and modal cannot be closed by clicking on overlay during game
    add stats to mission view for next generosities
BUG FIXES
    deeplinks on mission screen for two missions with the same tagID did not work properly
    certain transitions between modal and interstitial didn't work properly
    interstitials had incorrect displays on certain responsive screens
    pressing the back icon in the modal too quickly would prevent the user from going back to the root screen
    fix bugs for IE and Edge

Version 4.3.5

BUG FIXES
    Client theme fixes

Version 4.3.4

IMPROVEMENTS
    Connected walkthroughs can be shown directly after connection
    Game result will automatically move on to the destination as specified by the deeplink if the buttonMessage is empty.
    User properties named "cd{number}" will be sent to Google Analytics
    Hide value on free gifts, and on burns
BUG FIXES
    fixed close icon on games in interstitial mode not working
    fixed issues where the back button would disappear on non-menu screens

Version 4.3.3

BUG FIXES
    Generosities with rules did not appear on new daily_challenge screen in the nextGenerosities section

Version 4.3.2

BUG FIXES
    IE and Safari visual bug fixes.

Version 4.3.1

NEW FEATURES
    Games and pages triggered by a tag now available in loyalty mode (if tag triggers no trophy/challenge/level)
IMPROVEMENTS
    Add close icon to fullscreen notification and interstitials
BUG FIXES
    Fix responsive views
    Fix modal backstack behaviour

Version 4.3.0

NEW FEATURES
    Add apmConfig.pageLoadingPolicy to control which page to show by default
    Some of the style can be controlled by client via CSS variables (primary colors, dimensions, etc...)
    Demos have a new button regrouping all demo functionalities
IMPROVEMENTS
    Reduced size of apmConfig: moved certain (unused) keys to style
    Improve statistics (v3)
    apmApi.triggerAction are now synchrone, and reattempt if failed
    Categorize and prefix logs for clarity
    Remove JsBarcode from project, must be imported by client if needed
    3 modes for locking backgorund scroll when modal opened: none, default or css
    Pause API requests when tab is inactive
    Modal works without tabs, and without header
    apmApi.triggerAction can take property "forDataTransfer" to not be counted in stats
BUG FIXES
    Reset page versions on userProperty change

Version 4.2.4

IMPROVEMENTS
    Make multiple triggerAction synchronous
    Keep and reattempt triggerActions that failed because of network conditions
    Categorize logs for easy filtering
    Remove JsBarcode (client must import it if necessary)
    Can have multiple game tabs

Version 4.2.3

NEW FEATURES
    Add form screen that launches a game
IMPROVEMENTS
    Send stats to Google Analytics for new screens (page/get, form, game)
    Games can be launched in the modal (was only in interstitial before)
BUG FIXES
    Game's result animation is synchronized with the end of the loader's (loader would stop during fadeOut animation)

Version 4.2.2

NEW FEATURES
    Graphic resources (lottie, image) for fullscreen notifications can be specific per trophy and per level
IMPROVEMENTS
    Interstitial and modal cannot be open at the same time
BUG FIXES
    apmApi.resetLogger(...) did not reset certain methods
    Use default anonymous onboarding if none exists (lack of one would generate error logs)

Version 4.2.1

BUG FIXES
    Fix screens loading indefinitely if resource (image/icon/lottie) was not found
    Make SDK work for IE 10 and 11

Version 4.2.0

NEW FEATURES
    New "Game" mechanic (triggered by a tag or deeplink)
    triggerAction can open a specific page
    Pages can have a graphic resource (image/lottie) as a background
    A mission can have a graphic resource, including those with "rules"
    Can show interstitial pages
BUG FIXES
    Fix notif animation for Edge where the notif would display at the end of the hide animation
    Fix bug where enableLogs = false did not disable logs if logLevel key was absent
    Fix animation of sticker update
IMPROVEMENTS
    Reopen modal at same screen when reloading
    Screens now wait for images and lotties to be loaded before hiding loader

Version 4.1.4

NEW FEATURES
    Add listener "app.ready()" for when app is ready.
    Add page "tutoriel" (howitworks)
    Add page "didacticiel" on a challenge
BUG FIXES
    Remove hover effect when on mobile browser
    Previous/Next level buttons would shift position
    Challenge point bubble would get squished if challenge label was long
    The picture in the trophy's screen didn't have an adaptive ratio
    Remove borders around graphic view containers (caused by img tag)
    Only show page indicators if > 1 page
    Fix edge bug where challenge middleground was behind background
    Find workaround for lottie bug that stops on different frame when going forward or backward
IMPROVEMENTS
    Update on client themes

Version 4.1.3

BUG FIXES
    Fix bugs on Microsoft Edge:
      modal showing blank screen
      lottie animations in challenge screen not appearing
      fullscreen notifs fadeIn fadeOut animations not working
    Gifts to send showing a CTA button
    Challenges lottie animations container changing height incorrectly

Version 4.1.2

BUG FIXES
    Fix bug on Safari iOS where trophy icons didn't render properly
IMPROVEMENTS
    Update on client themes

Version 4.1.1

BUG FIXES
    Fix bug of multiple Lottie views being created on tab double click
IMPROVEMENTS
    Update on client themes
NEW FEATURES
    Notifications can be disabled by type in apmConfig (see example below)
1
apmConfig.notifications = {
2
global: {
3
template: "notif",
4
onClick: "apm://default",
5
enabled: true
6
},
7
connect: {
8
enabled: false
9
},
10
}
Copied!

Version 4.1.0

BUG FIXES
    Fix SDK for Fidelity mode after integration of Gamification mode
NEW FEATURES
    Added Google Measurement Protocol (can be disabled)
BREAKING CHANGES
Changes of keys in apmTranslations:
    Tabs: {...} and Icons.Tabs: {...} is now an array (before it contained the keys 'CHALLENGE', 'GIFTS', 'MENU')
    Before the appearance of the gamification mode, the word challenge was used for what is now a mission or generosity.
    The word challenge is now exclusively for gamification challenges and the following keys need to be changed:
      Notifs.CHALLENGE => Notifs.GENEROSITY
      Icons.Notifs.CHALLENGE => Icons.Notifs.GENEROSITY
      Challenge: {...} => Mission: {...}
      Icons.Challenge: {...} => Icons.Mission: {...}
Changes in apmConfig:
    The following keys are now deprecated:
      mediaBaseUrl
      segments
    New config keys (see example below)
      templates: specify which template to use for a given screen
      notifications: the global key affects all of them, and you can then change one type of notification specifically
        template: choose between ribbon and fullscreen template
        foregroundGraphicResourceKey: Put the key of a Lottie or Image resource from the BO to show in the fullscreen notification
        onClick: Indicate an apmDeeplink if you want to change the default behaviour
      tabs: Configure the tabs
        onClick: apmDeeplink to choose which screen is associated to the tab
1
apmConfig: {
2
templates: {
3
gifts: "gifts" | "gifts--cover",
4
gift: "gift" | "gift--cover",
5
burns: "burns" | "burns--cover",
6
burn: "burn" | "burn--cover"
7
},
8
notifications: {
9
global: {
10
template: "notif" | "notif--fullscreen",
11
foregroundGraphicResourceKey: ${resourceKey},
12
onClick: "apm://default" | ${apmDeeplink}
13
},
14
trophy | generosity | earn | gift | challenge | trophy | level: {
15
...
16
}
17
},
18
tabs: [
19
{ onClick: ${apmDeeplink}' },
20
...
21
]
22
}
Copied!

Version 4.0.2

NEW FEATURES
    Added gamification mechanic
    New fullscreen notifications

Version 3.3.10

BUG FIXES
    rules would match any filter, must now match all filters

Version 3.3.9

IMPROVEMENTS
    add current level to user
    add apmApi.getLevels()
BUG FIXES
    fix levels appearing as img instead of icons
    fix double events when hitting two elements with listeners

Version 3.3.8

IMPROVEMENTS
    apmConfig.stickerFromLevel works with images
    connect notification intercepted if connection happens right after init
    make sticker image take full width of set size (was maxed at image dimension)
BUG FIXES
    notifications cannot be clicked anymore when hidden

Version 3.3.7

BUG FIXES
    Fix gulpfile to properly erase development code

Version 3.3.6

NEW FEATURES
    New configurable gift and burn presentation (list and item): apmConfig.templates

Version 3.3.5

NEW FEATURES
    Change log behaviour to get correct file and line number

Version 3.3.4

NEW FEATURES
    override click on sticker with url redirection by using apmConfig.onClickSticker
IMPROVEMENTS
    update client themes

Version 3.3.3

NEW FEATURES
    add debug events for production debugging
    allow multiple action properties per key (profession: "doctor|pediatrist")
IMPROVEMENTS
    adjust responsive notifications placement
    add confirmation message when copying gift code to clipboard
BUG FIXES
    fix double notifications bug

Version 3.3.3-fix

BUG FIXES
    Fix migration code (properly copy user, keep stored device model, onboarding views)

Version 3.3.2

IMPROVEMENTS
    update client themes

Version 3.3.1

NEW FEATURES
    placing the class apm-client__user-balance on a tag anywhere in the page
    will automatically insert and update the user's balance
    BUG FIXES
    fix migration task to v3.3.0 which created an empty user if none before

Version 3.3.0

NEW FEATURES
    implement navigation through suggested challenges
    add public deeplinks for all screens (also useable in onboarding clicks)
    IMPROVEMENTS
    set SDK as offline if no localStorage to block certain bots
    apmApi.logOut() now tells server to erase user token to prevent backend actions from working
    prevent unnecessary API call after user connection
    migration to app's miles API 4.0
    BUG FIXES
    fix release gulp task (version number was between min.3.2.5.js)

Version 3.2.5

BUG FIXES
    Fix apmApi.createUserWithActions so that it accepts properties
    Fix bug where SDK is initialized twice, and launches a getprog when there's a user

Version 3.2.4

BUG FIXES
    update client themes

Version 3.2.3

BUG FIXES
    update client themes

Version 3.2.2

BUG FIXES
    userBalance got hidden, now visible again

Version 3.2.1

BUG FIXES
    apmApi.open() was not opening the modal, now it does

Version 3.2.0

NEW FEATURES
    Filters: the filter functionality allows both to:
      enable actions only for certain users (using userProperties)
      create variations of an action (using properties), example:
        Generic action = Write a review on a business (+50 points)
        Action with 1 filter = Write a review on a restaurant (+60 points)
        Action with 2 filters = Write a review on a restaurant in Paris (+70 points)
IMPROVEMENTS
    Global variable window.apmTranslations is now checked everytime a screen is loaded
      So if the file apm-translations.js is for some reason loaded after the SDK's execution, the SDK will close the modal, refresh the translations and open the modal again.

Version 3.1.3

IMPROVEMENTS
    apmApi.getUser() now always returns at least deviceStatus and connectionStatus.
BUG FIXES
    \ css fix
    only show gift notification if user has enough points for it

Version 3.1.2

NEW FEATURES
    add control population management (témoin):
      connected and non-connected users designated as "control population" by the server will not see the SDK
      they will still earn points
IMPROVEMENTS
    add encryption to web storage
    a user who opted out will now not see the SDK when they connect to their account on another browser/device
    triggerAction, userClientConnect and createUserWithActions now return a promise
    apmConfig.enableLogs can now be triggered at any point (was only taken account at initialization before)
BUG FIXES
    fix Internet Explorer bugs
    fix bugs when viewing SDK on two tabs simultaneously

Version 3.1.1

NEW FEATURES
    add public method apmApi.createUserWithActions(...) to reward multiple actions to a user and create his/her account if needed (more info in documentation)
    add visual loader on dynamic pages
    users can now close the modal (when open) by pressing 'escape'
IMPROVEMENTS
    updated the documentation to explain how to use dynamic tags with apmApi.triggerAction(...)
BUG FIXES
    fix JS and CSS for Internet Explorer 10
    fix bad appearance of 'later button' in onboarding
    fix logs appearance in prod (managed in apmConfig)
    fix bad notification priority
Last modified 7mo ago