Difference between revisions of "ATC/Current/SDK/Content offer lifecycle"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2")
 
(8 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
|DisplayName=Content offers lifecycle
 
|DisplayName=Content offers lifecycle
 
|TocName=Content offers lifecycle
 
|TocName=Content offers lifecycle
|Context=See the lifecycle of a content offer and the metrics that we capture at each state along the way. Lifecycle states are used in reporting and in determining the triggering behavior of action maps that use content offers.
+
|Context=See the lifecycle of a content offer and the metrics that we capture at each state along the way. We use lifecycle states in reporting and when determining the triggering behavior of action maps that use content offers.
 
|Dimension=WebActions
 
|Dimension=WebActions
 
|ComingSoon=No
 
|ComingSoon=No
|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
|Prereq=
 
 
|Section={{Section
 
|Section={{Section
 +
|sectionHeading=State transitions for content offers
 +
|alignment=Vertical
 +
|structuredtext=[[File:GPE content offer webaction diagram.png]]
 +
|Status=No
 +
}}{{Section
 
|sectionHeading=Content offer lifecycle states
 
|sectionHeading=Content offer lifecycle states
 
|anchor=1COInvite
 
|anchor=1COInvite
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
 
|image=
 
 
|structuredtext=[[File:COOffered1.png|left|thumb|393x393px]]
 
|structuredtext=[[File:COOffered1.png|left|thumb|393x393px]]
 
<br />
 
<br />
Line 23: Line 25:
  
  
The following table provide details about the lifecycle of a content offer, including the events that can occur and the data that is available for use with the {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|display text=Events methods}}.
+
The following table provides details about the lifecycle of a content offer, including the events that can occur and the data that is available for use with the {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|display text=Events methods}}.
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
 
{{!}}+
 
{{!}}+
Line 33: Line 35:
 
{{!}}offered
 
{{!}}offered
 
{{!}}Web Actions Offered
 
{{!}}Web Actions Offered
{{!}}The customer's activity has qualified an action map, and a proactive invitation is offered.
+
{{!}}Visitor's activity qualified an action map, and a proactive invitation is offered.
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Events|anchor=EventsWebActions|display text=Event types for web actions}}.
+
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|display text=Events methods with web actions}}.
 
{{!}}-
 
{{!}}-
 
{{!}}accepted
 
{{!}}accepted
 
{{!}}Web Actions Accepted
 
{{!}}Web Actions Accepted
{{!}}The customer accepts the invitation by clicking a button like '''Book now!''' This is a {{Link-SomewhereInThisVersion|manual=SDK|topic=Content_offer_lifecycle|anchor=Terminal|display text=terminal state}}.
+
{{!}}Visitor accepts the invitation by clicking a button like '''Book now!''' This state is a {{Link-SomewhereInThisVersion|manual=SDK|topic=Content_offer_lifecycle|anchor=Terminal|display text=terminal state}}.
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Events|anchor=EventsWebActions|display text=Event types for web actions}}.
+
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|display text=Events methods with web actions}}.
 
{{!}}-
 
{{!}}-
 
{{!}}rejected
 
{{!}}rejected
 
{{!}}Web Actions Rejected
 
{{!}}Web Actions Rejected
{{!}}The customer rejects the invitation by either clicking  '''X''' or a button like, '''No, but thank you'''. This is a {{Link-SomewhereInThisVersion|manual=SDK|topic=Content_offer_lifecycle|anchor=Terminal|display text=terminal state}}.
+
{{!}}Visitor rejects the invitation by either clicking  '''X''' or a button like, '''No, but thank you'''. This state is a {{Link-SomewhereInThisVersion|manual=SDK|topic=Content_offer_lifecycle|anchor=Terminal|display text=terminal state}}.
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Events|anchor=EventsWebActions|display text=Event types for web actions}}.
+
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|display text=Events methods with web actions}}.
 
{{!}}-
 
{{!}}-
 
{{!}}errored
 
{{!}}errored
Line 50: Line 52:
 
{{!}}An error occurred in the widget that prevented the engagement from occurring.
 
{{!}}An error occurred in the widget that prevented the engagement from occurring.
 
'''Note:''' This event does not have a corresponding metric in the Action Map Performance Report.
 
'''Note:''' This event does not have a corresponding metric in the Action Map Performance Report.
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Events|anchor=EventsWebActions|display text=Event types for web actions}}.
+
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|display text=Events methods with web actions}}.
In addition, the errorMessage field is available.
+
Also, the errorMessage field is available.
 
{{!}}-
 
{{!}}-
 
{{!}}ignored
 
{{!}}ignored
 
{{!}}Web Actions Ignored
 
