@segment/analytics-browser-actions-reddit-pixel 1.1.0

package/src/reportCustomWebEvent/generated-types.ts

@@ -0,0 +1,84 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * The unique conversion ID that corresponds to a distinct conversion event. This is used for deduplication. If you are using both Reddit Pixel and CAPI integrations, this field is required in order to dedupe the same events across both sources.
+   */
+  conversion_id?: string
+  /**
+   * The metadata associated with the conversion event.
+   */
+  event_metadata?: {
+    /**
+     * The currency for the value provided. This must be a three-character ISO 4217 currency code. This should only be set for revenue-related events.
+     */
+    currency?: string
+    /**
+     * The number of items in the event. This should only be set for revenue-related events.
+     */
+    itemCount?: number
+    /**
+     * The value of the transaction in the base unit of the currency. This should only be set for revenue-related events.
+     */
+    value?: number
+  }
+  /**
+   * The identifying user parameters associated with the conversion event.
+   */
+  user?: {
+    /**
+     * The mobile advertising ID for the user. This can be the iOS IDFA, Android AAID.
+     */
+    advertising_id?: string
+    /**
+     * The type of mobile device. e.g. iOS or Android.
+     */
+    device_type?: string
+    /**
+     * The email address of the user.
+     */
+    email?: string
+    /**
+     * An advertiser-assigned persistent identifier for the user.
+     */
+    externalId?: string
+    /**
+     * The phone number of the user in E.164 standard format.
+     */
+    phoneNumber?: string
+  }
+  /**
+   * The products associated with the conversion event.
+   */
+  products?: {
+    /**
+     * The category the product.
+     */
+    category?: string
+    /**
+     * The ID representing the product in a catalog
+     */
+    id?: string
+    /**
+     * The name of the product
+     */
+    name?: string
+  }[]
+  /**
+   * A structure of data processing options to specify the processing type for the event. This is only used for LDU - when the LDU flag is enabled, it may impact campaign performance and limit the size of targetable audiences.
+   */
+  data_processing_options?: {
+    /**
+     * Country Code of the user. We support ISO 3166-1 alpha-2 country code.
+     */
+    country?: string
+    /**
+     * Region Code of the user. We support ISO 3166-2 region code, ex: "US-CA, US-NY, etc." or just the region code without country prefix, e.g. "CA, NY, etc.". This is only used for LDU - when the LDU flag is enabled, it may impact campaign performance and limit the size of targetable audiences.
+     */
+    region?: string
+  }
+  /**
+   * A custom event name that can be passed when tracking_type is set to "Custom". All UTF-8 characters are accepted and custom_event_name must be at most 64 characters long.
+   */
+  custom_event_name: string
+}

package/src/reportCustomWebEvent/index.ts

@@ -0,0 +1,27 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { conversion_id, event_metadata, user, products, data_processing_options, custom_event_name } from '../fields'
+import { RedditPixel } from '../types'
+import { initPixel, trackCall } from '../utils'
+
+const action: BrowserActionDefinition<Settings, RedditPixel, Payload> = {
+  title: 'Reddit Pixel - Custom Event',
+  description: 'Send Custom Pixel Events to Reddit.',
+  defaultSubscription: 'type = "track"',
+  platform: 'web',
+  fields: {
+    conversion_id,
+    event_metadata,
+    user,
+    products,
+    data_processing_options,
+    custom_event_name
+  },
+  perform: (rdt, { payload, settings }) => {
+    initPixel(rdt, payload, settings)
+    trackCall(rdt, payload)
+  }
+}
+
+export default action

package/src/reportWebEvent/generated-types.ts

@@ -0,0 +1,84 @@
+// Generated file. DO NOT MODIFY IT BY HAND.
+
+export interface Payload {
+  /**
+   * One of Reddit Pixel's standard conversion event types. To send a Custom event to Reddit use the Custom Event Action instead.
+   */
+  tracking_type: string
+  /**
+   * The products associated with the conversion event.
+   */
+  products?: {
+    /**
+     * The category the product.
+     */
+    category?: string
+    /**
+     * The ID representing the product in a catalog
+     */
+    id?: string
+    /**
+     * The name of the product
+     */
+    name?: string
+  }[]
+  /**
+   * The identifying user parameters associated with the conversion event.
+   */
+  user?: {
+    /**
+     * The mobile advertising ID for the user. This can be the iOS IDFA, Android AAID.
+     */
+    advertising_id?: string
+    /**
+     * The type of mobile device. e.g. iOS or Android.
+     */
+    device_type?: string
+    /**
+     * The email address of the user.
+     */
+    email?: string
+    /**
+     * An advertiser-assigned persistent identifier for the user.
+     */
+    externalId?: string
+    /**
+     * The phone number of the user in E.164 standard format.
+     */
+    phoneNumber?: string
+  }
+  /**
+   * A structure of data processing options to specify the processing type for the event. This is only used for LDU - when the LDU flag is enabled, it may impact campaign performance and limit the size of targetable audiences.
+   */
+  data_processing_options?: {
+    /**
+     * Country Code of the user. We support ISO 3166-1 alpha-2 country code.
+     */
+    country?: string
+    /**
+     * Region Code of the user. We support ISO 3166-2 region code, ex: "US-CA, US-NY, etc." or just the region code without country prefix, e.g. "CA, NY, etc.". This is only used for LDU - when the LDU flag is enabled, it may impact campaign performance and limit the size of targetable audiences.
+     */
+    region?: string
+  }
+  /**
+   * The metadata associated with the conversion event.
+   */
+  event_metadata?: {
+    /**
+     * The currency for the value provided. This must be a three-character ISO 4217 currency code. This should only be set for revenue-related events.
+     */
+    currency?: string
+    /**
+     * The number of items in the event. This should only be set for revenue-related events.
+     */
+    itemCount?: number
+    /**
+     * The value of the transaction in the base unit of the currency. This should only be set for revenue-related events.
+     */
+    value?: number
+  }
+  /**
+   * The unique conversion ID that corresponds to a distinct conversion event. This is used for deduplication. If you are using both Reddit Pixel and CAPI integrations, this field is required in order to dedupe the same events across both sources.
+   */
+  conversion_id?: string
+}

