feat: consent field support for gaoc for API v15 and upgrade the api version from v14 to v16

src/constants/destinationCanonicalNames.js

@@ -152,6 +152,18 @@ const DestCanonicalNames = {
     'the trade desk',
   ],
   INTERCOM: ['INTERCOM', 'intercom', 'Intercom'],
+  GOOGLE_ADWORDS_REMARKETING_LISTS: [
+    'GOOGLE_ADWORDS_REMARKETING_LISTS',
+    'google_adwords_remarketing_lists',
+    'Google Adwords Remarketing Lists',
+    'google adwords remarketing lists',
+  ],
+  GOOGLE_ADWORDS_OFFLINE_CONVERSIONS: [
+    'GOOGLE_ADWORDS_OFFLINE_CONVERSIONS',
+    'google_adwords_offline_conversions',
+    'Google Adwords Offline Conversions',
+    'google adwords offline conversions',
+  ],
 };
 
 module.exports = { DestHandlerMap, DestCanonicalNames };

src/v0/destinations/google_adwords_offline_conversions/config.js

@@ -1,6 +1,6 @@
 const { getMappingConfig } = require('../../util');
 
-const API_VERSION = 'v14';
+const API_VERSION = 'v15';
 
 const BASE_ENDPOINT = `https://googleads.googleapis.com/${API_VERSION}/customers/:customerId`;
 

src/v0/destinations/google_adwords_offline_conversions/transform.js

@@ -22,6 +22,7 @@ const {
   getStoreConversionPayload,
   requestBuilder,
   getClickConversionPayloadAndEndpoint,
+  populateConsentForGoogleDestinations,
 } = require('./utils');
 const helper = require('./helper');
 
@@ -59,7 +60,20 @@ const getConversions = (message, metadata, { Config }, event, conversionType) =>
     payload = constructPayload(message, trackCallConversionsMapping);
     endpoint = CALL_CONVERSION.replace(':customerId', filteredCustomerId);
   }
-
+  const consentObject = populateConsentForGoogleDestinations(message, conversionType);
+  if (Object.keys(consentObject)?.length > 0) {
+    if (payload?.conversions?.length > 0) {
+      if (conversionType === 'click' || conversionType === 'call') {
+        payload.conversions[0].consent = consentObject;
+      }
+    } else if (
+      Object.keys(payload?.addConversionPayload?.operations?.create)?.length > 0 &&
+      conversionType === 'store'
+    ) {
+      payload.addConversionPayload.operations.create.consent = consentObject;
+    }
+  }
+
   if (conversionType !== 'store') {
     // transform originalTimestamp to conversionDateTime format (yyyy-mm-dd hh:mm:ss+|-hh:mm)
     // e.g 2019-10-14T11:15:18.299Z -> 2019-10-14 16:10:29+0530

src/v0/destinations/google_adwords_offline_conversions/utils.js

@@ -17,6 +17,7 @@
   isDefinedAndNotNull,
   getAuthErrCategoryFromStCode,
   getAccessToken,
+  getIntegrationsObj,
 } = require('../../util');
 const {
   SEARCH_STREAM,
@@ -65,7 +66,7 @@
       feature: 'transformation',
       endpointPath: `/googleAds:searchStream`,
       requestMethod: 'POST',
-      module: 'dataDelivery'
+      module: 'dataDelivery',
     });
     searchStreamResponse = processAxiosResponse(searchStreamResponse);
     if (!isHttpStatusSuccess(searchStreamResponse.status)) {
@@ -362,6 +363,55 @@
   return { payload, endpoint };
 };
 
