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

package/src/viewPromotion/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/viewPromotion/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,
+  creative_slot,
+  promotion_id,
+  promotion_name,
+  user_id,
+  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: 'View Promotion',
+  description: 'This event signifies a promotion was viewed from a list.',
+  defaultSubscription: 'type = "track"',
+  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,
+      required: true,
+      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', 'view_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/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "baseUrl": "."
+  },
+  "include": ["src"],
+  "exclude": ["dist", "**/__tests__"]
+}