Semantic Objects

Introduction

Semantic Objects (allong with their Attribute) allow you to track data that can add extra functionality to Fanplayr 360. For example you may track an event for product views with the Attribute Key $product which may then be shown in the list of Top 10 Products by View in Insights / Products.

Semantic Attributes can be used with any tracking call. Semantic Events may support specific Semantic Attributes, for example when using $order with the Order Completed event, Fanplayr 360 will use the details to display total Revenue in Insights.

INFO

These attributes will be pre-populated in the Data Dictionary.

Following is a list that defines the structure for these Semantic Objects, along with the attribute key and any related Semantic Attributes.

Product

Represents a product in an e-commerce store.

Products

Represents a group of Products.

• Attribute Key - $products;
• products - Product

Cart

Represents a shopping cart in a store.

• Attribute Key - $cart;
• products - Product
• location - Location;

Order

Represents a transaction in a store, such as a completed or returned order.

• Attribute Key - $order;
• products - Product
• location - Location
• billingLocation - Location
• shippingLocation - Location

Message

Represents a message that has been sent to a user through a medium such as postal mail, email, SMS, web push notification etc.

• Attribute Key - $message

• id - a unique identifier for this message that remains the same between message events such as Message Sent or Message Delivered.
• type - the type of message such as "email", "sms", "notification", "line" or "whatsapp".
• recipient - the email address, phone number, or other identifier that is used to send the message.
• subject - used for the subject of an email or similar.
• campaign - the name of the campaign used to send the message. Examples may be "Abandoned Cart" and "Summer 2022 Sale".

Location

Represents a physical location tied to an event.

• Attribute Key - $location or $billingLocation or $shippingLocation

INFO

Different attribute keys let Fanplayr 360 know a location is used for different purposes.

Search

Represents a search performed on an e-commerce website.

• Attribute Key - $search;

Recommendation

Represents a recommendation made in an e-commerce store or application.

• Attribute Key - $recommendation;
• products - Product

• id - Represents the unique identifier for the recommendation result. The same identifier should be used for recommendation events that relate to the same result. E.g. "Recommendation Viewed", "Recommendation Clicked", "Recommendation Purchased" etc.
• products - All the products that we viewed/clicked/purchased in the recommendation.
• model - The name or type of the recommendation model used.

Targeting

An object representing details related to Fanplayr Targeting.

• Attribute Key - $targeting;

Widget

An object representing an individual widget.

• Attribute Key - $widget;

UTM

An object representing details related to UTM parameters.

• Attribute Key - $utm;

Page

Details related to the page view associated with the event.

• Attribute Key - $page;

Device

Details related to the device that generated the event.

• Attribute Key - $device;

Session

An object representing a browsing session.

• Attribute Key - $session