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

package/src/__tests__/refund.test.ts

@@ -15,6 +15,9 @@ const subscriptions: Subscription[] = [
       value: {
         '@path': '$.properties.value'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       coupon: {
         '@path': '$.properties.coupon'
       },
@@ -67,7 +70,71 @@ describe('GoogleAnalytics4Web.refund', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 Refund Event', async () => {
+  test('GA4 Refund Event when send to is false', async () => {
+    const context = new Context({
+      event: 'Refund',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        transaction_id: 12321,
+        send_to: false,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await refundEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('refund'),
+      expect.objectContaining({
+        currency: 'USD',
+        transaction_id: 12321,
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 Refund Event when send to is true', async () => {
+    const context = new Context({
+      event: 'Refund',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        transaction_id: 12321,
+        send_to: true,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+    await refundEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('refund'),
+      expect.objectContaining({
+        currency: 'USD',
+        transaction_id: 12321,
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: settings.measurementID
+      })
+    )
+  })
+  test('GA4 Refund Event when send to is undefined', async () => {
     const context = new Context({
       event: 'Refund',
       type: 'track',
@@ -93,7 +160,8 @@ describe('GoogleAnalytics4Web.refund', () => {
         currency: 'USD',
         transaction_id: 12321,
         items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
-        value: 10
+        value: 10,
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/removeFromCart.test.ts

@@ -18,6 +18,9 @@ const subscriptions: Subscription[] = [
       coupon: {
         '@path': '$.properties.coupon'
       },
+      send_to: {
+        '@path': '$.properties.send_to'
+      },
       items: [
         {
           item_name: {
@@ -64,13 +67,45 @@ describe('GoogleAnalytics4Web.removeFromCart', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 removeFromCart Event', async () => {
+  test('GA4 removeFromCart Event when send to is false', async () => {
+    const context = new Context({
+      event: 'Remove from Cart',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        send_to: false,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+
+    await removeFromCartEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('remove_from_cart'),
+      expect.objectContaining({
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 removeFromCart Event when send to is true', async () => {
     const context = new Context({
       event: 'Remove from Cart',
       type: 'track',
       properties: {
         currency: 'USD',
         value: 10,
+        send_to: true,
         products: [
           {
             product_id: '12345',
@@ -89,7 +124,39 @@ describe('GoogleAnalytics4Web.removeFromCart', () => {
       expect.objectContaining({
         currency: 'USD',
         items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
-        value: 10
+        value: 10,
+        send_to: settings.measurementID
+      })
+    )
+  })
+
+  test('GA4 removeFromCart Event when send to is undefined', async () => {
+    const context = new Context({
+      event: 'Remove from Cart',
+      type: 'track',
+      properties: {
+        currency: 'USD',
+        value: 10,
+        products: [
+          {
+            product_id: '12345',
+            name: 'Monopoly: 3rd Edition',
+            currency: 'USD'
+          }
+        ]
+      }
+    })
+
+    await removeFromCartEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('remove_from_cart'),
+      expect.objectContaining({
+        currency: 'USD',
+        items: [{ currency: 'USD', item_id: '12345', item_name: 'Monopoly: 3rd Edition' }],
+        value: 10,
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/search.test.ts

@@ -11,6 +11,9 @@ const subscriptions: Subscription[] = [
     mapping: {
       search_term: {
         '@path': '$.properties.search_term'
+      },
+      send_to: {
+        '@path': '$.properties.send_to'
       }
     }
   }
@@ -39,12 +42,34 @@ describe('GoogleAnalytics4Web.search', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 search Event', async () => {
+  test('GA4 search Event when send to is false', async () => {
     const context = new Context({
       event: 'search',
       type: 'track',
       properties: {
-        search_term: 'Monopoly: 3rd Edition'
+        search_term: 'Monopoly: 3rd Edition',
+        send_to: false
+      }
+    })
+
+    await searchEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('search'),
+      expect.objectContaining({
+        search_term: 'Monopoly: 3rd Edition',
+        send_to: 'default'
+      })
+    )
+  })
+  test('GA4 search Event when send to is true', async () => {
+    const context = new Context({
+      event: 'search',
+      type: 'track',
+      properties: {
+        search_term: 'Monopoly: 3rd Edition',
+        send_to: true
       }
     })
 
@@ -54,7 +79,28 @@ describe('GoogleAnalytics4Web.search', () => {
       expect.anything(),
       expect.stringContaining('search'),
       expect.objectContaining({
+        search_term: 'Monopoly: 3rd Edition',
+        send_to: settings.measurementID
+      })
+    )
+  })
+  test('GA4 search Event when send to is undefined', async () => {
+    const context = new Context({
+      event: 'search',
+      type: 'track',
+      properties: {
         search_term: 'Monopoly: 3rd Edition'
+      }
+    })
+
+    await searchEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('search'),
+      expect.objectContaining({
+        search_term: 'Monopoly: 3rd Edition',
+        send_to: 'default'
       })
     )
   })

package/src/__tests__/selectItem.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,70 @@ describe('GoogleAnalytics4Web.selectItem', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 selectItem Event', async () => {
+  test('GA4 selectItem Event when send to is false', async () => {
+    const context = new Context({
+      event: 'Select Item',
+      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 selectItemEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('select_item'),
+      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 selectItem Event when send to is true', async () => {
+    const context = new Context({
+      event: 'Select Item',
+      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 selectItemEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('select_item'),
+      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 selectItem Event when send to is undefined', async () => {
     const context = new Context({
       event: 'Select Item',
       type: 'track',
@@ -86,7 +152,8 @@ describe('GoogleAnalytics4Web.selectItem', () => {
       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__/selectPromotion.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,82 @@ describe('GoogleAnalytics4Web.selectPromotion', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 selectPromotion Event', async () => {
+  test('GA4 selectPromotion 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 selectPromotionEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('select_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 selectPromotion 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 selectPromotionEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('select_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 selectPromotion Event when send to is undefined', async () => {
     const context = new Context({
       event: 'Select Promotion',
       type: 'track',
@@ -101,7 +179,8 @@ describe('GoogleAnalytics4Web.selectPromotion', () => {
         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/__tests__/signUp.test.ts

@@ -11,6 +11,9 @@ const subscriptions: Subscription[] = [
     mapping: {
       method: {
         '@path': '$.properties.method'
+      },
+      send_to: {
+        '@path': '$.properties.send_to'
       }
     }
   }
@@ -39,7 +42,44 @@ describe('GoogleAnalytics4Web.signUp', () => {
     await trackEventPlugin.load(Context.system(), {} as Analytics)
   })
 
-  test('GA4 signUp Event', async () => {
+  test('GA4 signUp Event when send to is false', async () => {
+    const context = new Context({
+      event: 'signUp',
+      type: 'track',
+      properties: {
+        method: 'Google',
+        send_to: false
+      }
+    })
+
+    await signUpEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('sign_up'),
+      expect.objectContaining({ method: 'Google', send_to: 'default' })
+    )
+  })
+  test('GA4 signUp Event when send to is true', async () => {
+    const context = new Context({
+      event: 'signUp',
+      type: 'track',
+      properties: {
+        method: 'Google',
+        send_to: true
+      }
+    })
+
+    await signUpEvent.track?.(context)
+
+    expect(mockGA4).toHaveBeenCalledWith(
+      expect.anything(),
+      expect.stringContaining('sign_up'),
+      expect.objectContaining({ method: 'Google', send_to: settings.measurementID })
+    )
+  })
+
+  test('GA4 signUp Event when send to is undefined', async () => {
     const context = new Context({
       event: 'signUp',
       type: 'track',
@@ -53,7 +93,7 @@ describe('GoogleAnalytics4Web.signUp', () => {
     expect(mockGA4).toHaveBeenCalledWith(
       expect.anything(),
       expect.stringContaining('sign_up'),
-      expect.objectContaining({ method: 'Google' })
+      expect.objectContaining({ method: 'Google', send_to: 'default' })
     )
   })
 })

package/src/__tests__/viewCart.test.ts

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