@segment/analytics-browser-actions-tiktok-pixel 1.94.1-staging-1f6aa0a59.0 → 1.95.1-staging-ce1986724.0

package/src/reportWebEvent/travel_fields.ts

@@ -0,0 +1,216 @@
+import { InputField } from '@segment/actions-core'
+import { TRAVEL_FIELDS } from '../constants'
+
+export const travel_fields: InputField = {
+  label: 'Travel Fields',
+  type: 'object',
+  description: 'Fields related to travel events.',
+  additionalProperties: false,
+  defaultObjectUI: 'keyvalue',
+  properties: {
+    city: {
+      label: 'Hotel City Location',
+      type: 'string',
+      description: 'Hotel city location.'
+    },
+    region: {
+      label: 'Hotel Region',
+      type: 'string',
+      description: 'Hotel region location.'
+    },
+    country: {
+      label: 'Hotel Country',
+      type: 'string',
+      description: 'Hotel country location.'
+    },
+    checkin_date: {
+      label: 'Hotel Check-in Date',
+      type: 'string',
+      description: 'Hotel check-in date.'
+    },
+    checkout_date: {
+      label: 'Hotel Check-out Date',
+      type: 'string',
+      description: 'Hotel check-out date.'
+    },
+    num_adults: {
+      label: 'Number of Adults',
+      type: 'number',
+      description: 'Number of adults.'
+    },
+    num_children: {
+      label: 'Number of Children',
+      type: 'number',
+      description: 'Number of children.'
+    },
+    num_infants: {
+      label: 'Number of Infants',
+      type: 'number',
+      description: 'Number of infants flying.'
+    },
+    suggested_hotels: {
+      label: 'Suggested Hotels',
+      description: 'Suggested hotels. This can be a single string value or an array of string values.',
+      type: 'string',
+      multiple: true
+    },
+    departing_departure_date: {
+      label: 'Departure Date',
+      type: 'string',
+      description:
+        'Date of flight departure. Accepted date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, and YYYY-MM-DDThh:mm:ssTZD'
+    },
+    returning_departure_date: {
+      label: 'Arrival Date',
+      type: 'string',
+      description:
+        'Date of return flight. Accepted date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, and YYYY-MM-DDThh:mm:ssTZD'
+    },
+    origin_airport: {
+      label: 'Origin Airport',
+      type: 'string',
+      description: 'Origin airport.'
+    },
+    destination_airport: {
+      label: 'Destination Airport',
+      type: 'string',
+      description: 'Destination airport.'
+    },
+    destination_ids: {
+      label: 'Destination IDs',
+      description:
+        'If a client has a destination catalog, the client can associate one or more destinations in the catalog with a specific flight event. For instance, link a particular route to a nearby museum and a nearby beach, both of which are destinations in the catalog. This field accepts a single string value or an array of string values.',
+      type: 'string',
+      multiple: true
+    },
+    departing_arrival_date: {
+      label: 'Departing Arrival Date',
+      type: 'string',
+      description:
+        'The date and time for arrival at the destination of the outbound journey. Accepted date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, and YYYY-MM-DDThh:mm:ssTZD'
+    },
+    returning_arrival_date: {
+      label: 'Returning Arrival Date',
+      type: 'string',
+      description:
+        'The date and time when the return journey is completed. Accepted date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, and YYYY-MM-DDThh:mm:ssTZD'
+    },
+    travel_class: {
+      label: 'Flight Ticket Class',
+      type: 'string',
+      description: 'Class of the flight ticket, must be: "eco", "prem", "bus", "first".',
+      choices: [
+        { value: 'eco', label: 'Economy' },
+        { value: 'prem', label: 'Premium' },
+        { value: 'bus', label: 'Bus' },
+        { value: 'first', label: 'First' }
+      ]
+    },
+    user_score: {
+      label: 'User Score',
+      type: 'number',
+      description: 'Represents the relative value of this potential customer to advertiser.'
+    },
+    preferred_num_stops: {
+      label: 'Preferred Number of Stops',
+      type: 'integer',
+      description: 'The preferred number of stops the user is looking for. 0 for direct flight.'
+    },
+    travel_start: {
+      label: 'Start Date of the Trip',
+      type: 'string',
+      description:
+        "The start date of user's trip. Accept date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, and YYYY-MM-DDThh:mm:ssTZD."
+    },
+    travel_end: {
+      label: 'End Date of the Trip',
+      type: 'string',
+      description:
+        "The end date of user's trip. Accept date formats: YYYYMMDD, YYYY-MM-DD, YYYY-MM-DDThh:mmTZD, and YYYY-MM-DDThh:mm:ssTZD."
+    },
+    suggested_destinations: {
+      label: 'Suggested Destination IDs',
+      description:
+        'A list of IDs representing destination suggestions for this user. This parameter is not applicable for the Search event. This field accepts a single string value or an array of string values.',
+      type: 'string',
+      multiple: true
+    }
+  },
+  default: {
+    city: {
+      '@path': '$.properties.city'
+    },
+    region: {
+      '@path': '$.properties.region'
+    },
+    country: {
+      '@path': '$.properties.country'
+    },
+    checkin_date: {
+      '@path': '$.properties.checkin_date'
+    },
+    checkout_date: {
+      '@path': '$.properties.checkout_date'
+    },
+    num_adults: {
+      '@path': '$.properties.num_adults'
+    },
+    num_children: {
+      '@path': '$.properties.num_children'
+    },
+    num_infants: {
+      '@path': '$.properties.num_infants'
+    },
+    suggested_hotels: {
+      '@path': '$.properties.suggested_hotels' // Confirmed this can be a single string or an array of strings
+    },
+    departing_departure_date: {
+      '@path': '$.properties.departing_departure_date'
+    },
+    returning_departure_date: {
+      '@path': '$.properties.returning_departure_date'
+    },
+    origin_airport: {
+      '@path': '$.properties.origin_airport'
+    },
+    destination_airport: {
+      '@path': '$.properties.destination_airport'
+    },
+    destination_ids: {
+      '@path': '$.properties.destination_ids' // Confirmed this can be a single string or an array of strings
+    },
+    departing_arrival_date: {
+      '@path': '$.properties.departing_arrival_date'
+    },
+    returning_arrival_date: {
+      '@path': '$.properties.returning_arrival_date'
+    },
+    travel_class: {
+      '@path': '$.properties.travel_class'
+    },
+    user_score: {
+      '@path': '$.properties.user_score'
+    },
+    preferred_num_stops: {
+      '@path': '$.properties.preferred_num_stops'
+    },
+    travel_start: {
+      '@path': '$.properties.travel_start'
+    },
+    travel_end: {
+      '@path': '$.properties.travel_end'
+    },
+    suggested_destinations: {
+      '@path': '$.properties.suggested_destinations' // Confirmed this can be a single string or an array of strings
+    }
+  },
+  depends_on: {
+    conditions: [
+      {
+        fieldKey: 'event_spec_type',
+        operator: 'is',
+        value: TRAVEL_FIELDS
+      }
+    ]
+  }
+}

