Skip to content

[CI-4063] Add campaign id parameters #361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
esezen merged 2 commits into from
Dec 17, 2024
Merged

[CI-4063] Add campaign id parameters #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aed5805
add campaign id parameters
stanlp1 Dec 13, 2024
2467563
jsdocs
stanlp1 Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion spec/src/modules/tracker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const sinonChai = require('sinon-chai');
const cloneDeep = require('lodash.clonedeep');
const store = require('../../../test/utils/store'); // eslint-disable-line import/extensions
const helpers = require('../../mocha.helpers');
const clientHelpers = require('../../../src/utils/helpers');
const jsdom = require('../utils/jsdom-global');
const { addOrderIdRecord } = require('../../../src/utils/helpers');
let ConstructorIO = require('../../../test/constructorio'); // eslint-disable-line import/extensions
Expand Down Expand Up @@ -1973,7 +1974,7 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
selectedFilters: { test: ['test'] },
section: 'Products',
analyticsTags: testAnalyticsTag,
items: [{ itemId: '1' }, { item_id: '2' }],
items: [{ itemId: '1', slCampaignId: 'Campaign 123', slCampaignOwner: 'Campaign Man' }, { item_id: '2' }],
};

it('Backwards Compatibility - V2 Should respond with a valid response when term and snake cased parameters are provided', (done) => {
Expand Down Expand Up @@ -2062,6 +2063,7 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
expect(bodyParams).to.have.property('selected_filters').to.deep.equal(v2Parameters.selectedFilters);
expect(bodyParams).to.have.property('section').to.deep.equal(v2Parameters.section);
expect(bodyParams).to.have.property('analytics_tags').to.deep.equal(v2Parameters.analyticsTags);
expect(bodyParams).to.have.property('items').to.deep.equal(v2Parameters.items.map((item) => clientHelpers.toSnakeCaseKeys(item, false)));

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
Expand Down Expand Up @@ -2592,6 +2594,8 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
resultId: 'result-id',
section: 'Products',
analyticsTags: testAnalyticsTag,
slCampaignOwner: 'Campaign Man',
slCampaignId: 'Campaign 123',
};
const v2Parameters = {
resultCount: 1337,
Expand Down Expand Up @@ -2685,6 +2689,8 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
expect(bodyParams).to.have.property('item_id').to.equal(requiredParameters.itemId);
expect(bodyParams).to.have.property('variation_id').to.equal(optionalParameters.variationId);
expect(bodyParams).to.have.property('section').to.deep.equal(optionalParameters.section);
expect(bodyParams).to.have.property('sl_campaign_id').to.equal(optionalParameters.slCampaignId);
expect(bodyParams).to.have.property('sl_campaign_owner').to.deep.equal(optionalParameters.slCampaignOwner);
expect(bodyParams).to.have.property('result_page').to.equal(v2Parameters.resultPage);
expect(bodyParams).to.have.property('result_position_on_page').to.equal(v2Parameters.resultPositionOnPage);
expect(bodyParams).to.have.property('result_count').to.equal(v2Parameters.resultCount);
Expand Down Expand Up @@ -2895,6 +2901,8 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
expect(requestParams).to.have.property('result_id').to.equal(optionalParameters.resultId);
expect(requestParams).to.have.property('variation_id').to.equal(optionalParameters.variationId);
expect(requestParams).to.have.property('analytics_tags').to.deep.equal(testAnalyticsTag);
expect(requestParams).to.have.property('sl_campaign_owner').to.deep.equal(optionalParameters.slCampaignOwner);
expect(requestParams).to.have.property('sl_campaign_id').to.deep.equal(optionalParameters.slCampaignId);

// Response
expect(responseParams).to.have.property('method').to.equal('GET');
Expand Down Expand Up @@ -5304,6 +5312,8 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
{
itemId: '123',
variationId: '456',
slCampaignId: 'Campaign 123',
slCampaignOwner: 'Campaign Man',
},
{
itemId: '789',
Expand All @@ -5315,6 +5325,8 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
{
item_id: '123',
variation_id: '456',
sl_campaign_id: 'Campaign 123',
sl_campaign_owner: 'Campaign Man',
},
{
item_id: '789',
Expand Down Expand Up @@ -6074,6 +6086,8 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
numResultsPerPage: 5,
selectedFilters: { foo: ['bar'] },
analyticsTags: testAnalyticsTag,
slCampaignOwner: 'Campaign Man',
slCampaignId: 'Campaign 123',
};

it('Backwards Compatibility - Should respond with a valid response when snake cased parameters are provided', (done) => {
Expand Down Expand Up @@ -6280,6 +6294,8 @@ describe(`ConstructorIO - Tracker${bundledDescriptionSuffix}`, () => {
expect(requestParams).to.have.property('num_results_per_page').to.equal(optionalParameters.numResultsPerPage);
expect(requestParams).to.have.property('selected_filters').to.deep.equal(optionalParameters.selectedFilters);
expect(requestParams).to.have.property('analytics_tags').to.deep.equal(testAnalyticsTag);
expect(requestParams).to.have.property('sl_campaign_id').to.deep.equal(optionalParameters.slCampaignId);
expect(requestParams).to.have.property('sl_campaign_owner').to.deep.equal(optionalParameters.slCampaignOwner);

// Response
expect(responseParams).to.have.property('method').to.equal('POST');
Expand Down
37 changes: 37 additions & 0 deletions src/modules/tracker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable complexity */
/* eslint-disable max-len */
/* eslint-disable object-curly-newline, no-underscore-dangle, camelcase, no-unneeded-ternary */
const EventEmitter = require('../utils/events');
Expand Down Expand Up @@ -808,6 +809,8 @@ class Tracker {
* @param {object} [parameters.selectedFilters] - Key - Value map of selected filters
* @param {string} [parameters.section] - The section name for the item Ex. "Products"
* @param {object} [parameters.analyticsTags] - Pass additional analytics data
* @param {object} [parameters.slCampaignId] - Pass campaign id of sponsored listing
* @param {object} [parameters.slCampaignOwner] - Pass campaign owner of sponsored listing
* @param {object} [networkParameters] - Parameters relevant to the network request
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
* @returns {(true|Error)}
Expand All @@ -819,6 +822,8 @@ class Tracker {
* itemName: 'Red T-Shirt',
* itemId: 'KMH876',
* resultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
* slCampaignId: 'Campaign 123',
* slCampaignOwner: 'Store 123',
* },
* );
*/
Expand Down Expand Up @@ -852,8 +857,12 @@ class Tracker {
selectedFilters = selected_filters,
section,
analyticsTags,
slCampaignId,
slCampaignOwner,
} = parameters;
const bodyParams = {
sl_campaign_id: slCampaignId,
sl_campaign_owner: slCampaignOwner,
item_name: itemName,
item_id: itemId,
variation_id: variationId,
Expand Down Expand Up @@ -912,6 +921,8 @@ class Tracker {
* @param {string} [parameters.itemIsConvertible] - Whether or not an item is available for a conversion
* @param {string} [parameters.section] - The section name for the item Ex. "Products"
* @param {object} [parameters.analyticsTags] - Pass additional analytics data
* @param {object} [parameters.slCampaignId] - Pass campaign id of sponsored listing
* @param {object} [parameters.slCampaignOwner] - Pass campaign owner of sponsored listing
* @param {object} [networkParameters] - Parameters relevant to the network request
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
* @returns {(true|Error)}
Expand All @@ -923,6 +934,8 @@ class Tracker {
* itemName: 'Red T-Shirt',
* itemId: 'KMH876',
* resultId: '019927c2-f955-4020-8b8d-6b21b93cb5a2',
* slCampaignId: 'Campaign 123',
* slCampaignOwner: 'Store 123',
* },
* );
*/
Expand All @@ -949,6 +962,8 @@ class Tracker {
itemIsConvertible = item_is_convertible,
section,
analyticsTags,
slCampaignOwner,
slCampaignId,
} = parameters;

// Ensure support for both item_name and name as parameters
Expand Down Expand Up @@ -981,6 +996,14 @@ class Tracker {
queryParams.analytics_tags = analyticsTags;
}

if (slCampaignId) {
queryParams.sl_campaign_id = slCampaignId;
}

if (slCampaignOwner) {
queryParams.sl_campaign_owner = slCampaignOwner;
}

this.requests.queue(`${url}${applyParamsAsString(queryParams, this.options)}`, undefined, undefined, networkParameters);
this.requests.send();

Expand Down Expand Up @@ -1606,6 +1629,8 @@ class Tracker {
* @param {number} [parameters.numResultsPerPage] - Number of results shown
* @param {object} [parameters.selectedFilters] - Selected filters
* @param {object} [parameters.analyticsTags] - Pass additional analytics data
* @param {object} [parameters.slCampaignId] - Pass campaign id of sponsored listing
* @param {object} [parameters.slCampaignOwner] - Pass campaign owner of sponsored listing
* @param {object} [networkParameters] - Parameters relevant to the network request
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
* @returns {(true|Error)}
Expand All @@ -1623,6 +1648,8 @@ class Tracker {
* filterName: 'brand',
* filterValue: 'XYZ',
* itemId: 'KMH876',
* slCampaignId: 'Campaign 123',
* slCampaignOwner: 'Store 123',
* },
* );
*/
Expand Down Expand Up @@ -1659,6 +1686,8 @@ class Tracker {
name,
itemName = item_name || name,
analyticsTags,
slCampaignId,
slCampaignOwner,
} = parameters;

if (section) {
Expand Down Expand Up @@ -1714,6 +1743,14 @@ class Tracker {
bodyParams.analytics_tags = analyticsTags;
}

if (slCampaignId) {
bodyParams.sl_campaign_id = slCampaignId;
}

if (slCampaignOwner) {
bodyParams.sl_campaign_owner = slCampaignOwner;
}

const requestURL = `${requestPath}${applyParamsAsString({}, this.options)}`;
const requestMethod = 'POST';
const requestBody = applyParams(bodyParams, { ...this.options, requestMethod });
Expand Down
2 changes: 2 additions & 0 deletions src/types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,8 @@ export interface ItemTracked {
itemName?: string;
itemId?: string;
variationId?: string;
slCampaignId?: string;
slCampaignOwner?: string;
}

export interface ItemTrackedPurchase extends ItemTracked {
Expand Down
4 changes: 4 additions & 0 deletions src/types/tracker.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ declare class Tracker {
itemIsConvertible?: string;
section?: string;
analyticsTags?: Record<string, string>;
slCampaignId?: string;
slCampaignOwner?: string;
},
networkParameters?: NetworkParameters
): true | Error;
Expand Down Expand Up @@ -204,6 +206,8 @@ declare class Tracker {
numResultsPerPage?: number;
selectedFilters?: object;
analyticsTags?: Record<string, string>;
slCampaignId?: string;
slCampaignOwner?: string;
},
networkParameters?: NetworkParameters
): true | Error;
Expand Down
Loading