STRATCONN-6602 - [Google Enhanced Conversions] - journeys v2 support

Author: joe-ayoub-segment

packages/destination-actions/src/destinations/google-enhanced-conversions/functions.ts

@@ -568,23 +568,44 @@ const extractUserIdentifiers = (
   }
   // Map user data to Google Ads API format
   for (const payload of payloads) {
+    const engageAudienceMembership = getEngageAudienceMembership(payload)
+
     if (
       payload.event_name === 'Audience Entered' ||
       syncMode === 'add' ||
-      (syncMode === 'mirror' && payload.event_name === 'new')
+      (syncMode === 'mirror' && payload.event_name === 'new') ||
+      (syncMode === 'mirror' && engageAudienceMembership === true)
     ) {
       addUserIdentifiers.push({ create: { userIdentifiers: identifierFunctions[idType](payload) } })
     } else if (
       payload.event_name === 'Audience Exited' ||
       syncMode === 'delete' ||
-      (syncMode === 'mirror' && payload.event_name === 'deleted')
+      (syncMode === 'mirror' && payload.event_name === 'deleted') ||
+      (syncMode === 'mirror' && engageAudienceMembership === false)
     ) {
       removeUserIdentifiers.push({ remove: { userIdentifiers: identifierFunctions[idType](payload) } })
     }
   }
   return [addUserIdentifiers, removeUserIdentifiers]
 }
 
+const getEngageAudienceMembership = (payload: UserListPayload): boolean | undefined => {
+  const {
+    engage_fields: { traits_or_properties = undefined, audience_key = undefined, computation_class = undefined } = {}
+  } = payload
+
+  const engageAudienceMembership =
+    typeof computation_class === 'string' &&
+    ['audience', 'journey_step'].includes(computation_class) &&
+    typeof audience_key === 'string' &&
+    typeof traits_or_properties === 'object' &&
+    typeof traits_or_properties[audience_key] === 'boolean'
+      ? traits_or_properties[audience_key]
+      : undefined
+
+  return engageAudienceMembership
+}
+
 const createOfflineUserJob = async (
   request: RequestClient,
   offlineUserJobPayload: OfflineUserJobPayload,
@@ -966,16 +987,20 @@ const extractBatchUserIdentifiers = (
 
 // Helper function to determine operation type
 const determineOperationType = (payload: UserListPayload, syncMode?: string) => {
+  const engageAudienceMembership = getEngageAudienceMembership(payload)
+
   if (
     payload.event_name === 'Audience Entered' ||
     syncMode === 'add' ||
-    (syncMode === 'mirror' && payload.event_name === 'new')
+    (syncMode === 'mirror' && payload.event_name === 'new') ||
+    (syncMode === 'mirror' && engageAudienceMembership === true)
   ) {
     return 'add'
   } else if (
     payload.event_name === 'Audience Exited' ||
     syncMode === 'delete' ||
-    (syncMode === 'mirror' && payload.event_name === 'deleted')
+    (syncMode === 'mirror' && payload.event_name === 'deleted') ||
+    (syncMode === 'mirror' && engageAudienceMembership === false)
   ) {
     return 'remove'
   }

packages/destination-actions/src/destinations/google-enhanced-conversions/userList/generated-types.ts

@@ -19,7 +19,7 @@ const action: ActionDefinition<Settings, Payload> = {
   syncMode: {
     description: 'Define how the records will be synced to Google',
     label: 'How to sync records',
-    default: 'add',
+    default: 'mirror',
     choices: [
       { label: 'Adds users to the connected Google Customer Match User List', value: 'add' },
       { label: 'Remove users from the connected Google Customer Match User List', value: 'delete' },
@@ -162,6 +162,47 @@ const action: ActionDefinition<Settings, Payload> = {
         '@path': '$.event'
       },
       unsafe_hidden: true
+    },
+    engage_fields: {
+      label: 'Engage Audience Fields',
+      description:
+        'Field used for processing an Engage Audience. Segment uses these fields to determine if the payload is generated from an Engage Audience and to extract the necessary information for audience syncing. If these fields are empty the "Sync Mode" field will be used to determine if the payload is from an Engage Audience.',
+      type: 'object',
+      required: false,
+      unsafe_hidden: true,
+      properties: {
+        traits_or_properties: {
+          label: 'Traits or Properties',
+          description: 'Field used for processing an Engage Audience.',
+          type: 'object'
+        },
+        audience_key: {
+          label: 'Segment Audience Key',
+          description: 'Field used for processing an Engage Audience.',
+          type: 'string'
+        },
+        computation_class: {
+          label: 'Segment Computation Action',
+          description:
+            "Field used to check if the payload is generated by an Engage Audience. values with 'audience' or 'journey_step' indicate an Engage audience.",
+          type: 'string'
+        }
+      },
+      default: {
+        traits_or_properties: {
+          '@if': {
+            exists: { '@path': '$.traits' },
+            then: { '@path': '$.traits' },
+            else: { '@path': '$.properties' }
+          }
+        },
+        audience_key: {
+          '@path': '$.context.personas.computation_key'
+        },
+        computation_class: {
+          '@path': '$.context.personas.computation_class'
+        }
+      }
     }
   },
   hooks: {