[Amazon CAPI] - adding validation and new setting field (#3682)

* adding validation and new setting field

* updating description

* updating new field description

Author: joe-ayoub-segment

packages/destination-actions/src/destinations/amazon-conversions-api/__tests__/index.test.ts

@@ -1,6 +1,7 @@
 // Basic test to confirm destination structure
 import Destination from '../index'
-import type { DestinationDefinition } from '@segment/actions-core'
+import type { DestinationDefinition, RequestClient } from '@segment/actions-core'
+import { Region } from '../types'
 
 describe('Amazon Conversions API Destination', () => {
   it('should be properly configured', () => {
@@ -113,4 +114,96 @@ describe('Amazon Conversions API Destination', () => {
       }
     })
   })
+
+  describe('testAuthentication', () => {
+    const testAuth = Destination.authentication.testAuthentication!
+    let mockRequest: jest.Mock
+
+    beforeEach(() => {
+      mockRequest = jest.fn().mockResolvedValue({ status: 200 })
+    })
+
+    it('should throw for non-numeric advertiserId', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: 'abc123' }
+        } as any)
+      ).rejects.toThrow('Advertising ID must be numeric')
+    })
+
+    it('should throw for advertiserId not numeric', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: '1234ac' }
+        } as any)
+      ).rejects.toThrow('Advertising ID must be numeric')
+    })
+
+    it('should throw for dataSetName that is too short (under 5 chars)', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: '12345', dataSetName: 'abcd' }
+        } as any)
+      ).rejects.toThrow('Dataset Name must start with a letter and can only contain letters, numbers, underscores, or hyphens.')
+    })
+
+    it('should throw for dataSetName that starts with a digit', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: '12345', dataSetName: '1invalid' }
+        } as any)
+      ).rejects.toThrow('Dataset Name must start with a letter and can only contain letters, numbers, underscores, or hyphens.')
+    })
+
+    it('should throw for dataSetName with invalid characters', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: '12345', dataSetName: 'my dataset!' }
+        } as any)
+      ).rejects.toThrow('Dataset Name must start with a letter and can only contain letters, numbers, underscores, or hyphens.')
+    })
+
+    it('should pass with a valid dataSetName', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: '12345', dataSetName: 'ValidDataset1' }
+        } as any)
+      ).resolves.toBeDefined()
+      expect(mockRequest).toHaveBeenCalled()
+    })
+
+    it('should pass with a dataSetName using underscores and hyphens', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: '12345', dataSetName: 'Default_Events-2' }
+        } as any)
+      ).resolves.toBeDefined()
+    })
+
+    it('should pass without dataSetName (field is optional)', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: '12345' }
+        } as any)
+      ).resolves.toBeDefined()
+      expect(mockRequest).toHaveBeenCalled()
+    })
+
+    it('should pass with numeric advertiserId', async () => {
+      await expect(
+        testAuth(mockRequest as unknown as RequestClient, {
+          auth: { accessToken: 'valid-token', refreshToken: '' },
+          settings: { region: Region.NA, advertiserId: '9876543210' }
+        } as any)
+      ).resolves.toBeDefined()
+    })
+  })
 })

packages/destination-actions/src/destinations/amazon-conversions-api/generated-types.ts

