@segment/analytics-browser-actions-google-analytics-4 1.0.0

package/src/removeFromCart/generated-types.ts

@@ -0,0 +1,109 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * A unique identifier for a user. See Google's [User-ID for cross-platform analysis](https://support.google.com/analytics/answer/9213390) and [Reporting: deduplicate user counts](https://support.google.com/analytics/answer/9355949?hl=en) documentation for more information on this identifier.
+   */
+  user_id?: string
+  /**
+   * Currency of the items associated with the event, in 3-letter ISO 4217 format.
+   */
+  currency?: string
+  /**
+   * The monetary value of the event.
+   */
+  value?: number
+  /**
+   * The list of products purchased.
+   */
+  items: {
+    /**
+     * Identifier for the product being purchased.
+     */
+    item_id?: string
+    /**
+     * Name of the product being purchased.
+     */
+    item_name?: string
+    /**
+     * A product affiliation to designate a supplying company or brick and mortar store location.
+     */
+    affiliation?: string
+    /**
+     * Coupon code used for a purchase.
+     */
+    coupon?: string
+    /**
+     * Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
+     */
+    currency?: string
+    /**
+     * Monetary value of discount associated with a purchase.
+     */
+    discount?: number
+    /**
+     * The index/position of the item in a list.
+     */
+    index?: number
+    /**
+     * Brand associated with the product.
+     */
+    item_brand?: string
+    /**
+     * Product category.
+     */
+    item_category?: string
+    /**
+     * Product category 2.
+     */
+    item_category2?: string
+    /**
+     * Product category 3.
+     */
+    item_category3?: string
+    /**
+     * Product category 4.
+     */
+    item_category4?: string
+    /**
+     * Product category 5.
+     */
+    item_category5?: string
+    /**
+     * The ID of the list in which the item was presented to the user.
+     */
+    item_list_id?: string
+    /**
+     * The name of the list in which the item was presented to the user.
+     */
+    item_list_name?: string
+    /**
+     * Variant of the product (e.g. Black).
+     */
+    item_variant?: string
+    /**
+     * The location associated with the item.
+     */
+    location_id?: string
+    /**
+     * Price of the product being purchased, in units of the specified currency parameter.
+     */
+    price?: number
+    /**
+     * Item quantity.
+     */
+    quantity?: number
+  }[]
+  /**
+   * 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.
+   */
+  user_properties?: {
+    [k: string]: unknown
+  }
+  /**
+   * The event parameters to send to Google Analytics 4.
+   */
+  params?: {
+    [k: string]: unknown
+  }
+}

package/src/removeFromCart/index.ts

@@ -0,0 +1,37 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+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> = {
+  title: 'Remove from Cart',
+  description: 'This event signifies that an item was removed from a cart.',
+  platform: 'web',
+  defaultSubscription: 'type = "track" and event = "Product Removed"',
+  fields: {
+    user_id: user_id,
+    currency: currency,
+    value: value,
+    items: {
+      ...items_single_products,
+      required: true
+    },
+    user_properties: user_properties,
+    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,
+      ...payload.params
+    })
+  }
+}
+
+export default action

package/src/search/generated-types.ts

@@ -0,0 +1,24 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * A unique identifier for a user. See Google's [User-ID for cross-platform analysis](https://support.google.com/analytics/answer/9213390) and [Reporting: deduplicate user counts](https://support.google.com/analytics/answer/9355949?hl=en) documentation for more information on this identifier.
+   */
+  user_id?: string
+  /**
+   * 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.
+   */
+  user_properties?: {
+    [k: string]: unknown
+  }
+  /**
+   * The event parameters to send to Google Analytics 4.
+   */
+  params?: {
+    [k: string]: unknown
+  }
+  /**
+   * The term that was searched for.
+   */
+  search_term?: string
+}

package/src/search/index.ts

@@ -0,0 +1,30 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+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> = {
+  title: 'Search',
+  description: 'The term that was searched for.',
+  defaultSubscription: 'type = "track" and event = "Products Searched"',
+  platform: 'web',
+  fields: {
+    user_id: user_id,
+    user_properties: user_properties,
+    params: params,
+    search_term: search_term
+  },
+  perform: (gtag, { payload }) => {
+    updateUser(payload.user_id, payload.user_properties, gtag)
+
+    gtag('event', 'search', {
+      search_term: payload.search_term,
+      ...payload.params
+    })
+  }
+}
+
+export default action

package/src/selectItem/generated-types.ts

