File size: 3,218 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
import { getCurrentUser } from '@automattic/calypso-analytics';
import { clone, cloneDeep } from 'lodash';
import { mayWeTrackByTracker } from '../tracker-buckets';
import { debug, TRACKING_IDS } from './constants';
import { loadTrackingScripts } from './load-tracking-scripts';
// Ensure setup has run.
import './setup';
/**
* Records an event in Criteo
* @param {string} eventName - The name of the 'event' property such as 'viewItem' or 'viewBasket'
* @param {Record<string, any>} eventProps - Additional details about the event such as `{ item: '1' }`
* @returns {void}
*/
export async function recordInCriteo( eventName, eventProps ) {
if ( ! mayWeTrackByTracker( 'criteo' ) ) {
debug( 'recordInCriteo: [Skipping] ad tracking is not allowed' );
return;
}
await loadTrackingScripts();
const events = [];
const currentUser = getCurrentUser();
events.push( { event: 'setAccount', account: TRACKING_IDS.criteo } );
events.push( { event: 'setSiteType', type: criteoSiteType() } );
if ( currentUser ) {
events.push( { event: 'setEmail', email: [ currentUser.hashedPii.email ] } );
}
const conversionEvent = clone( eventProps );
conversionEvent.event = eventName;
events.push( conversionEvent );
// The deep clone is necessary because the Criteo script modifies the objects in the
// array which causes the console to display different data than is originally added
debug( 'recordInCriteo: ' + eventName, cloneDeep( events ) );
window.criteo_q.push( ...events );
}
/**
* Records in Criteo that the visitor viewed the plans page
*/
export function recordPlansViewInCriteo() {
if ( ! mayWeTrackByTracker( 'criteo' ) ) {
return;
}
const params = [
'viewItem',
{
item: '1',
},
];
debug( 'recordPlansViewInCriteo:', params );
recordInCriteo( ...params );
}
/**
* Records that a user viewed the checkout page
* @param {Object} cart - cart as `ResponseCart` object
* @returns {void}
*/
export function recordViewCheckoutInCriteo( cart ) {
if ( ! mayWeTrackByTracker( 'criteo' ) ) {
return;
}
if ( cart.is_signup ) {
return;
}
// Note that unlike `recordOrderInCriteo` above, this doesn't include the order id
const params = [
'viewBasket',
{
currency: cart.currency,
item: cartToCriteoItems( cart ),
},
];
debug( 'recordViewCheckoutInCriteo:', params );
recordInCriteo( ...params );
}
/**
* Converts the products in a cart to the format Criteo expects for its `items` property
* @param {Object} cart - cart as `ResponseCart` object
* @returns {Array} - An array of items to include in the Criteo tracking call
*/
export function cartToCriteoItems( cart ) {
return cart.products.map( ( product ) => {
return {
id: product.product_id,
price: product.cost,
quantity: product.volume,
};
} );
}
/**
* Returns the site type value that Criteo expects
* Note: this logic was provided by Criteo and should not be modified
* @returns {string} 't', 'm', or 'd' for tablet, mobile, or desktop
*/
function criteoSiteType() {
if ( /iPad/.test( window.navigator.userAgent ) ) {
return 't';
}
if ( /Mobile|iP(hone|od)|Android|BlackBerry|IEMobile|Silk/.test( window.navigator.userAgent ) ) {
return 'm';
}
return 'd';
}
|