@@ -30,16 +30,32 @@ const destination: DestinationDefinition<Settings> = {
       },
       advertiserId: {
         label: 'Amazon Advertiser ID',
-        description: 'Your Amazon Advertiser Account ID.',
+        description: 'Your Amazon Advertiser Account ID. This must be a numeric value. Use Amazon DSP CFID and not Entity ID.',
         type: 'string',
         required: true
+      },
+      dataSetName: {
+        label: 'Dataset Name',
+        description: 'Amazon Ads organizes uploaded data into datasets, which are logical groupings used to separate and categorize events from your sources. The default dataset name (if not provided) is Default_Events. All events within a dataset will appear in Amazon Ads Data Manager under the name you provide here. New destination? We recommend providing a dataset name during initial setup. Existing destination? We strongly recommend reading the [FAQ](https://www.twilio.com/docs/segment/connections/destinations/catalog/actions-amazon-conversions-api#what-is-a-dataset-and-how-does-amazon-use-the-dataset-name) before updating your dataset name, as changes may impact your existing events.',
+        type: 'string',
+        required: false
       }
     },
     testAuthentication: async (request, { auth, settings }) => {
       if (!auth?.accessToken) {
         throw new InvalidAuthenticationError('Please authenticate via Oauth before enabling the destination.')
       }
 
+      const { dataSetName, advertiserId } = settings
+      
+      if(dataSetName && !/^[A-Za-z][A-Za-z0-9_-]{4,99}$/.test(dataSetName ?? '')){
+        throw new InvalidAuthenticationError('Dataset Name must start with a letter and can only contain letters, numbers, underscores, or hyphens. It must be between 5 and 100 characters long.')
+      }
+    
+      if(!/^\d+$/.test(advertiserId)) {
+        throw new InvalidAuthenticationError('Advertising ID must be numeric')
+      }
+
       return await request<RefreshTokenResponse>(`${settings.region}/v2/profiles`, {
         method: 'GET',
         headers: {

packages/destination-actions/src/destinations/amazon-conversions-api/index.ts

@@ -628,6 +628,56 @@ describe('trackConversion utils', () => {
       expect(result.unitsSold).toBeUndefined()
     })
 
+    it('should include dataSetName in eventDescription when provided in settings', () => {
+      const settingsWithDataSet = { ...settings, dataSetName: 'MyDataset1' }
+      const payload: Payload = {
+        name: 'test_event',
+        eventType: ConversionTypeV2.PAGE_VIEW,
+        eventActionSource: 'WEBSITE',
+        countryCode: 'US',
+        timestamp: '2023-01-01T12:00:00Z',
+        matchKeys: { email: '[email protected]' },
+        enable_batching: true
+      }
+
+      const result = prepareEventData(payload, settingsWithDataSet)
+
+      expect(result.eventDescription.dataSetName).toBe('MyDataset1')
+    })
+
+    it('should not include dataSetName in eventDescription when absent from settings', () => {
+      const payload: Payload = {
+        name: 'test_event',
+        eventType: ConversionTypeV2.PAGE_VIEW,
+        eventActionSource: 'WEBSITE',
+        countryCode: 'US',
+        timestamp: '2023-01-01T12:00:00Z',
+        matchKeys: { email: '[email protected]' },
+        enable_batching: true
+      }
+
+      const result = prepareEventData(payload, settings)
+
+      expect(result.eventDescription.dataSetName).toBeUndefined()
+    })
+
+    it('should not include dataSetName in eventDescription when settings.dataSetName is empty string', () => {
+      const settingsWithEmptyDataSet = { ...settings, dataSetName: '' }
+      const payload: Payload = {
+        name: 'test_event',
+        eventType: ConversionTypeV2.PAGE_VIEW,
+        eventActionSource: 'WEBSITE',
+        countryCode: 'US',
+        timestamp: '2023-01-01T12:00:00Z',
+        matchKeys: { email: '[email protected]' },
+        enable_batching: true
+      }
+
+      const result = prepareEventData(payload, settingsWithEmptyDataSet)
+
+      expect(result.eventDescription.dataSetName).toBeUndefined()
+    })
+
     it('should include optional fields when provided', () => {
       const payload: Payload = {
         name: 'purchase_event',

packages/destination-actions/src/destinations/amazon-conversions-api/trackConversion/__tests__/utils.test.ts

@@ -379,7 +379,8 @@ export function prepareEventData(payload: Payload, settings: Settings): EventDat
     name: payload.name,
     conversionType: payload.eventType as ConversionTypeV2,
     eventSource: payload.eventActionSource.toUpperCase(),
-    eventIngestionMethod: 'SERVER_TO_SERVER'
+    eventIngestionMethod: 'SERVER_TO_SERVER', 
+    ...(settings.dataSetName ? { dataSetName: settings.dataSetName } : {})
   }
 
   const eventData: EventData = {