package/src/reportWebEvent/utils.ts

@@ -0,0 +1,167 @@
+import { Payload } from './generated-types'
+import { TTBaseProps, TTTravelProps, TTAutoProps } from '../types'
+import { TRAVEL_FIELDS, VEHICLE_FIELDS } from '../constants'
+
+export function getAllProperties(payload: Payload): TTBaseProps & TTAutoProps & TTTravelProps {
+  const { event_spec_type } = payload
+
+  return {
+    ...getProps(payload),
+    ...(event_spec_type === TRAVEL_FIELDS ? getTravelProps(payload) : {}),
+    ...(event_spec_type === VEHICLE_FIELDS ? getAutoProp(payload) : {})
+  }
+}
+
+function getProps(payload: Payload): TTBaseProps {
+  const {
+    content_type,
+    currency,
+    value,
+    query,
+    description,
+    order_id,
+    shop_id,
+    content_ids,
+    num_items,
+    search_string,
+    contents
+  } = payload
+
+  const requestProperties: TTBaseProps = {
+    contents: contents
+      ? contents.map(({ price, quantity, content_category, content_id, content_name, brand }) => ({
+          ...(price !== undefined && { price }),
+          ...(quantity !== undefined && { quantity }),
+          ...(content_category !== undefined && { content_category }),
+          ...(content_id !== undefined && { content_id }),
+          ...(content_name !== undefined && { content_name }),
+          ...(brand !== undefined && { brand })
+        }))
+      : [],
+    ...(content_type !== undefined && { content_type }),
+    ...( { currency: currency ?? 'USD' } ),
+    ...(value !== undefined && { value }),
+    ...(query !== undefined && { query }),
+    ...(description !== undefined && { description }),
+    ...(order_id !== undefined && { order_id }),
+    ...(shop_id !== undefined && { shop_id }),
+    ...(content_ids !== undefined && { content_ids }),
+    ...(num_items !== undefined && { num_items }),
+    ...(search_string !== undefined && { search_string })
+  }
+
+  return requestProperties
+}
+
+function getTravelProps(payload: Payload): TTTravelProps {
+  const {
+    city,
+    region,
+    country,
+    checkin_date,
+    checkout_date,
+    num_adults,
+    num_children,
+    num_infants,
+    suggested_hotels,
+    departing_departure_date,
+    returning_departure_date,
+    origin_airport,
+    destination_airport,
+    destination_ids,
+    departing_arrival_date,
+    returning_arrival_date,
+    travel_class,
+    user_score,
+    preferred_num_stops,
+    travel_start,
+    travel_end,
+    suggested_destinations
+  } = payload?.travel_fields ?? {}
+
+  const requestProperties: TTTravelProps = {
+    ...(city !== undefined && { city }),
+    ...(region !== undefined && { region }),
+    ...(country !== undefined && { country }),
+    ...(checkin_date !== undefined && { checkin_date }),
+    ...(checkout_date !== undefined && { checkout_date }),
+    ...(num_adults !== undefined && { num_adults }),
+    ...(num_children !== undefined && { num_children }),
+    ...(num_infants !== undefined && { num_infants }),
+    ...(suggested_hotels !== undefined && { suggested_hotels }),
+    ...(departing_departure_date !== undefined && { departing_departure_date }),
+    ...(returning_departure_date !== undefined && { returning_departure_date }),
+    ...(origin_airport !== undefined && { origin_airport }),
+    ...(destination_airport !== undefined && { destination_airport }),
+    ...(destination_ids !== undefined && { destination_ids }),
+    ...(departing_arrival_date !== undefined && { departing_arrival_date }),
+    ...(returning_arrival_date !== undefined && { returning_arrival_date }),
+    ...(travel_class !== undefined && { travel_class }),
+    ...(user_score !== undefined && { user_score }),
+    ...(preferred_num_stops !== undefined && { preferred_num_stops }),
+    ...(travel_start !== undefined && { travel_start }),
+    ...(travel_end !== undefined && { travel_end }),
+    ...(suggested_destinations !== undefined && { suggested_destinations })
+  }
+
+  return requestProperties
+}
+
+function getAutoProp(payload: Payload): TTAutoProps {
+  const {
+    postal_code,
+    make,
+    model,
+    year,
+    state_of_vehicle,
+    mileage_unit,
+    mileage_value,
+    exterior_color,
+    transmission,
+    body_style,
+    fuel_type,
+    drivetrain,
+    preferred_price_range_min,
+    preferred_price_range_max,
+    trim,
+    vin,
+    interior_color,
+    condition_of_vehicle,
+    viewcontent_type,
+    search_type,
+    registration_type
+  } = payload?.vehicle_fields ?? {}
+
+  const requestProperties: TTAutoProps = {
+    ...(postal_code !== undefined && { postal_code }),
+    ...(make !== undefined && { make }),
+    ...(model !== undefined && { model }),
+    ...(year !== undefined && { year }),
+    ...(state_of_vehicle !== undefined && { state_of_vehicle }),
+    ...(exterior_color !== undefined && { exterior_color }),
+    ...(transmission !== undefined && { transmission }),
+    ...(body_style !== undefined && { body_style }),
+    ...(fuel_type !== undefined && { fuel_type }),
+    ...(drivetrain !== undefined && { drivetrain }),
+    ...(trim !== undefined && { trim }),
+    ...(vin !== undefined && { vin }),
+    ...(interior_color !== undefined && { interior_color }),
+    ...(condition_of_vehicle !== undefined && { condition_of_vehicle }),
+    ...(viewcontent_type !== undefined && { viewcontent_type }),
+    ...(search_type !== undefined && { search_type }),
+    ...(registration_type !== undefined && { registration_type }),
+    ...(mileage_unit !== undefined &&
+      typeof mileage_value === 'number' && {
+        mileage: {
+          unit: mileage_unit,
+          value: mileage_value
+        }
+      }),
+    ...(typeof preferred_price_range_min === 'number' &&
+      typeof preferred_price_range_max === 'number' && {
+        preferred_price_range: [preferred_price_range_min, preferred_price_range_max]
+      })
+  }
+
+  return requestProperties
+}

