(R2.1f) Google tag enhanced conversion

src/Google/GlobalSiteTag.php

@@ -24,6 +24,7 @@
 use Automattic\WooCommerce\GoogleListingsAndAds\Proxies\WP;
 use Automattic\WooCommerce\GoogleListingsAndAds\Value\BuiltScriptDependencyArray;
 use WC_Product;
+use WC_Customer;
 
 defined( 'ABSPATH' ) || exit;
 
@@ -224,12 +225,13 @@
 				);
 			} else {
 				// Legacy code to support Google Analytics for WooCommerce version < 2.0.0.
+				$config = wp_json_encode( $this->get_config_object() );
 				add_filter(
 					'woocommerce_gtag_snippet',
-					function ( $gtag_snippet ) use ( $ads_conversion_id ) {
+					function ( $gtag_snippet ) use ( $ads_conversion_id, $config ) {
 						return preg_replace(
 							'~(\s)</script>~',
-							"\tgtag('config', '" . $ads_conversion_id . "', { 'groups': 'GLA', 'send_page_view': false });\n$1</script>",
+							"\tgtag('config', '" . $ads_conversion_id . "', $config);\n$1</script>",
 							$gtag_snippet
 						);
 					}
@@ -277,9 +279,11 @@
 	 * @param string $ads_conversion_id Google Ads account conversion ID.
 	 */
 	protected function get_gtag_config( string $ads_conversion_id ) {
+		$config = $this->get_config_object();
 		return sprintf(
-			'gtag("config", "%1$s", { "groups": "GLA", "send_page_view": false });',
-			esc_js( $ads_conversion_id )
+			'gtag("config", "%1$s", %2$s);',
+			esc_js( $ads_conversion_id ),
+			wp_json_encode( $config )
 		);
 	}
 
@@ -344,6 +348,73 @@
 		$order->update_meta_data( self::ORDER_CONVERSION_META_KEY, 1 );
 		$order->save_meta_data();
 
+		// Prepare and enqueue the enhanced conversion data, if enabled.
+		if ( $this->is_enhanced_conversion_enabled() ) {
+			// Enhanced conversion data.
+			$ec_data         = [];
+			$email           = $order->get_billing_email();
+			$fname           = $order->get_billing_first_name();
+			$lname           = $order->get_billing_last_name();
+			$phone           = $order->get_billing_phone();
+			$billing_address = $order->get_billing_address_1();
+			$postcode        = $order->get_billing_postcode();
+			$city            = $order->get_billing_city();
+			$region          = $order->get_billing_state();
+			$country         = $order->get_billing_country();
+
+			// Add email in EC data.
+			if ( ! empty( $email ) ) {
+				$normalized_email = strtolower( $email );
+				$email_parts      = explode( '@', $normalized_email );
+
+				if ( count( $email_parts ) > 1 && preg_match( '/^(gmail|googlemail)\.com\s*/', $email_parts[1] ) ) {
+					$email_parts[0]   = str_replace( '.', '', $email_parts[0] );
+					$normalized_email = sprintf( '%s@%s', $email_parts[0], $email_parts[1] );
+				}
+
+				$ec_data['sha256_email_address'] = $this->normalize_and_hash( $normalized_email );
+			}
+
+			// Format phone number in IE64.
+			$phone        = preg_replace( '/[^0-9]/', '', $phone );
+			$phone_length = strlen( $phone );
+			if ( $phone_length > 9 && $phone_length < 14 ) {
+				$phone                          = sprintf( '%s%d', '+', $phone );
+				$ec_data['sha256_phone_number'] = $this->normalize_and_hash( $phone );
+			}
+
+			// Check for required address fields.
+			if ( ! empty( $fname ) && ! empty( $lname ) && ! empty( $postcode ) && ! empty( $country ) ) {
+				$ec_data['address']['sha256_first_name'] = $this->normalize_and_hash( $fname );
+				$ec_data['address']['sha256_last_name']  = $this->normalize_and_hash( $lname );
+				$ec_data['address']['postal_code']       = $postcode;
+				$ec_data['address']['country']           = $country;
+
+				/**
+				 * Add additional data, if present.
+				 */
+
+				// Add street address.
+				if ( ! empty( $billing_address ) ) {
+					$ec_data['address']['street'] = $billing_address;
+				}
+
+				// Add city.
+				if ( ! empty( $city ) ) {
+					$ec_data['address']['city'] = $city;
+				}
+
+				// Add region.
+				if ( ! empty( $region ) ) {
+					$ec_data['address']['region'] = $region;
+				}
+			}
+
+			$purchase_user_data_gtag = sprintf( 'gtag("set", "user_data", %s)', wp_json_encode( $ec_data ) );
+
+			$this->add_inline_event_script( $purchase_user_data_gtag );
+		}
+
 		$conversion_gtag_info =
 		sprintf(
 			'gtag("event", "conversion", {
@@ -417,6 +488,7 @@
 			esc_js( $language ),
 			join( ',', $item_info ),
 		);
+
 		$this->add_inline_event_script( $purchase_page_gtag );
 	}
 
@@ -583,4 +655,62 @@
 			false
 		);
 	}
