|
|
| Line 1: |
Line 1: |
| | = Metadata = | | = Metadata = |
| | | | |
| − | ==Interaction Lifecycle==
| + | {{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Offers-combined#Metadata.}} |
| − | Every Offers interaction has a sequence of events we describe as the 'Interaction Lifecycle'. This is a sequence of events that tracks progress and choices from the beginning of an interaction (opening Offers), to the end (closing Offers), and every step in between.
| |
| − | | |
| − | The following events are part of the Interaction Lifecycle:
| |
| − | | |
| − | ready
| |
| − | opened
| |
| − | CTA
| |
| − | videoPlayed
| |
| − | hover
| |
| − | timeout
| |
| − | dismissed
| |
| − | closed
| |
| − | | |
| − | ==Lifecycle scenarios==
| |
| − | An Interaction Lifecycle can vary based on each user's intent and experience with Offers. Here are several sequences of events in the lifecycle that correspond to different scenarios.
| |
| − | | |
| − | The user opened Offer but changed their mind and closed it without seeing the Offer details:
| |
| − | ready -> opened -> dismissed -> closed
| |
| − | | |
| − | The user opened Offer, hovered over Offer details then closed it:
| |
| − | ready -> opened -> hover -> dismissed -> closed
| |
| − | | |
| − | The user opened Offer, and Offers timed out:
| |
| − | ready -> opened -> timeout -> closed
| |
| − | | |
| − | The user opened Offers and clicked on the link/button/image which triggers CTA:
| |
| − | ready -> opened -> CTA -> closed
| |
| − | | |
| − | The user opened Offer, watched the video then closed the Offer:
| |
| − | ready -> opened -> videoReady -> videoStarted -> videoPlayed-> dismissed -> closed
| |
| − | | |
| − | {{NoteFormat|For a list of all Offers events, see [[OffersEvents|API Events]].|2}}
| |
| − | | |
| − | == Metadata ==
| |
| − | Each event in the Interaction Lifecycle includes the following block of metadata. By default, all values are set to <tt>false</tt>. As the user progresses through the lifecycle of a Offers interaction, these values are updated.
| |
| − | | |
| − | The metadata block contains boolean state flags, timestamps, and elapsed times. These values can be used to track and identify trends or issues with interactions. During run-time, the metadata can help you offer a smart and dynamic experience to your users.
| |
| − | <br /><br />
| |
| − | === Reference ===
| |
| − | {|
| |
| − | |-
| |
| − | ! Name
| |
| − | ! Type
| |
| − | ! Description
| |
| − | |-
| |
| − | | opened
| |
| − | | integer (timestamp)
| |
| − | | Timestamp indicating when the Offer was opened.
| |
| − | |-
| |
| − | | closed
| |
| − | | integer (timestamp)
| |
| − | | Timestamp indicating when the Offer was closed.
| |
| − | |-
| |
| − | | dismissed
| |
| − | | integer (timestamp)
| |
| − | | Timestamp indicating when the user dismissed the Offer by clicking the close button.
| |
| − | |-
| |
| − | | timedOut
| |
| − | | integer (timestamp)
| |
| − | | Timestamp indicating when the Offer timed-out and closed automatically.
| |
| − | |-
| |
| − | | triggeredCTA
| |
| − | | integer (timestamp)
| |
| − | | Timestamp indicating when the CTA was triggered.
| |
| − | |-
| |
| − | | timeBeforeCTA
| |
| − | | integer (milliseconds)
| |
| − | | Total time in milliseconds from when the user opened the Offer to when the CTA is triggered.
| |
| − | |-
| |
| − | | timeFirstHover
| |
| − | | integer (timestamp)
| |
| − | | Timestamp indicating when the user first hovered over Offer.
| |
| − | |-
| |
| − | | timeBeforeHover
| |
| − | | integer (milliseconds)
| |
| − | | Total time in milliseconds from when the user opened the Offer to when the user first hovered over Offer.
| |
| − | |-
| |
| − | | timeElapsedHover
| |
| − | | integer (milliseconds)
| |
| − | | Total time in milliseconds when the user hovered over Offer.
| |
| − | |-
| |
| − | | videoPlayed
| |
| − | | integer (timestamp)
| |
| − | | Timestamp indicating when the video started playing (either automatically or through user action).
| |
| − | |-
| |
| − | | videoWatchTime
| |
| − | | integer (milliseconds)
| |
| − | | Total time in milliseconds that the video was watched before closing the Offer.
| |
| − | |-
| |
| − | | elementClicked
| |
| − | | string
| |
| − | | Name of CTA element that was clicked ('image'/'link'/'button').
| |
| − | |-
| |
| − | |}
| |
| − | <br />
| |
| | | | |
| | [[Category:V:PSAAS:Public]] | | [[Category:V:PSAAS:Public]] |
