The value object
Every event you send to Discover must include a value object. The contents of this object depend on the type of event being sent as well as the type of widget the event originates from.
The following table lists supported attributes for the value object:
|
Name |
Type |
Description |
Value |
|---|---|---|---|
|
|
Required when sending user's fitment, geo, or browser information. Information about context. |
n/a | |
|
|
array of product objects |
Required for product events such as Array of objects containing product information. Can be an array containing a single product. |
n/a |
|
|
Required for any event that accesses user information, such as Basic user information. |
n/a | |
|
|
Required for Checkout information. |
n/a | |
|
|
string |
Optional. Can be used in widget events. Type of widget. |
|
|
|
string |
Required. ID of the widget configured in CEC. Important This must match the corresponding |
n/a |
|
|
integer |
Required if product or facet link. Position in an array of objects. Objects can be products, keyphrase suggestions, suggested categories, and so on. Indexing starts at 0. |
n/a |
|
|
string |
Required for widget events. URL of the page in which widget is placed. |
n/a |
|
|
string |
Optional. Domain. |
n/a |
|
|
Optional. Locale information. Important This locale object is deprecated. We recommend you use the page object for locale information. |
n/a | |
|
|
string |
Required for preview search widget events. Area of widget where click happened. Tip Use the |
|
|
|
string |
Required for preview search widget events. Type of suggestion link or facet type the user clicks on. Example facet types: |
Link types:
|
|
|
string |
Optional. Link or facet text that was clicked. |
n/a |
|
|
string |
Required for search widgets. Keyword user typed before clicking a link. |
n/a |
|
|
string |
Required if backend returns a modified keyword. Modified keyword returned as part of response. |
n/a |
|
|
string |
Required for clicks on HTML content or embedded action buttons. The type of link or button that is associated with a click event. |
n/a |
|
|
string |
Optional. Additional sub-type of the link or button that the user clicked. |
n/a |
|
|
string |
Required for clicks on HTML content or embedded action buttons. Label value of the link or button associated with the above click type. Example values are "Add to Cart", "Show", "Quick View", and so on. |
n/a |
|
|
string |
Optional. Normalized text ID of a label value associated with the link or button that the user clicked. |
n/a |
|
|
string |
Required if the clicked link has a URI associated with it. URI associated with a click |
n/a |