@segment/analytics-browser-actions-google-analytics-4 1.33.0 → 1.34.0

package/src/__tests__/viewItem.test.ts

@@ -15,6 +15,9 @@ const subscriptions: Subscription[] = [
       value: {
         '@path': '$.properties.value'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       items: [
         {
           item_name: {
@@ -61,7 +64,69 @@ describe('GoogleAnalytics4Web.viewItem', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 viewItem Event', async () => {
+  test('GA4 viewItem Event when send to is false', async () => {
+    const context = new Context({
+      event: 'View Item',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        send_to: false,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+
+    await viewItemEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('view_item'),
+      expect.objectContaining({
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 viewItem Event when send to is true', async () => {
+    const context = new Context({
+      event: 'View Item',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        send_to: true,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+
+    await viewItemEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('view_item'),
+      expect.objectContaining({
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: settings.measurementID
+      })
+    )
+  })
+  test('GA4 viewItem Event when send to is undefined', async () => {
     const context = new Context({
       event: 'View Item',
       type: 'track',
@@ -86,7 +151,8 @@ describe('GoogleAnalytics4Web.viewItem', () => {
       expect.objectContaining({
         currency: 'USD',
         items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
-        value: 10
+        value: 10,
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/viewItemList.test.ts

@@ -15,6 +15,9 @@ const subscriptions: Subscription[] = [
       item_list_name: {
         '@path': '$.properties.item_list_name'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       items: [
         {
           item_name: {
@@ -61,7 +64,71 @@ describe('GoogleAnalytics4Web.viewItemList', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 viewItemList Event', async () => {
+  test('GA4 viewItemList Event when send to is false', async () => {
+    const context = new Context({
+      event: 'View Item List',
+      type: 'track',
+      properties: {
+        item_list_id: 12321,
+        item_list_name: 'Monopoly: 3rd Edition',
+        send_to: false,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+
+    await viewItemListEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('view_item_list'),
+      expect.objectContaining({
+        item_list_id: 12321,
+        item_list_name: 'Monopoly: 3rd Edition',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        send_to: 'default'
+      })
+    )
+  })
+
+  test('GA4 viewItemList Event when send to is true', async () => {
+    const context = new Context({
+      event: 'View Item List',
+      type: 'track',
+      properties: {
+        item_list_id: 12321,
+        item_list_name: 'Monopoly: 3rd Edition',
+        send_to: true,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+
+    await viewItemListEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('view_item_list'),
+      expect.objectContaining({
+        item_list_id: 12321,
+        item_list_name: 'Monopoly: 3rd Edition',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        send_to: settings.measurementID
+      })
+    )
+  })
+
+  test('GA4 viewItemList Event when send to is undefined', async () => {
     const context = new Context({
       event: 'View Item List',
       type: 'track',
@@ -86,7 +153,8 @@ describe('GoogleAnalytics4Web.viewItemList', () => {
       expect.objectContaining({
         item_list_id: 12321,
         item_list_name: 'Monopoly: 3rd Edition',
-        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }]
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/viewPromotion.test.ts

@@ -24,6 +24,9 @@ const subscriptions: Subscription[] = [
       promotion_name: {
         '@path': '$.properties.promotion_name'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       items: [
         {
           item_name: {
@@ -70,7 +73,81 @@ describe('GoogleAnalytics4Web.viewPromotion', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 viewPromotion Event', async () => {
+  test('GA4 viewPromotion Event when send to is false', async () => {
+    const context = new Context({
+      event: 'Select Promotion',
+      type: 'track',
+      properties: {
+        creative_name: 'summer_banner2',
+        creative_slot: 'featured_app_1',
+        location_id: 'ChIJIQBpAG2ahYAR_6128GcTUEo',
+        promotion_id: 'P_12345',
+        promotion_name: 'Summer Sale',
+        send_to: false,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+
+    await viewPromotionEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('view_promotion'),
+      expect.objectContaining({
+        creative_name: 'summer_banner2',
+        creative_slot: 'featured_app_1',
+        location_id: 'ChIJIQBpAG2ahYAR_6128GcTUEo',
+        promotion_id: 'P_12345',
+        promotion_name: 'Summer Sale',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 viewPromotion Event when send to is true', async () => {
+    const context = new Context({
+      event: 'Select Promotion',
+      type: 'track',
+      properties: {
+        creative_name: 'summer_banner2',
+        creative_slot: 'featured_app_1',
+        location_id: 'ChIJIQBpAG2ahYAR_6128GcTUEo',
+        promotion_id: 'P_12345',
+        promotion_name: 'Summer Sale',
+        send_to: true,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+
+    await viewPromotionEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('view_promotion'),
+      expect.objectContaining({
+        creative_name: 'summer_banner2',
+        creative_slot: 'featured_app_1',
+        location_id: 'ChIJIQBpAG2ahYAR_6128GcTUEo',
+        promotion_id: 'P_12345',
+        promotion_name: 'Summer Sale',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        send_to: settings.measurementID
+      })
+    )
+  })
+  test('GA4 viewPromotion Event when send to is undefined', async () => {
     const context = new Context({
       event: 'Select Promotion',
       type: 'track',
@@ -101,7 +178,8 @@ describe('GoogleAnalytics4Web.viewPromotion', () => {
         location_id: 'ChIJIQBpAG2ahYAR_6128GcTUEo',
         promotion_id: 'P_12345',
         promotion_name: 'Summer Sale',
-        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }]
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        send_to: 'default'
       })
     )
   })

package/src/addPaymentInfo/generated-types.ts

@@ -115,4 +115,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/addPaymentInfo/index.ts

@@ -9,7 +9,8 @@ import {
   coupon,
   payment_type,
   items_multi_products,
-  params
+  params,
+  send_to
 } from '../ga4-properties'
 
 // Change from unknown to the partner SDK types
@@ -29,9 +30,10 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       required: true
     },
     user_properties: user_properties,
-    params: params
+    params: params,
+    send_to: send_to
   },
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     gtag('event', 'add_payment_info', {
       currency: payload.currency,
       value: payload.value,
@@ -40,6 +42,7 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       items: payload.items,
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/addToCart/generated-types.ts

@@ -107,4 +107,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/addToCart/index.ts

@@ -2,7 +2,7 @@ import type { BrowserActionDefinition } from '@segment/browser-destination-runti
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
-import { user_properties, params, value, currency, items_single_products, user_id } from '../ga4-properties'
+import { user_properties, params, value, currency, items_single_products, user_id, send_to } from '../ga4-properties'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Add to Cart',
@@ -18,15 +18,17 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     },
     value: value,
     user_properties: user_properties,
-    params: params
+    params: params,
+    send_to: send_to
   },
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     gtag('event', 'add_to_cart', {
       currency: payload.currency,
       value: payload.value,
       items: payload.items,
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/addToWishlist/generated-types.ts

@@ -107,4 +107,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/addToWishlist/index.ts

@@ -2,7 +2,7 @@ import type { BrowserActionDefinition } from '@segment/browser-destination-runti
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
-import { user_properties, params, value, currency, items_single_products, user_id } from '../ga4-properties'
+import { user_properties, params, value, currency, items_single_products, user_id, send_to } from '../ga4-properties'
 
 // Change from unknown to the partner SDK types
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
@@ -20,15 +20,17 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       required: true
     },
     user_properties: user_properties,
-    params: params
+    params: params,
+    send_to: send_to
   },
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     gtag('event', 'add_to_wishlist', {
       currency: payload.currency,
       value: payload.value,
       items: payload.items,
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/beginCheckout/generated-types.ts

@@ -111,4 +111,8 @@ export interface Payload {
   user_properties?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/beginCheckout/index.ts

@@ -2,7 +2,16 @@ import type { BrowserActionDefinition } from '@segment/browser-destination-runti
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
-import { params, coupon, currency, value, items_multi_products, user_id, user_properties } from '../ga4-properties'
+import {
+  params,
+  coupon,
+  currency,
+  value,
+  items_multi_products,
+  user_id,
+  user_properties,
+  send_to
+} from '../ga4-properties'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Begin Checkout',
@@ -19,9 +28,10 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     },
     value: value,
     params: params,
-    user_properties: user_properties
+    user_properties: user_properties,
+    send_to: send_to
   },
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     gtag('event', 'begin_checkout', {
       currency: payload.currency,
       value: payload.value,
@@ -29,6 +39,7 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       items: payload.items,
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/customEvent/generated-types.ts

@@ -25,4 +25,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/customEvent/index.ts

@@ -1,7 +1,7 @@
 import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
-import { user_id, user_properties, params } from '../ga4-properties'
+import { user_id, user_properties, params, send_to } from '../ga4-properties'
 
 const normalizeEventName = (name: string, lowercase: boolean | undefined): string => {
   name = name.trim()
@@ -38,14 +38,16 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     },
     user_id: { ...user_id },
     user_properties: user_properties,
-    params: params
+    params: params,
+    send_to: send_to
   },
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     const event_name = normalizeEventName(payload.name, payload.lowercase)
 
     gtag('event', event_name, {
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/ga4-properties.ts

@@ -367,3 +367,10 @@ export const items_multi_products: InputField = {
     ]
   }
 }
+export const send_to: InputField = {
+  label: 'Send To',
+  type: 'boolean',
+  default: true,
+  description:
+    'If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag'
+}

package/src/generateLead/generated-types.ts

@@ -25,4 +25,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/generateLead/index.ts

@@ -2,7 +2,7 @@ import type { BrowserActionDefinition } from '@segment/browser-destination-runti
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
-import { user_properties, params, user_id, currency, value } from '../ga4-properties'
+import { user_properties, params, user_id, currency, value, send_to } from '../ga4-properties'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Generate Lead',
@@ -15,14 +15,16 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     currency: currency,
     value: value,
     user_properties: user_properties,
-    params: params
+    params: params,
+    send_to: send_to
   },
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     gtag('event', 'generate_lead', {
       currency: payload.currency,
       value: payload.value,
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/login/generated-types.ts

@@ -21,4 +21,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/login/index.ts

@@ -2,7 +2,7 @@ import type { BrowserActionDefinition } from '@segment/browser-destination-runti
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
-import { user_properties, params, user_id, method } from '../ga4-properties'
+import { user_properties, params, user_id, method, send_to } from '../ga4-properties'
 
 // Change from unknown to the partner SDK types
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
@@ -14,14 +14,16 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     user_id: user_id,
     method: method,
     user_properties: user_properties,
-    params: params
+    params: params,
+    send_to: send_to
   },
 
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     gtag('event', 'login', {
       method: payload.method,
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/purchase/generated-types.ts

@@ -123,4 +123,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/purchase/index.ts

@@ -11,7 +11,8 @@ import {
   tax,
   items_multi_products,
   params,
-  user_properties
+  user_properties,
+  send_to
 } from '../ga4-properties'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
@@ -32,9 +33,10 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     tax: tax,
     value: { ...value, default: { '@path': '$.properties.total' } },
     user_properties: user_properties,
-    params: params
+    params: params,
+    send_to: send_to
   },
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     gtag('event', 'purchase', {
       currency: payload.currency,
       transaction_id: payload.transaction_id,
@@ -45,6 +47,7 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       items: payload.items,
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/refund/generated-types.ts

@@ -127,4 +127,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }

package/src/refund/index.ts

@@ -13,7 +13,8 @@ import {
   items_multi_products,
   params,
   user_properties,
-  tax
+  tax,
+  send_to
 } from '../ga4-properties'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
@@ -34,9 +35,10 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       ...items_multi_products
     },
     user_properties: user_properties,
-    params: params
+    params: params,
+    send_to: send_to
   },
-  perform: (gtag, { payload }) => {
+  perform: (gtag, { payload, settings }) => {
     gtag('event', 'refund', {
       currency: payload.currency,
       transaction_id: payload.transaction_id, // Transaction ID. Required for purchases and refunds.
@@ -48,6 +50,7 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       items: payload.items,
       user_id: payload.user_id ?? undefined,
       user_properties: payload.user_properties,
+      send_to: payload.send_to == true ? settings.measurementID : 'default',
       ...payload.params
     })
   }

package/src/removeFromCart/generated-types.ts

@@ -107,4 +107,8 @@ export interface Payload {
   params?: {
     [k: string]: unknown
   }
+  /**
+   * If the send_to parameter is not set, events are routed to all Tag Ids (AW-xxx, G-xxx) set via Google Tag
+   */
+  send_to?: boolean
 }