conversion: explicit event params, removes any in PixelControl

This commit is contained in:
Elijah Duffy
2025-12-18 18:44:33 -08:00
parent fc07bb057c
commit f5ec7b3812
6 changed files with 146 additions and 55 deletions

View File

@@ -1,6 +1,7 @@
import type { TrackingManager } from '$lib/tracking.svelte';
import type {
ConversionErrorResponseBody,
ConversionEventParams,
ConversionRequestBody,
ConversionResponseBody,
ConversionUserData
@@ -37,7 +38,7 @@ export class ConversionClient {
options: {
eventID: string;
user?: Omit<ConversionUserData, 'ip' | 'fbp' | 'fbc' | 'ua'>;
customData?: Record<string, string>;
customData?: ConversionEventParams;
}
): Promise<ConversionResponseBody | ConversionErrorResponseBody> {
// Extract user data

View File

@@ -1,6 +1,17 @@
import { CustomData, EventRequest, ServerEvent, UserData } from 'facebook-nodejs-business-sdk';
import {
Content,
CustomData,
EventRequest,
ServerEvent,
UserData
} from 'facebook-nodejs-business-sdk';
import type { StandardEventName } from '../types/fbq.js';
import type { ConversionResponseBody, ConversionUserData } from '$lib/types/conversion.js';
import type {
ConversionEventDetails,
ConversionEventParams,
ConversionResponseBody,
ConversionUserData
} from '$lib/types/conversion.js';
import { dev } from '$app/environment';
import log from 'loglevel';
@@ -10,7 +21,7 @@ import log from 'loglevel';
* @param data - The user data to include.
* @returns The constructed UserData object.
*/
export const buildConversionUserData = (data: ConversionUserData): UserData => {
const buildUserData = (data: ConversionUserData): UserData => {
const userData = new UserData();
if (data.email) userData.setEmail(data.email);
if (data.phone) userData.setPhone(data.phone);
@@ -30,40 +41,41 @@ export const buildConversionUserData = (data: ConversionUserData): UserData => {
* @param params - The custom data parameters.
* @returns The constructed CustomData object.
*/
export const buildCustomData = (params: Record<string, string>): CustomData => {
const buildCustomData = (params: ConversionEventParams): CustomData => {
const c = new CustomData();
// Map known fields safely
if (params.value) c.setValue(params.value);
if (params.net_revenue) c.setNetRevenue(params.net_revenue);
if (params.currency) c.setCurrency(params.currency);
if (typeof params.value === 'number') c.setValue(params.value);
if (Array.isArray(params.contents)) c.setContents(params.contents);
if (params.content_name) c.setContentName(params.content_name);
if (params.content_category) c.setContentCategory(params.content_category);
if (params.content_ids) c.setContentIds(params.content_ids);
if (params.contents) {
const contents: Content[] = params.contents.map((content) => {
const c = new Content();
if (content.id) c.setId(content.id.toString());
if (content.quantity) c.setQuantity(content.quantity);
if (content.item_price) c.setItemPrice(content.item_price);
if (content.title) c.setTitle(content.title);
if (content.description) c.setDescription(content.description);
if (content.category) c.setCategory(content.category);
if (content.brand) c.setBrand(content.brand);
if (content.delivery_category) c.setDeliveryCategory(content.delivery_category);
return c;
});
c.setContents(contents);
}
if (params.content_type) c.setContentType(params.content_type);
if (Array.isArray(params.content_ids)) c.setContentIds(params.content_ids);
if (typeof params.num_items === 'number') c.setNumItems(params.num_items);
if (params.order_id) c.setOrderId(params.order_id);
if (params.predicted_ltv) c.setPredictedLtv(params.predicted_ltv);
if (params.num_items) c.setNumItems(params.num_items);
if (params.search_string) c.setSearchString(params.search_string);
// Attach anything else as custom_properties
const extras = { ...params };
delete extras.currency;
delete extras.value;
delete extras.contents;
delete extras.content_type;
delete extras.content_ids;
delete extras.num_items;
delete extras.search_string;
if (Object.keys(extras).length) c.setCustomProperties(extras);
if (params.status) c.setStatus(params.status);
if (params.item_number) c.setItemNumber(params.item_number);
if (params.delivery_category) c.setDeliveryCategory(params.delivery_category);
if (params.custom_properties) c.setCustomProperties(params.custom_properties);
return c;
};
/**
* Parameters for sending a conversion event to Meta Pixel.
*/
export type ConversionEventOptions = {
eventID: string;
actionSource: 'website' | 'app' | 'offline' | 'other';
userData: UserData;
customData?: CustomData;
eventSourceURL?: string;
};
/**
* Control class for sending Conversion API events to Meta Pixel.
*/
@@ -95,17 +107,21 @@ export class ConversionControl {
*/
async trackEvent(
eventName: StandardEventName,
options: ConversionEventOptions
details: ConversionEventDetails,
params?: ConversionEventParams
): Promise<ConversionResponseBody> {
const event = new ServerEvent()
.setEventName(eventName)
.setEventTime(Math.floor(Date.now() / 1000))
.setEventId(options.eventID)
.setUserData(options.userData)
.setActionSource(options.actionSource);
.setEventId(details.eventID)
.setUserData(buildUserData(details.userData))
.setActionSource(details.actionSource);
if (options?.eventSourceURL) event.setEventSourceUrl(options.eventSourceURL);
if (options?.customData) event.setCustomData(options.customData);
if (details?.eventSourceURL) event.setEventSourceUrl(details.eventSourceURL);
if (params) {
const customData = buildCustomData(params);
event.setCustomData(customData);
}
// If we're in dev mode and missing a test event code, log and exit
if (dev && !this._testEventCode) {

View File

@@ -1,6 +1,11 @@
import { json, type RequestHandler } from '@sveltejs/kit';
import { buildConversionUserData, buildCustomData, ConversionControl } from './control.ts';
import type { ConversionErrorResponseBody, ConversionRequestBody } from '$lib/types/conversion.js';
import { ConversionControl } from './control.ts';
import type {
ConversionErrorResponseBody,
ConversionEventParams,
ConversionRequestBody,
ConversionUserData
} from '$lib/types/conversion.js';
import { StatusCodes } from 'http-status-codes';
@@ -29,32 +34,33 @@ export const createConversionRequestHandler: (control: ConversionControl) => Req
const ip = getEventIP(request, getClientAddress);
const ua = request.headers.get('user-agent');
const userData = buildConversionUserData({
const userData: ConversionUserData = {
...body.user,
ip,
ua: ua ?? body.user?.ua ?? undefined
});
};
// Build custom data with UTM params if applicable
let rawCustomData = body.customData ?? {};
let customData: ConversionEventParams = body.customData ?? {};
if (body.eventName === 'PageView' && body.utms) {
// For PageView events, automatically include UTM params if provided
rawCustomData = {
...rawCustomData,
customData = {
...customData,
...body.utms
};
}
const customData = buildCustomData(rawCustomData);
// Send the event via the control
const response = await control.trackEvent(body.eventName, {
eventID: body.eventID,
eventSourceURL: body.eventSourceURL,
actionSource: 'website',
userData,
const response = await control.trackEvent(
body.eventName,
{
eventID: body.eventID,
eventSourceURL: body.eventSourceURL,
actionSource: 'website',
userData
},
customData
});
);
return json(response, { status: StatusCodes.OK });
} catch (e) {