@segment/analytics-browser-actions-google-analytics-4 1.29.0 → 1.30.0

package/src/addToWishlist/index.ts

@@ -3,7 +3,6 @@ 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 { updateUser } from '../ga4-functions'
 
 // Change from unknown to the partner SDK types
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
@@ -24,12 +23,12 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     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,
       ...payload.params
     })
   }

package/src/beginCheckout/generated-types.ts

@@ -93,6 +93,7 @@ export interface Payload {
      * Item quantity.
      */
     quantity?: number
+    [k: string]: unknown
   }[]
   /**
    * The monetary value of the event.

package/src/beginCheckout/index.ts

@@ -3,7 +3,6 @@ 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 { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Begin Checkout',
@@ -23,13 +22,13 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     user_properties: user_properties
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'begin_checkout', {
       currency: payload.currency,
       value: payload.value,
       coupon: payload.coupon,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/customEvent/index.ts

@@ -2,7 +2,6 @@ import type { BrowserActionDefinition } from '@segment/browser-destination-runti
 import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 import { user_id, user_properties, params } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const normalizeEventName = (name: string, lowercase: boolean | undefined): string => {
   name = name.trim()
@@ -42,10 +41,13 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
     const event_name = normalizeEventName(payload.name, payload.lowercase)
 
-    gtag('event', event_name, payload.params)
+    gtag('event', event_name, {
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
+      ...payload.params
+    })
   }
 }
 

package/src/ga4-properties.ts

@@ -190,6 +190,7 @@ export const minimal_items: InputField = {
   description: 'The list of products purchased.',
   type: 'object',
   multiple: true,
+  additionalProperties: true,
   properties: {
     item_id: {
       label: 'Product ID',

package/src/generateLead/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
 import { user_properties, params, user_id, currency, value } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Generate Lead',
@@ -19,11 +18,11 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'generate_lead', {
       currency: payload.currency,
       value: payload.value,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/login/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
 import { user_properties, params, user_id, method } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 // Change from unknown to the partner SDK types
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
@@ -19,10 +18,10 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
   },
 
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'login', {
       method: payload.method,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/purchase/generated-types.ts

@@ -93,6 +93,7 @@ export interface Payload {
      * Item quantity.
      */
     quantity?: number
+    [k: string]: unknown
   }[]
   /**
    * The unique identifier of a transaction.

package/src/purchase/index.ts

@@ -13,7 +13,6 @@ import {
   params,
   user_properties
 } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Purchase',
@@ -36,8 +35,6 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'purchase', {
       currency: payload.currency,
       transaction_id: payload.transaction_id,
@@ -46,6 +43,8 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       tax: payload.tax,
       shipping: payload.shipping,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/refund/generated-types.ts

@@ -113,6 +113,7 @@ export interface Payload {
      * Item quantity.
      */
     quantity?: number
+    [k: string]: unknown
   }[]
   /**
    * The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties.

package/src/refund/index.ts

@@ -15,7 +15,6 @@ import {
   user_properties,
   tax
 } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Refund',
@@ -38,8 +37,6 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'refund', {
       currency: payload.currency,
       transaction_id: payload.transaction_id, // Transaction ID. Required for purchases and refunds.
@@ -49,6 +46,8 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       shipping: payload.shipping,
       tax: payload.tax,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/removeFromCart/generated-types.ts

@@ -93,6 +93,7 @@ export interface Payload {
      * Item quantity.
      */
     quantity?: number
+    [k: string]: unknown
   }[]
   /**
    * The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties.

package/src/removeFromCart/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
 import { user_properties, params, value, user_id, currency, items_single_products } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 // Change from unknown to the partner SDK types
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
@@ -23,12 +22,12 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'remove_from_cart', {
       currency: payload.currency,
       value: payload.value,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/search/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
 import { user_properties, params, user_id, search_term } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 // Change from unknown to the partner SDK types
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
@@ -18,10 +17,10 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     search_term: search_term
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'search', {
       search_term: payload.search_term,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/selectItem/generated-types.ts

@@ -93,6 +93,7 @@ export interface Payload {
      * Item quantity.
      */
     quantity?: number
+    [k: string]: unknown
   }[]
   /**
    * The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties.

package/src/selectItem/index.ts

@@ -10,7 +10,6 @@ import {
   item_list_name,
   item_list_id
 } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Select Item',
@@ -29,12 +28,12 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'select_item', {
       item_list_id: payload.item_list_id,
       item_list_name: payload.item_list_name,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/selectPromotion/generated-types.ts

@@ -121,6 +121,7 @@ export interface Payload {
      * The ID of the promotion associated with the event.
      */
     promotion_id?: string
+    [k: string]: unknown
   }[]
   /**
    * The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties.

package/src/selectPromotion/index.ts

@@ -14,8 +14,6 @@ import {
   user_properties,
   location_id
 } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
-
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Select Promotion',
   description: 'This event signifies a promotion was selected from a list.',
@@ -50,8 +48,6 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'select_promotion', {
       creative_name: payload.creative_name,
       creative_slot: payload.creative_slot,
@@ -59,6 +55,8 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       promotion_id: payload.promotion_id,
       promotion_name: payload.promotion_name,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/signUp/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
 import { user_properties, params, user_id, method } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'Sign Up',
@@ -17,10 +16,10 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'sign_up', {
       method: payload.method,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/viewCart/generated-types.ts

@@ -93,6 +93,7 @@ export interface Payload {
      * Item quantity.
      */
     quantity?: number