+
+	/**
+	 * Get the config object for Google tag.
+	 *
+	 * @return array
+	 */
+	private function get_config_object(): array {
+		// Standard config.
+		$config = [
+			'groups'         => 'GLA',
+			'send_page_view' => false,
+		];
+
+		// Check if enhanced conversion is enabled.
+		if ( $this->is_enhanced_conversion_enabled() ) {
+			$config['allow_enhanced_conversions'] = true;
+		}
+
+		return $config;
+	}
+
+	/**
+	 * Checks if enhanced conversion is enabled.
+	 *
+	 * @return bool
+	 */
+	private function is_enhanced_conversion_enabled(): bool {
+		// Check if enhanced conversion is enabled.
+		$enhanced_conversion_status = $this->options->get( OptionsInterface::ADS_ENHANCED_CONVERSION_STATUS, null );
+		return ( 'enabled' === $enhanced_conversion_status );
+	}
+
+	/**
+	 * Return the hashed data to be sent to Google Ads for enhanced conversion.
+	 *
+	 * @param string $value Data that needs to be hashed.
+	 * @param string $algo  Algorithm for hashing.
+	 * @param bool   $trim_intermediate_spaces Whether to trim intermediate spaces in values. Default true.
+	 *
+	 * @return string
+	 */
+	private function normalize_and_hash( string $value, $algo = 'sha256', bool $trim_intermediate_spaces = true ): string {
+		if ( empty( $value ) ) {
+			return '';
+		}
+
+		// Convert case to lowercase.
+		$normalized_value = strtolower( $value );
+
+		if ( $trim_intermediate_spaces ) {
+			$normalized_value = str_replace( ' ', '', $normalized_value );
+		} else {
+			// Remove leading and trailing whitespaces.
+			$normalized_value = trim( $normalized_value );
+		}
+
+		return hash( $algo, strtolower( trim( $normalized_value ) ) );
+	}
 }

tests/e2e/specs/gtag-events/gtag-events.test.js