package/src/reportWebEvent/index.ts

@@ -0,0 +1,27 @@
+import type { BrowserActionDefinition } from '@segment/browser-destination-runtime/types'
+import type { Settings } from '../generated-types'
+import type { Payload } from './generated-types'
+import { tracking_type, conversion_id, event_metadata, user, products, data_processing_options } from '../fields'
+import { RedditPixel } from '../types'
+import { initPixel, trackCall } from '../utils'
+
+const action: BrowserActionDefinition<Settings, RedditPixel, Payload> = {
+  title: 'Reddit Pixel',
+  description: 'Send Standard Pixel Events to Reddit. This includes pagevisits, addtocarts, search, etc.',
+  defaultSubscription: 'type = "track"',
+  platform: 'web',
+  fields: {
+    tracking_type,
+    products,
+    user,
+    data_processing_options,
+    event_metadata,
+    conversion_id
+  },
+  perform: (rdt, { payload, settings }) => {
+    initPixel(rdt, payload, settings)
+    trackCall(rdt, payload)
+  }
+}
+
+export default action

package/src/types.ts

@@ -0,0 +1,30 @@
+export interface RedditPixel {
+  page: () => void
+  init: (
+    pixelId: string,
+    ldu?: {
+      dpm?: string
+      dpcc?: string
+      dprc?: string
+    }
+  ) => void
+  track: (eventName: string, eventMetadata?: EventMetadata) => void
+}
+
+export interface EventMetadata {
+  currency?: string
+  itemCount?: number
+  value?: number
+  customEventName?: string
+  conversionId?: string
+  aaid?: string
+  idfa?: string
+  email?: string
+  phoneNumber?: string
+  externalId?: string
+  products?: {
+    id?: string | undefined
+    category?: string | undefined
+    name?: string | undefined
+  }[]
+}

package/src/utils.ts

@@ -0,0 +1,40 @@
+import type { Settings } from './generated-types'
+import type { Payload as StandardEvent } from './reportWebEvent/generated-types'
+import type { Payload as CustomEvent } from './reportCustomWebEvent/generated-types'
+import { RedditPixel, EventMetadata } from './types'
+
+export function initPixel(rdt: RedditPixel, payload: StandardEvent | CustomEvent, settings: Settings) {
+  rdt.init(settings.pixel_id, {
+    ...(settings.ldu && {
+      dpm: 'LDU', // Currently "LDU" is the only value supported if the LDU toggle is enabled.
+      dpcc: payload.data_processing_options?.country,
+      dprc: payload.data_processing_options?.region
+    })
+  })
+}
+
+export function trackCall(rdt: RedditPixel, payload: StandardEvent | CustomEvent) {
+  if (['PageVisit', 'ViewContent', 'Search'].includes((payload as StandardEvent)?.tracking_type)) {
+    delete payload.event_metadata
+  }
+
+  const fullPayload: EventMetadata = {
+    ...payload.event_metadata,
+    products: payload.products ?? undefined,
+    conversionId: payload.conversion_id ?? undefined,
+    email: payload?.user?.email ?? undefined,
+    externalId: payload?.user?.externalId ?? undefined,
+    phoneNumber: payload?.user?.phoneNumber ?? undefined,
+    aaid:
+      payload?.user?.advertising_id && payload?.user?.device_type?.toLowerCase() === 'android'
+        ? payload?.user?.advertising_id
+        : undefined,
+    idfa:
+      payload?.user?.advertising_id && payload?.user?.device_type?.toLowerCase() === 'ios'
+        ? payload?.user?.advertising_id
+        : undefined,
+    customEventName: (payload as CustomEvent).custom_event_name ?? undefined
+  }
+
+  rdt.track((payload as StandardEvent).tracking_type ?? 'Custom', fullPayload)
+}

package/tsconfig.json

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