+    [k: string]: unknown
   }[]
   /**
    * The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties.

package/src/viewCart/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
 import { user_properties, params, currency, value, user_id, items_multi_products } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'View Cart',
@@ -22,12 +21,12 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'view_cart', {
       currency: payload.currency,
       value: payload.value,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/viewItem/generated-types.ts

@@ -93,6 +93,7 @@ export interface Payload {
      * Item quantity.
      */
     quantity?: number
+    [k: string]: unknown
   }[]
   /**
    * The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties.

package/src/viewItem/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
 import { user_properties, params, currency, user_id, value, items_single_products } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'View Item',
@@ -23,12 +22,12 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'view_item', {
       currency: payload.currency,
       value: payload.value,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/viewItemList/generated-types.ts

@@ -93,6 +93,7 @@ export interface Payload {
      * Item quantity.
      */
     quantity?: number
+    [k: string]: unknown
   }[]
   /**
    * The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties.

package/src/viewItemList/index.ts

@@ -3,7 +3,6 @@ import type { Settings } from '../generated-types'
 import type { Payload } from './generated-types'
 
 import { user_properties, params, user_id, items_multi_products, item_list_name, item_list_id } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'View Item List',
@@ -22,12 +21,12 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'view_item_list', {
       item_list_id: payload.item_list_id,
       item_list_name: payload.item_list_name,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/src/viewPromotion/generated-types.ts

@@ -121,6 +121,7 @@ export interface Payload {
      * The ID of the promotion associated with the event.
      */
     promotion_id?: string
+    [k: string]: unknown
   }[]
   /**
    * The user properties to send to Google Analytics 4. You must create user-scoped dimensions to ensure custom properties are picked up by Google. See Google’s [Custom user properties](https://support.google.com/analytics/answer/9269570) to learn how to set and register user properties.

package/src/viewPromotion/index.ts

@@ -13,7 +13,6 @@ import {
   user_properties,
   location_id
 } from '../ga4-properties'
-import { updateUser } from '../ga4-functions'
 
 const action: BrowserActionDefinition<Settings, Function, Payload> = {
   title: 'View Promotion',
@@ -50,8 +49,6 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
     params: params
   },
   perform: (gtag, { payload }) => {
-    updateUser(payload.user_id, payload.user_properties, gtag)
-
     gtag('event', 'view_promotion', {
       creative_name: payload.creative_name,
       creative_slot: payload.creative_slot,
@@ -59,6 +56,8 @@ const action: BrowserActionDefinition<Settings, Function, Payload> = {
       promotion_id: payload.promotion_id,
       promotion_name: payload.promotion_name,
       items: payload.items,
+      user_id: payload.user_id ?? undefined,
+      user_properties: payload.user_properties,
       ...payload.params
     })
   }

package/dist/cjs/ga4-functions.d.ts

@@ -1 +0,0 @@
-export declare function updateUser(userID: string | undefined, userProps: object | undefined, gtag: Function): void;

package/dist/cjs/ga4-functions.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateUser = void 0;
-function updateUser(userID, userProps, gtag) {
-    if (userID) {
-        gtag('set', { user_id: userID });
-    }
-    if (userProps) {
-        gtag('set', { user_properties: userProps });
-    }
-}
-exports.updateUser = updateUser;
-//# sourceMappingURL=ga4-functions.js.map

package/dist/cjs/ga4-functions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ga4-functions.js","sourceRoot":"","sources":["../../src/ga4-functions.ts"],"names":[],"mappings":";;;AAAA,SAAgB,UAAU,CAAC,MAA0B,EAAE,SAA6B,EAAE,IAAc;IAClG,IAAI,MAAM,EAAE;QACV,IAAI,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAA;KACjC;IACD,IAAI,SAAS,EAAE;QACb,IAAI,CAAC,KAAK,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAA;KAC5C;AACH,CAAC;AAPD,gCAOC"}

package/dist/esm/ga4-functions.d.ts

@@ -1 +0,0 @@
-export declare function updateUser(userID: string | undefined, userProps: object | undefined, gtag: Function): void;

package/dist/esm/ga4-functions.js

@@ -1,9 +0,0 @@
-export function updateUser(userID, userProps, gtag) {
-    if (userID) {
-        gtag('set', { user_id: userID });
-    }
-    if (userProps) {
-        gtag('set', { user_properties: userProps });
-    }
-}
-//# sourceMappingURL=ga4-functions.js.map

package/dist/esm/ga4-functions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ga4-functions.js","sourceRoot":"","sources":["../../src/ga4-functions.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,UAAU,CAAC,MAA0B,EAAE,SAA6B,EAAE,IAAc;IAClG,IAAI,MAAM,EAAE;QACV,IAAI,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAA;KACjC;IACD,IAAI,SAAS,EAAE;QACb,IAAI,CAAC,KAAK,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,CAAA;KAC5C;AACH,CAAC"}

package/src/ga4-functions.ts

@@ -1,8 +0,0 @@
-export function updateUser(userID: string | undefined, userProps: object | undefined, gtag: Function): void {
-  if (userID) {
-    gtag('set', { user_id: userID })
-  }
-  if (userProps) {
-    gtag('set', { user_properties: userProps })
-  }
-}