@@ -10,6 +10,8 @@ import {
 	createSimpleProduct,
 	setConversionID,
 	clearConversionID,
+	enableEnhancedConversions,
+	disableEnhancedConversions,
 } from '../../utils/api';
 import {
 	blockProductAddToCart,
@@ -18,7 +20,11 @@ import {
 	singleProductAddToCart,
 } from '../../utils/customer';
 import { createBlockShopPage } from '../../utils/block-page';
-import { getEventData, trackGtagEvent } from '../../utils/track-event';
+import {
+	getEventData,
+	trackGtagEvent,
+	getDataLayerValue,
+} from '../../utils/track-event';
 
 const config = require( '../../config/default' );
 const productPrice = config.products.simple.regularPrice;
@@ -28,6 +34,7 @@ let simpleProductID;
 test.describe( 'GTag events', () => {
 	test.beforeAll( async () => {
 		await setConversionID();
+		await enableEnhancedConversions();
 		simpleProductID = await createSimpleProduct();
 	} );
 
@@ -192,4 +199,43 @@ test.describe( 'GTag events', () => {
 			expect( data.country ).toEqual( 'US' );
 		} );
 	} );
+
+	test( 'User data for enhanced conversions are not sent when not enabled', async ( {
+		page,
+	} ) => {
+		await disableEnhancedConversions();
+		await singleProductAddToCart( page, simpleProductID );
+
+		await checkout( page );
+
+		const dataConfig = await getDataLayerValue( page, {
+			type: 'config',
+			key: 'AW-123456',
+		} );
+
+		expect( dataConfig ).toBeDefined();
+		expect( dataConfig.allow_enhanced_conversions ).toBeUndefined();
+	} );
+
+	test( 'User data for enhanced conversions is sent when enabled', async ( {
+		page,
+	} ) => {
+		await enableEnhancedConversions();
+		await singleProductAddToCart( page, simpleProductID );
+
+		await checkout( page );
+
+		const dataConfig = await getDataLayerValue( page, {
+			type: 'config',
+			key: 'AW-123456',
+		} );
+
+		const dataUserData = await getDataLayerValue( page, {
+			type: 'set',
+			key: 'user_data',
+		} );
+
+		expect( dataConfig.allow_enhanced_conversions ).toBeTruthy();
+		expect( dataUserData.sha256_email_address ).toBeDefined();
+	} );
 } );

tests/e2e/test-data/test-data.php

@@ -49,6 +49,22 @@ function register_routes() {
 			],
 		],
 	);
+	register_rest_route(
+		'wc/v3',
+		'gla-test/enhanced-conversions',
+		[
+			[
+				'methods'             => 'POST',
+				'callback'            => __NAMESPACE__ . '\enable_enhanced_conversions',
+				'permission_callback' => __NAMESPACE__ . '\permissions',
+			],
+			[
+				'methods'             => 'DELETE',
+				'callback'            => __NAMESPACE__ . '\disable_enhanced_conversions',
+				'permission_callback' => __NAMESPACE__ . '\permissions',
+			],
+		],
+	);
 }
 
 /**
@@ -107,6 +123,30 @@ function clear_conversion_id() {
 	$options->delete( OptionsInterface::ADS_CONVERSION_ACTION );
 }
 
+/**
+ * Enable enhanced conversions.
+ */
+function enable_enhanced_conversions() {
+	/** @var OptionsInterface $options */
+	$options = woogle_get_container()->get( OptionsInterface::class );
+	$options->update(
+		OptionsInterface::ADS_ENHANCED_CONVERSION_STATUS,
+		'enabled'
+	);
+}
+
+/**
+ * Disable enhanced conversions.
+ */
+function disable_enhanced_conversions() {
+	/** @var OptionsInterface $options */
+	$options = woogle_get_container()->get( OptionsInterface::class );
+	$options->update(
+		OptionsInterface::ADS_ENHANCED_CONVERSION_STATUS,
+		'disabled'
+	);
+}
+
 /**
  * Check permissions for API requests.
  */

tests/e2e/utils/api.js

@@ -75,3 +75,17 @@ export async function setOnboardedMerchant() {
 export async function clearOnboardedMerchant() {
 	await api().delete( 'gla-test/onboarded-merchant' );
 }
+
+/**
+ * Enable Enhanced Conversions.
+ */
+export async function enableEnhancedConversions() {
+	await api().post( 'gla-test/enhanced-conversions' );
+}
+
+/**
+ * Disable Enhanced Conversions.
+ */
+export async function disableEnhancedConversions() {
+	await api().delete( 'gla-test/enhanced-conversions' );
+}

tests/e2e/utils/track-event.js

@@ -59,3 +59,19 @@ export function getEventData( request ) {
 
 	return data;
 }
+
+/**
+ * Find a value in the dataLayer
+ *
+ * @param {Page} page
+ * @param {Object} args The type and key to search for.
+ */
+export function getDataLayerValue( page, args ) {
+	return page.evaluate( ( { type, key } ) => {
+		return (
+			window.dataLayer.find(
+				( item ) => item[ 0 ] === type && item[ 1 ] === key
+			)[ 2 ] ?? null
+		);
+	}, args );
+}