package/src/reportWebEvent/vehicle_fields.ts

@@ -0,0 +1,255 @@
+import { InputField } from '@segment/actions-core'
+import { VEHICLE_FIELDS } from '../constants'
+
+export const vehicle_fields: InputField = {
+  label: 'Vehicle Fields',
+  type: 'object',
+  description: 'Fields related to vehicle events.',
+  additionalProperties: false,
+  defaultObjectUI: 'keyvalue',
+  properties: {
+    postal_code: {
+      label: 'Postal Code',
+      type: 'string',
+      description: 'Postal code for the vehicle location.'
+    },
+    make: {
+      label: 'Make of the Vehicle',
+      type: 'string',
+      description: 'Vehicle make/brand/manufacturer.'
+    },
+    model: {
+      label: 'Model of the Vehicle',
+      type: 'string',
+      description: 'Vehicle model.'
+    },
+    year: {
+      label: 'Year of the Vehicle',
+      type: 'number',
+      description: 'Year the vehicle was laucned in yyyy format.'
+    },
+    state_of_vehicle: {
+      label: 'State of the Vehicle',
+      type: 'string',
+      description: 'Vehicle status.',
+      choices: [
+        { value: 'New', label: 'New' },
+        { value: 'Used', label: 'Used' },
+        { value: 'CPO', label: 'CPO' }
+      ]
+    },
+    mileage_value: {
+      label: 'Mileage Value',
+      type: 'number',
+      description: 'Vehicle mileage (in km or miles). Zero (0) for new vehicle.'
+    },
+    mileage_unit: {
+      label: 'Mileage Unit',
+      type: 'string',
+      description: 'Mileage unites in miles (MI) or kilometers (KM).',
+      choices: [
+        { value: 'MI', label: 'Miles' },
+        { value: 'KM', label: 'Kilometers' }
+      ]
+    },
+    exterior_color: {
+      label: 'Exterior Color of the Vehicle',
+      type: 'string',
+      description: 'Vehicle exterior color.'
+    },
+    transmission: {
+      label: 'Transmission Type of the Vehicle',
+      type: 'string',
+      description: 'Vehicle transmission type.',
+      choices: [
+        { value: 'Automatic', label: 'Automatic' },
+        { value: 'Manual', label: 'Manual' },
+        { value: 'Other', label: 'Other' }
+      ]
+    },
+    body_style: {
+      label: 'Body Type of the Vehicle',
+      type: 'string',
+      description: 'Vehicle body type.',
+      choices: [
+        { value: 'Convertible', label: 'Convertible' },
+        { value: 'Coupe', label: 'Coupe' },
+        { value: 'Hatchback', label: 'Hatchback' },
+        { value: 'Minivan', label: 'Minivan' },
+        { value: 'Truck', label: 'Truck' },
+        { value: 'SUV', label: 'SUV' },
+        { value: 'Sedan', label: 'Sedan' },
+        { value: 'Van', label: 'Van' },
+        { value: 'Wagon', label: 'Wagon' },
+        { value: 'Crossover', label: 'Crossover' },
+        { value: 'Other', label: 'Other' }
+      ]
+    },
+    fuel_type: {
+      label: 'Fuel Type of the Vehicle',
+      type: 'string',
+      description: 'Vehicle fuel type.',
+      choices: [
+        { value: 'Diesel', label: 'Diesel' },
+        { value: 'Electric', label: 'Electric' },
+        { value: 'Flex', label: 'Flex' },
+        { value: 'Gasoline', label: 'Gasoline' },
+        { value: 'Hybrid', label: 'Hybrid' },
+        { value: 'Other', label: 'Other' }
+      ]
+    },
+    drivetrain: {
+      label: 'Drivetrain of the Vehicle',
+      type: 'string',
+      description: 'Vehicle drivetrain.',
+      choices: [
+        { value: 'AWD', label: 'AWD' },
+        { value: 'FOUR_WD', label: 'Four WD' },
+        { value: 'FWD', label: 'FWD' },
+        { value: 'RWD', label: 'RWD' },
+        { value: 'TWO_WD', label: 'Two WD' },
+        { value: 'Other', label: 'Other' }
+      ]
+    },
+    preferred_price_range_min: {
+      label: 'Minimum Preferred Price',
+      type: 'number',
+      description: 'Minimum preferred price of the vehicle.'
+    },
+    preferred_price_range_max: {
+      label: 'Maximum Preferred Price',
+      type: 'number',
+      description: 'Maximum preferred price of the vehicle.'
+    },
+    trim: {
+      label: 'Trim of the Vehicle',
+      type: 'string',
+      description: 'Vehicle trim.'
+    },
+    vin: {
+      label: 'VIN of the Vehicle',
+      type: 'string',
+      description: 'Vehicle identification number. Maximum characters: 17.'
+    },
+    interior_color: {
+      label: 'Interior Color of the Vehicle',
+      type: 'string',
+      description: 'Vehicle interior color.'
+    },
+    condition_of_vehicle: {
+      label: 'Condition of the Vehicle',
+      type: 'string',
+      description: 'Vehicle drivetrain.',
+      choices: [
+        { value: 'Excellent', label: 'Excellent' },
+        { value: 'Good', label: 'Good' },
+        { value: 'Fair', label: 'Fair' },
+        { value: 'Poor', label: 'Poor' },
+        { value: 'Other', label: 'Other' }
+      ]
+    },
+    viewcontent_type: {
+      label: 'Soft Lead Landing Page',
+      type: 'string',
+      description: 'Optional for ViewContent. Use viewcontent_type to differentiate between soft lead landing pages.',
+      depends_on: {
+        match: 'any',
+        conditions: [{ fieldKey: 'event', operator: 'is', value: 'ViewContent' }]
+      }
+    },
+    search_type: {
+      label: 'Other Search Page',
+      type: 'string',
+      description:
+        'Optional for Search. Use search_type to differentiate other user searches (such as dealer lookup) from inventory search.',
+      depends_on: {
+        match: 'any',
+        conditions: [{ fieldKey: 'event', operator: 'is', value: 'Search' }]
+      }
+    },
+    registration_type: {
+      label: 'Other Registration Page',
+      type: 'string',
+      description:
+        'Optional for CompleteRegistration. Use registration_type to differentiate between different types of customer registration on websites.',
+      depends_on: {
+        match: 'any',
+        conditions: [{ fieldKey: 'event', operator: 'is', value: 'CompleteRegistration' }]
+      }
+    }
+  },
+  default: {
+    postal_code: {
+      '@path': '$.properties.postal_code'
+    },
+    make: {
+      '@path': '$.properties.make'
+    },
+    model: {
+      '@path': '$.properties.model'
+    },
+    year: {
+      '@path': '$.properties.year'
+    },
+    state_of_vehicle: {
+      '@path': '$.properties.state_of_vehicle'
+    },
+    mileage_value: {
+      '@path': '$.properties.mileage_value'
+    },
+    mileage_unit: {
+      '@path': '$.properties.mileage_unit'
+    },
+    exterior_color: {
+      '@path': '$.properties.exterior_color'
+    },
+    transmission: {
+      '@path': '$.properties.transmission'
+    },
+    body_style: {
+      '@path': '$.properties.body_style'
+    },
+    fuel_type: {
+      '@path': '$.properties.fuel_type'
+    },
+    drivetrain: {
+      '@path': '$.properties.drive_train'
+    },
+    preferred_price_range_min: {
+      '@path': '$.properties.preferred_price_range_min'
+    },
+    preferred_price_range_max: {
+      '@path': '$.properties.preferred_price_range_max'
+    },
+    trim: {
+      '@path': '$.properties.trim'
+    },
+    vin: {
+      '@path': '$.properties.vin'
+    },
+    interior_color: {
+      '@path': '$.properties.interior_color'
+    },
+    condition_of_vehicle: {
+      '@path': '$.properties.condition_of_vehicle'
+    },
+    viewcontent_type: {
+      '@path': '$.properties.viewcontent_type'
+    },
+    search_type: {
+      '@path': '$.properties.search_type'
+    },
+    registration_type: {
+      '@path': '$.properties.registration_type'
+    }
+  },
+  depends_on: {
+    conditions: [
+      {
+        fieldKey: 'event_spec_type',
+        operator: 'is',
+        value: VEHICLE_FIELDS
+      }
+    ]
+  }
+}