@@ -0,0 +1,109 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * A unique identifier for a user. See Google's [User-ID for cross-platform analysis](https://support.google.com/analytics/answer/9213390) and [Reporting: deduplicate user counts](https://support.google.com/analytics/answer/9355949?hl=en) documentation for more information on this identifier.
+   */
+  user_id?: string
+  /**
+   * The name of the list in which the item was presented to the user.
+   */
+  item_list_name?: string
+  /**
+   * The ID of the list in which the item was presented to the user.
+   */
+  item_list_id?: string
+  /**
+   * The list of products purchased.
+   */
+  items: {
+    /**
+     * Identifier for the product being purchased.
+     */
+    item_id?: string
+    /**
+     * Name of the product being purchased.
+     */
+    item_name?: string
+    /**
+     * A product affiliation to designate a supplying company or brick and mortar store location.
+     */
+    affiliation?: string
+    /**
+     * Coupon code used for a purchase.
+     */
+    coupon?: string
+    /**
+     * Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
+     */
+    currency?: string
+    /**
+     * Monetary value of discount associated with a purchase.
+     */
+    discount?: number
+    /**
+     * The index/position of the item in a list.
+     */
+    index?: number
+    /**
+     * Brand associated with the product.
+     */
+    item_brand?: string
+    /**
+     * Product category.
+     */
+    item_category?: string
+    /**
+     * Product category 2.
+     */
+    item_category2?: string
+    /**
+     * Product category 3.
+     */
+    item_category3?: string
+    /**
+     * Product category 4.
+     */
+    item_category4?: string
+    /**
+     * Product category 5.
+     */
+    item_category5?: string
+    /**
+     * The ID of the list in which the item was presented to the user.
+     */
+    item_list_id?: string
+    /**
+     * The name of the list in which the item was presented to the user.
+     */
+    item_list_name?: string
+    /**
+     * Variant of the product (e.g. Black).
+     */
+    item_variant?: string
+    /**
+     * The location associated with the item.
+     */
+    location_id?: string
+    /**
+     * Price of the product being purchased, in units of the specified currency parameter.
+     */
+    price?: number
+    /**
+     * Item quantity.
+     */
+    quantity?: number
+  }[]
+  /**
+   * 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.
+   */
+  user_properties?: {
+    [k: string]: unknown
+  }
+  /**
+   * The event parameters to send to Google Analytics 4.
+   */
+  params?: {
+    [k: string]: unknown
+  }
+}

package/src/selectItem/index.ts

@@ -0,0 +1,43 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+
+import {
+  user_properties,
+  params,
+  user_id,
+  items_single_products,
+  item_list_name,
+  item_list_id
+} from '../ga4-properties'
+import { updateUser } from '../ga4-functions'
+
+const action: BrowserActionDefinition<Settings, Function, Payload> = {
+  title: 'Select Item',
+  description: 'This event signifies an item was selected from a list.',
+  defaultSubscription: 'type = "track" and event = "Product Clicked"',
+  platform: 'web',
+  fields: {
+    user_id: user_id,
+    item_list_name: item_list_name,
+    item_list_id: item_list_id,
+    items: {
+      ...items_single_products,
+      required: true
+    },
+    user_properties: user_properties,
+    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,
+      ...payload.params
+    })
+  }
+}
+
+export default action

package/src/selectPromotion/generated-types.ts

@@ -0,0 +1,137 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * A unique identifier for a user. See Google's [User-ID for cross-platform analysis](https://support.google.com/analytics/answer/9213390) and [Reporting: deduplicate user counts](https://support.google.com/analytics/answer/9355949?hl=en) documentation for more information on this identifier.
+   */
+  user_id?: string
+  /**
+   * The name of the promotional creative.
+   */
+  creative_name?: string
+  /**
+   * The name of the promotional creative slot associated with the event.
+   */
+  creative_slot?: string
+  /**
+   * The ID of the location.
+   */
+  location_id?: string
+  /**
+   * The ID of the promotion associated with the event.
+   */
+  promotion_id?: string
+  /**
+   * The name of the promotion associated with the event.
+   */
+  promotion_name?: string
+  /**
+   * The list of products purchased.
+   */
+  items?: {
+    /**
+     * Identifier for the product being purchased.
+     */
+    item_id?: string
+    /**
+     * Name of the product being purchased.
+     */
+    item_name?: string
+    /**
+     * A product affiliation to designate a supplying company or brick and mortar store location.
+     */
+    affiliation?: string
+    /**
+     * Coupon code used for a purchase.
+     */
+    coupon?: string
+    /**
+     * Currency of the purchase or items associated with the event, in 3-letter ISO 4217 format.
+     */
+    currency?: string
+    /**
+     * Monetary value of discount associated with a purchase.
+     */
+    discount?: number
+    /**
+     * The index/position of the item in a list.
+     */
+    index?: number
+    /**
+     * Brand associated with the product.
+     */
+    item_brand?: string
+    /**
+     * Product category.
+     */
+    item_category?: string
+    /**
+     * Product category 2.
+     */
+    item_category2?: string
+    /**
+     * Product category 3.
+     */
+    item_category3?: string
+    /**
+     * Product category 4.
+     */
+    item_category4?: string
+    /**
+     * Product category 5.
+     */
+    item_category5?: string
+    /**
+     * The ID of the list in which the item was presented to the user.
+     */
+    item_list_id?: string
+    /**
+     * The name of the list in which the item was presented to the user.
+     */
+    item_list_name?: string
+    /**
+     * Variant of the product (e.g. Black).
+     */
+    item_variant?: string
+    /**
+     * The location associated with the item.
+     */
+    location_id?: string
+    /**
+     * Price of the product being purchased, in units of the specified currency parameter.
+     */
+    price?: number
+    /**
+     * Item quantity.
+     */
+    quantity?: number
+    /**
+     * The name of the promotional creative.
+     */
+    creative_name?: string
+    /**
+     * The name of the promotional creative slot associated with the event.
+     */
+    creative_slot?: string
+    /**
+     * The name of the promotion associated with the event.
+     */
+    promotion_name?: string
+    /**
+     * The ID of the promotion associated with the event.
+     */
+    promotion_id?: string
+  }[]
+  /**
+   * 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.
+   */
+  user_properties?: {
+    [k: string]: unknown
+  }
+  /**
+   * The event parameters to send to Google Analytics 4.
+   */
+  params?: {
+    [k: string]: unknown
+  }
+}