+const GOOGLE_ALLOWED_CONSENT_STATUS = ['UNSPECIFIED', 'UNKNOWN', 'GRANTED', 'DENIED'];
+
+/**
+ * Populates the consent object based on the provided properties.
+ *
+ * @param {object} properties - message.properties containing properties related to consent.
+ * @returns {object} - An object containing consent information.
+ *  * ref :
+ * 1) For click conversion :
+ *  a) https://developers.google.com/google-ads/api/rest/reference/rest/v15/customers/uploadClickConversions#ClickConversion
+ *  b) https://developers.google.com/google-ads/api/reference/rpc/v15/ClickConversion#consent
+ * 2) For Call conversion :
+ *  a) https://developers.google.com/google-ads/api/rest/reference/rest/v15/customers/uploadCallConversions#CallConversion
+ *  b) https://developers.google.com/google-ads/api/reference/rpc/v15/CallConversion#consent
+ * 3) For Store sales conversion :
+ *  a) https://developers.google.com/google-ads/api/reference/rpc/v15/UserData
+ *  b) https://developers.google.com/google-ads/api/reference/rpc/v15/UserData#consent
+ */
+
+const populateConsentForGoogleDestinations = (message) => {
+  const integrationObj = getIntegrationsObj(message, 'GOOGLE_ADWORDS_OFFLINE_CONVERSIONS') || {};
+  const consents = integrationObj.consents || {};
+
+  // Define a function to process consent based on type
+  const processConsent = (consentType) => {
+    if (!consents[consentType]) return 'UNSPECIFIED';
+    if (GOOGLE_ALLOWED_CONSENT_STATUS.includes(consents[consentType])) {
+      return consents[consentType];
+    }
+    return 'UNKNOWN';
+  };
+
+  // Common consent fields to process
+  const consentFields = {
+    adUserData: 'adUserData',
+    adPersonalization: 'adPersonalization',
+  };
+
+  // Construct consentObj based on the common consent fields
+  const consentObj = Object.keys(consentFields).reduce((obj, consentType) => {
+    const key = consentFields[consentType];
+    // eslint-disable-next-line no-param-reassign
+    obj[key] = processConsent(consentType);
+    return obj;
+  }, {});
+
+  return consentObj;
+};
+
 module.exports = {
   validateDestinationConfig,
   generateItemListFromProducts,
@@ -372,4 +422,5 @@
   buildAndGetAddress,
   getClickConversionPayloadAndEndpoint,
   getExisitingUserIdentifier,
+  populateConsentForGoogleDestinations,
 };

src/v0/destinations/google_adwords_offline_conversions/utils.test.js