{{!}}Web Actions Ignored
{{!}}The customer has ignored the invitation by navigating away from or around it. This is a {{Link-SomewhereInThisVersion|manual=SDK|topic=Content_offer_lifecycle|anchor=Terminal|display text=terminal state}}.
+
{{!}}Visitor ignored the invitation by navigating away from or around it. This state is a {{Link-SomewhereInThisVersion|manual=SDK|topic=Content_offer_lifecycle|anchor=Terminal|display text=terminal state}}.
 
'''Note:''' This event does not have a corresponding metric in the Action Map Performance Report.
 
'''Note:''' This event does not have a corresponding metric in the Action Map Performance Report.
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Events|anchor=EventsWebActions|display text=Event types for web actions}}.
+
{{!}}See {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|display text=Events methods with web actions}}.
 
<br />
 
<br />
 
{{!}}}
 
{{!}}}
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 67: Line 67:
 
|anchor=Terminal
 
|anchor=Terminal
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
+
|structuredtext=In the content offer lifecycle, certain states are considered ''terminal'', or final states. If a visitor navigates to a webpage where an action map is set to trigger a content offer, the action map doesn't offer the content offer if it is in a terminal state. This feature ensures that a visitor does not receive the same content offer after accepting the offer or indicating that they are not interested in that particular content offer.
|image=
 
|structuredtext=In the content offer lifecycle, certain states are considered ''terminal'', or final, states. If a customer navigates to a web page where an action map is set to trigger a content offer, the action map will not offer the content offer if it is already in a terminal state. This ensures that a customer does not receive the same content offer after the customer has already accepted the offer or has indicated that they are not interested in that particular content offer.
 
  
 
Terminal states for content offers are:
 
Terminal states for content offers are:
Line 78: Line 76:
  
 
For more information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Trigger}}.
 
For more information, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Trigger}}.
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 85: Line 81:
 
|anchor=ReportMetricsEvents
 
|anchor=ReportMetricsEvents
 
|alignment=Vertical
 
|alignment=Vertical
|Media=
+
|structuredtext=The metrics in the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_Map_Performance|display text=Action Map Performance report}} correlate directly with the {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=event types for web actions}}. For more information about metrics for content offers, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=MonitorContentOffers|anchor=COPerfReport|display text=Monitor a content offer's performance}}.
|image=
 
|structuredtext=The metrics used in the {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Action_Map_Performance|display text=Action Map Performance report}} correlate directly with the {{Link-SomewhereInThisVersion|manual=SDK|topic=Use_Events_methods_with_web_actions|anchor=EventsWebActions|display text=event types for web actions}}. For more information about metrics for content offers, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=MonitorContentOffers|anchor=COPerfReport|display text=Monitor a content offer's performance}}.
 
|structuredtextwide=
 
|FAQHeading=
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 09:00, October 5, 2022

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

See the lifecycle of a content offer and the metrics that we capture at each state along the way. We use lifecycle states in reporting and when determining the triggering behavior of action maps that use content offers.

State transitions for content offers

GPE content offer webaction diagram.png

Content offer lifecycle states

COOffered1.png





The following table provides details about the lifecycle of a content offer, including the events that can occur and the data that is available for use with the Events methods.

State Event Description Data available
offered Web Actions Offered Visitor's activity qualified an action map, and a proactive invitation is offered. See Events methods with web actions.
accepted Web Actions Accepted Visitor accepts the invitation by clicking a button like Book now! This state is a terminal state. See Events methods with web actions.
rejected Web Actions Rejected Visitor rejects the invitation by either clicking X or a button like, No, but thank you. This state is a terminal state. See Events methods with web actions.
errored Web Actions Errored An error occurred in the widget that prevented the engagement from occurring.

Note: This event does not have a corresponding metric in the Action Map Performance Report.

See Events methods with web actions.

Also, the errorMessage field is available.

ignored Web Actions Ignored Visitor ignored the invitation by navigating away from or around it. This state is a terminal state.

Note: This event does not have a corresponding metric in the Action Map Performance Report.

See Events methods with web actions.


Terminal states for content offers

In the content offer lifecycle, certain states are considered terminal, or final states. If a visitor navigates to a webpage where an action map is set to trigger a content offer, the action map doesn't offer the content offer if it is in a terminal state. This feature ensures that a visitor does not receive the same content offer after accepting the offer or indicating that they are not interested in that particular content offer.

Terminal states for content offers are:

  • Accepted
  • Rejected
  • Ignored

For more information, see Define an action map's triggers.

Report metrics and events

The metrics in the Action Map Performance report correlate directly with the event types for web actions. For more information about metrics for content offers, see Monitor a content offer's performance.

Comments or questions about this documentation? Contact us for support!