Firebase for Mobile Apps: Event Reference for Shopgate Apps

The following Firebase events are being supported by your Shopgate integration:

If you are unsure whether you currently use Shopgate Engage or Shopgate Go for your mobile app, please contact Shopgate support.

Firebase Event Name	Description	Shopgate Go App	Shopgate Engage App
ADD_PAYMENT_INFO	Add Payment Info event.	Credit card only	Yes
ADD_TO_CART	E-Commerce Add To Cart event.	Yes	Yes
ADD_TO_WISHLIST	E-Commerce Add To Wishlist event.	Yes	No
APP_OPEN	App Open event.	Yes	Yes
BEGIN_CHECKOUT	E-Commerce Begin Checkout event.	Yes	Yes
CAMPAIGN_DETAILS	Log this event to supply the referral details of a re-engagement campaign. In Shopgate context, this logs opening your App by tapping on a push message and opening your App from a deeplink with utm parameters. Purchases will be attributed to those events in Google Analytics.	Yes	Yes
CHECKOUT_PROGRESS	Checkout progress.	No	No
EARN_VIRTUAL_CURRENCY	Earn Virtual Currency event.	No	No
ECOMMERCE_PURCHASE	E-Commerce Purchase event.	Yes	Yes
GENERATE_LEAD	Generate Lead event.	No	No
JOIN_GROUP	Join Group event.	No	No
LEVEL_END	Level End event.	No	No
LEVEL_START	Level Start event.	No	No
LEVEL_UP	Level Up event.	No	No
LOGIN	Login event.	Yes	Yes
POST_SCORE	Post Score event.	No	No
PRESENT_OFFER	Present Offer event.	No	No
PURCHASE_REFUND	E-Commerce Purchase Refund event.	No	No
REMOVE_FROM_CART	Remove from cart event.	No	No
SEARCH	Search event.	Yes	Yes
SELECT_CONTENT	Select Content event.	No	No
SET_CHECKOUT_OPTION	Set checkout option.	No	No
SHARE	Share event.	Yes	No
SIGN_UP	Sign Up event.	Yes	Yes
SPEND_VIRTUAL_CURRENCY	Spend Virtual Currency event.	No	No
TUTORIAL_BEGIN	Tutorial Begin event.	No	No
TUTORIAL_COMPLETE	Tutorial End event.	No	No
UNLOCK_ACHIEVEMENT	Unlock Achievement event.	No	No
VIEW_ITEM	View Item event.	Yes	Yes
VIEW_ITEM_LIST	View Item List event.	No	No
VIEW_SEARCH_RESULTS	View Search Results event.	No	No

Custom Shopgate Events:

Firebase Event Name	Description	Shopgate Go App	Shopgate Engage App
sg_view_page	Sent on every page view of a user. Replaces the Firebase event "screen_view", which cannot be used in hybrid apps like the Shopgate App.	Yes	Yes
sg_like	Can be used in a social network integration to track “likes”.	No	No
sg_invite	Can be used in a social network integration to track invites.	No	No
sg_custom_values	This allows integrations to track custom dimensions and metrics in Google Analytics Universal Analytics Properties via Google Tag Manager.	Yes	Yes

Custom Shopgate Parameter:

Firebase Parameter Name	Description	Events
sg_item_type	Type of item. Currently always "Product".	ADD_TO_WISHLIST ADD_TO_CART VIEW_ITEM ECOMMERCE_PURCHASE
sg_item_category_id	The ID of the item’s category	ADD_TO_WISHLIST ADD_TO_CART VIEW_ITEM
sg_page_id	The ID of the current page. For product detail pages, the product ID, for category pages, the category ID.	sg_view_page
sg_page_type	The nature of the current page. Allow grouping for cms item category cart checkout wishlist login	sg_view_page
sg_page_name	The title of the current page. Product name, category name, CMS title.	sg_view_page
sg_checkout_type	Web or app checkout	ECOMMERCE_PURCHASE BEGIN_CHECKOUT
sg_purchase_success	Optional parameter to mark successful transactions.	ECOMMERCE_PURCHASE
sg_items_count	Number of items with which a checkout is started.	BEGIN_CHECKOUT
sg_payment_info_available	Indicates whether billing information already existed when the checkout started.	BEGIN_CHECKOUT
sg_add_payment_info_success	Indicates whether adding a payment method was successful.	ADD_PAYMENT_INFO
sg_name	Name of the respective method.	ADD_PAYMENT_INFO SHARE sg_like sg_invite
sg_action	Custom Event Action
sg_label	Custom Event label
sg_type	Custom Event type	sg_like sg_invite
sg_id	Custom Event ID	sg_like sg_invite