Add screen_view, ad_impression, campaign_details events to EventBuilder (#1861)

Author: ikuleshov

src/components/ga4/EventBuilder/ValidateEvent/schemas/eventTypes/eventDefinitions.ts

@@ -1,11 +1,13 @@
 // Event and required property mapping
 
 export const eventDefinitions = {
+    "ad_impression": [],
     "add_payment_info": ["value", "items"],
     "add_shipping_info": ["value", "items"],
     "add_to_cart": ["value", "items"],
     "add_to_wishlist": ["value", "items"],
     "begin_checkout": ["value", "items"],
+    "campaign_details": [],
     "earn_virtual_currency": [],
     "generate_lead": ["value"],
     "join_group": [],
@@ -15,6 +17,7 @@ export const eventDefinitions = {
     "purchase": ["transaction_id", "items", "value"],
     "refund": ["transaction_id", "value"],
     "remove_from_cart": ["items", "value"],
+    "screen_view": [],
     "search": ["search_term"],
     "select_content": [],
     "select_item": ["items"],

src/components/ga4/EventBuilder/event.ts

@@ -50,6 +50,19 @@ const eventFor = (
 
 const custom_event = eventFor(EventType.CustomEvent, [Category.Custom], [], [])
 
+const ad_impression = eventFor(
+    EventType.AdImpression,
+    [Category.AllApps],
+    [
+      stringParam("ad_platform", "MoPub"),
+      stringParam("ad_source", "AdColony"),
+      stringParam("ad_format", "Banner"),
+      stringParam("ad_unit_name", "Banner_03"),
+      stringParam("currency", "USD"),
+      numberParam("value", 	3.99),
+    ]
+)
+
 const add_payment_info = eventFor(
   EventType.AddPaymentInfo,
   [Category.RetailEcommerce],
@@ -159,6 +172,19 @@ const begin_checkout = eventFor(
   ]
 )
 
+const campaign_details = eventFor(
+    EventType.CampaignDetails,
+    [Category.AllApps],
+    [
+      stringParam("campaign_id", "SUMMER_FUN"),
+      stringParam("campaign", "Summer_fun"),
+      stringParam("source", "google"),
+      stringParam("medium", "cpc"),
+      stringParam("term", "summer+travel"),
+      stringParam("content", "logolink"),
+    ]
+)
+
 const earn_virtual_currency = eventFor(
   EventType.EarnVirtualCurrency,
   [Category.AllApps],
@@ -274,6 +300,15 @@ const remove_from_cart = eventFor(
   ]
 )
 
+const screen_view = eventFor(
+    EventType.ScreenView,
+    [Category.AllApps],
+    [
+      stringParam("screen_class", "MainActivity"),
+      stringParam("screen_name", "About"),
+    ]
+)
+
 const search = eventFor(
   EventType.Search,
   [Category.AllApps],
@@ -489,6 +524,8 @@ export const suggestedEventFor = (eventType: EventType): Event2 => {
     case EventType.CustomEvent:
       return custom_event
 
+    case EventType.AdImpression:
+      return ad_impression
     case EventType.AddPaymentInfo:
       return add_payment_info
     case EventType.AddShippingInfo:
@@ -499,6 +536,8 @@ export const suggestedEventFor = (eventType: EventType): Event2 => {
       return add_to_wishlist
     case EventType.BeginCheckout:
       return begin_checkout
+    case EventType.CampaignDetails:
+      return campaign_details
     case EventType.EarnVirtualCurrency:
       return earn_virtual_currency
     case EventType.GenerateLead:
@@ -517,6 +556,8 @@ export const suggestedEventFor = (eventType: EventType): Event2 => {
       return refund
     case EventType.RemoveFromCart:
       return remove_from_cart
+    case EventType.ScreenView:
+      return screen_view
     case EventType.Search:
       return search
     case EventType.SelectContent:

src/components/ga4/EventBuilder/types.ts

@@ -28,12 +28,13 @@ export enum Category {
 
 export enum EventType {
   CustomEvent = "custom_event",
-
+  AdImpression = "ad_impression",
   AddPaymentInfo = "add_payment_info",
   AddShippingInfo = "add_shipping_info",
   AddToCart = "add_to_cart",
   AddToWishlist = "add_to_wishlist",
   BeginCheckout = "begin_checkout",
+  CampaignDetails = "campaign_details",
   EarnVirtualCurrency = "earn_virtual_currency",
   GenerateLead = "generate_lead",
   JoinGroup = "join_group",
@@ -43,6 +44,7 @@ export enum EventType {
   Purchase = "purchase",
   Refund = "refund",
   RemoveFromCart = "remove_from_cart",
+  ScreenView = "screen_view",
   Search = "search",
   SelectContent = "select_content",
   SelectItem = "select_item",