package/src/selectPromotion/index.ts

@@ -0,0 +1,67 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+
+import {
+  creative_name,
+  user_id,
+  creative_slot,
+  promotion_id,
+  promotion_name,
+  minimal_items,
+  items_single_products,
+  params,
+  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.',
+  defaultSubscription: 'type = "track" and event = "Promotion Clicked"',
+  platform: 'web',
+  fields: {
+    user_id: user_id,
+    creative_name: creative_name,
+    creative_slot: { ...creative_slot, default: { '@path': '$.properties.creative' } },
+    location_id: location_id,
+    promotion_id: { ...promotion_id, default: { '@path': '$.properties.promotion_id' } },
+    promotion_name: { ...promotion_name, default: { '@path': '$.properties.name' } },
+    items: {
+      ...items_single_products,
+      properties: {
+        ...minimal_items.properties,
+        creative_name: {
+          ...creative_name
+        },
+        creative_slot: {
+          ...creative_slot
+        },
+        promotion_name: {
+          ...promotion_name
+        },
+        promotion_id: {
+          ...promotion_id
+        }
+      }
+    },
+    user_properties: user_properties,
+    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,
+      location_id: payload.location_id,
+      promotion_id: payload.promotion_id,
+      promotion_name: payload.promotion_name,
+      items: payload.items,
+      ...payload.params
+    })
+  }
+}
+
+export default action

package/src/setConfigurationFields/generated-types.ts

@@ -0,0 +1,70 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * A unique identifier for a user. See Google's [User-ID for cross-platform analysis](https://support.google.com/analytics/answer/9213390) and [Reporting: deduplicate user counts](https://support.google.com/analytics/answer/9355949?hl=en) documentation for more information on this identifier.
+   */
+  user_id?: string
+  /**
+   * 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.
+   */
+  user_properties?: {
+    [k: string]: unknown
+  }
+  /**
+   * Consent state indicated by the user for ad cookies. Value must be “granted” or “denied.” This is only used if the Enable Consent Mode setting is on.
+   */
+  ads_storage_consent_state?: string
+  /**
+   * Consent state indicated by the user for ad cookies. Value must be “granted” or “denied.” This is only used if the Enable Consent Mode setting is on.
+   */
+  analytics_storage_consent_state?: string
+  /**
+   * Use campaign content to differentiate ads or links that point to the same URL. Setting this value will override the utm_content query parameter.
+   */
+  campaign_content?: string
+  /**
+   * Use campaign ID to identify a specific campaign. Setting this value will override the utm_id query parameter.
+   */
+  campaign_id?: string
+  /**
+   * Use campaign medium to identify a medium such as email or cost-per-click. Setting this value will override the utm_medium query parameter.
+   */
+  campaign_medium?: string
+  /**
+   * Use campaign name to identify a specific product promotion or strategic campaign. Setting this value will override the utm_name query parameter.
+   */
+  campaign_name?: string
+  /**
+   * Use campaign source to identify a search engine, newsletter name, or other source. Setting this value will override the utm_source query parameter.
+   */
+  campaign_source?: string
+  /**
+   * Use campaign term to note the keywords for this ad. Setting this value will override the utm_term query parameter.
+   */
+  campaign_term?: string
+  /**
+   * Categorize pages and screens into custom buckets so you can see metrics for related groups of information. More information in [Google documentation](https://support.google.com/analytics/answer/11523339).
+   */
+  content_group?: string
+  /**
+   * The language preference of the user. If not set, defaults to the user's navigator.language value.
+   */
+  language?: string
+  /**
+   * The full URL of the page. If not set, defaults to the user's document.location value.
+   */
+  page_location?: string
+  /**
+   * The referral source that brought traffic to a page. This value is also used to compute the traffic source. The format of this value is a URL. If not set, defaults to the user's document.referrer value.
+   */
+  page_referrer?: string
+  /**
+   * The title of the page or document. If not set, defaults to the user's document.title value.
+   */
+  page_title?: string
+  /**
+   * The resolution of the screen. Format should be two positive integers separated by an x (i.e. 800x600). If not set, calculated from the user's window.screen value.
+   */
+  screen_resolution?: string
+}