Documentation:PSAAS:Administrator:OffersConfiguration:Public

Configuration

Description

Offers holds the configuration namespace '_genesys.widgets.offers' which contains UI options.

Example

window._genesys.widgets.offers = {

	offers: {

		mode: 'overlay',
		layout: 'leftText',
		title: 'Offer Title',
		headline: 'This is the offer's headline',
		body: 'This is the offer's body',
		button: 'Accept Offer',
		ctaURL: 'http://www.genesys.com',
		video: 'https://www.youtube.com/watch?v=########',
		timeout: 11000
	},

	downloadVideoLib: true
};

Options

Name	Type	Description	Accepted Values	Default	Required
offers.mode	string	Selects between overlay and toaster display modes.	'overlay', 'toaster'	toaster	false
offers.layout	string	For the 'overlay' display container, sets the text on the right or left side of the image/video.	'leftText', 'rightText'	leftText	false
offers.title	string	The title of the widget; sets the title text in the widget header.	n/a	n/a	false
offers.headline	string	A headline string displayed in larger text above the body.	n/a	n/a	false
offers.body	string	The main text body of the offer.	n/a	n/a	false
offers.button	string	A short string to be displayed inside the CTA button.	n/a	n/a	false
offers.ctaURL	string	A URL to open when the user clicks on the image or CTA button.	n/a	n/a	true
offers.image	string	A URL of an image to be displayed in the offer.	n/a	n/a	false
offers.video	string	A URL of a YouTube or Vimeo video to be displayed in the offer. If an image URL is present the image will replace the video. Warnings will be present in the JavaScript console if the video URL is not valid.	n/a	n/a	false
offers.timeout	integer	Sets a timeout, in milliseconds, after which offers widget will close if there is no interaction. The minimum value is 10 seconds(10000 ms) to prevent the offer from flashing and disapearing while the user reads it. If the value passed in is not an integer the timeout will default to 15 seconds.	positive integers	15000	false
downloadVideoLib	boolean	An option to enable loading of 3rd party video libraries. Needs to be set to true in order to show videos inside an offer. Note: this option is only available in the static config, passing this along with the open parameter will not work.	true/false	false	n/a