@@ -2,6 +2,7 @@ const {
   getClickConversionPayloadAndEndpoint,
   buildAndGetAddress,
   getExisitingUserIdentifier,
+  populateConsentForGoogleDestinations,
 } = require('./utils');
 
 const getTestMessage = () => {
@@ -161,7 +162,7 @@ describe('getExisitingUserIdentifier util tests', () => {
 describe('getClickConversionPayloadAndEndpoint util tests', () => {
   it('getClickConversionPayloadAndEndpoint flow check when default field identifier is present', () => {
     let expectedOutput = {
-      endpoint: 'https://googleads.googleapis.com/v14/customers/9625812972:uploadClickConversions',
+      endpoint: 'https://googleads.googleapis.com/v15/customers/9625812972:uploadClickConversions',
       payload: {
         conversions: [
           {
@@ -187,7 +188,7 @@ describe('getClickConversionPayloadAndEndpoint util tests', () => {
     delete fittingPayload.traits.email;
     delete fittingPayload.properties.email;
     let expectedOutput = {
-      endpoint: 'https://googleads.googleapis.com/v14/customers/9625812972:uploadClickConversions',
+      endpoint: 'https://googleads.googleapis.com/v15/customers/9625812972:uploadClickConversions',
       payload: {
         conversions: [
           {
@@ -215,7 +216,7 @@ describe('getClickConversionPayloadAndEndpoint util tests', () => {
     delete fittingPayload.traits.phone;
     delete fittingPayload.properties.email;
     let expectedOutput = {
-      endpoint: 'https://googleads.googleapis.com/v14/customers/9625812972:uploadClickConversions',
+      endpoint: 'https://googleads.googleapis.com/v15/customers/9625812972:uploadClickConversions',
       payload: {
         conversions: [
           {
@@ -251,7 +252,7 @@ describe('getClickConversionPayloadAndEndpoint util tests', () => {
       },
     ];
     let expectedOutput = {
-      endpoint: 'https://googleads.googleapis.com/v14/customers/9625812972:uploadClickConversions',
+      endpoint: 'https://googleads.googleapis.com/v15/customers/9625812972:uploadClickConversions',
       payload: {
         conversions: [
           {
@@ -273,3 +274,97 @@ describe('getClickConversionPayloadAndEndpoint util tests', () => {
     );
   });
 });
+
+describe('populateConsentForGoogleDestinations', () => {
+  // Returns an object with adUserData and adPersonalization properties set to UNSPECIFIED when no consents are provided
+  it('GOOGLE_ADWORDS_OFFLINE_CONVERSIONS : store sales conversion without any mention in integrations object', () => {
+    const message = {};
+    const conversionType = 'store';
+
+    const result = populateConsentForGoogleDestinations(message, conversionType);
+
+    expect(result).toEqual({
+      adUserData: 'UNSPECIFIED',
+      adPersonalization: 'UNSPECIFIED',
+    });
+  });
+
+  // Returns an empty object when the destination name is not recognized
+  it('GOOGLE_ADWORDS_OFFLINE_CONVERSIONS: store sales conversions with integrations object', () => {
+    const message = {
+      integrations: {
+        google_adwords_offline_conversions: {
+          consents: {
+            adUserData: 'GRANTED',
+            adPersonalization: 'DENIED',
+          },
+        },
+      },
+    };
+    const conversionType = 'store';
+
+    const result = populateConsentForGoogleDestinations(message, conversionType);
+
+    expect(result).toEqual({
+      adPersonalization: 'DENIED',
+      adUserData: 'GRANTED',
+    });
+  });
+
+  // Returns an object with adUserData and adPersonalization properties set to the provided consents when they are valid and present in the message properties
+  it('GOOGLE_ADWORDS_OFFLINE_CONVERSIONS: click conversion with integration object of allowed types', () => {
+    const message = {
+      integrations: {
+        google_adwords_offline_conversions: {
+          consents: {
+            adUserData: 'GRANTED',
+            adPersonalization: 'DENIED',
+          },
+        },
+      },
+    };
+    const conversionType = 'click';
+
+    const result = populateConsentForGoogleDestinations(message, conversionType);
+
+    expect(result).toEqual({
+      adUserData: 'GRANTED',
+      adPersonalization: 'DENIED',
+    });
+  });
+
+  // Returns an object with adUserData and adPersonalization properties set to UNSPECIFIED when the provided consents are not valid or not present in the message properties
+  it('GOOGLE_ADWORDS_OFFLINE_CONVERSIONS : click conversion with invalid consent value', () => {
+    const message = {
+      integrations: {
+        google_adwords_offline_conversions: {
+          consents: {
+            adUserData: 'GRANTED',
+            adPersonalization: 'INVALID',
+          },
+        },
+      },
+    };
+    const conversionType = 'click';
+
+    const result = populateConsentForGoogleDestinations(message, conversionType);
+
+    expect(result).toEqual({
+      adUserData: 'GRANTED',
+      adPersonalization: 'UNKNOWN',
+    });
+  });
+
+  // Returns an empty object when the integration object is not present in the message
+  it('GOOGLE_ADWORDS_OFFLINE_CONVERSIONS : call conversion without integrations object consent ', () => {
+    const message = {};
+    const conversionType = 'call';
+
+    const result = populateConsentForGoogleDestinations(message, conversionType);
+
+    expect(result).toEqual({
+      adUserData: 'UNSPECIFIED',
+      adPersonalization: 'UNSPECIFIED',
+    });
+  });
+});

src/v0/destinations/google_adwords_remarketing_lists/networkHandler.js

@@ -23,9 +23,6 @@ const createJob = async (endpoint, headers, method, params) => {
   const customerMatchUserListMetadata = {
     userList: `customers/${params.customerId}/userLists/${params.listId}`,
   };
-  if (Object.keys(params.consent).length > 0) {
-    customerMatchUserListMetadata.consent = params.consent;
-  }
   const jobCreatingRequest = {
     url: jobCreatingUrl,
     data: {

src/v0/destinations/google_adwords_remarketing_lists/transform.js

@@ -15,8 +15,6 @@ const {
   getAccessToken,
 } = require('../../util');
 
-const { populateConsentForGoogleDestinations } = require('../../util/googleUtils');
-
 const {
   offlineDataJobsMapping,
   addressInfoMapping,
@@ -218,8 +216,7 @@ const processEvent = async (metadata, message, destination) => {
     }
 
     Object.values(createdPayload).forEach((data) => {
-      const consentObj = populateConsentForGoogleDestinations(message.properties);
-      response.push(responseBuilder(metadata, data, destination, message, consentObj));
+      response.push(responseBuilder(metadata, data, destination, message));
     });
     return response;
   }