Skip to content

Commit

Permalink
feat(destination): add partner_name for tiktok ads (#1583)
Browse files Browse the repository at this point in the history 
* Added partner_name for TikTok Ads destination

* [TikTok] Updated hardcoded strings with constant variable

Co-authored-by: Sudip Paul <67197965+ItsSudip@users.noreply.github.com>
Co-authored-by: Utsab Chowdhury <utsab.c97@gmail.com>
  • Loading branch information
@arnab-p @ItsSudip @utsabc
3 people committed Nov 17, 2022
1 parent b823a53 commit 12265a9
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 3 deletions.
20 changes: 20 additions & 0 deletions __tests__/data/tiktok_ads_output.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "CompletePayment",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -72,6 +73,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "InitiateCheckout",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -131,6 +133,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "AddToWishlist",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -198,6 +201,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "AddToWishlist",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -258,6 +262,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "AddToWishlist",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -327,6 +332,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "AddPaymentInfo",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -404,6 +410,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "AddPaymentInfo",
"event_id": "1616318632825_357",
"context": {
Expand Down Expand Up @@ -462,6 +469,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "SubmitForm",
"event_id": "16163186328257",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -521,6 +529,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "SubmitForm",
"event_id": "16163186328257",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -562,6 +571,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "Contact",
"event_id": "16163186328257",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -630,6 +640,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "CompletePayment",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -689,6 +700,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "PlaceAnOrder",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -748,6 +760,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "Subscribe",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -808,6 +821,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "Subscribe",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -868,6 +882,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "CompletePayment",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -927,6 +942,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "download",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -984,6 +1000,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "search",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -1052,6 +1069,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "download",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -1111,6 +1129,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "download",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down Expand Up @@ -1170,6 +1189,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"event": "download",
"event_id": "1616318632825_357",
"timestamp": "2020-09-17T19:49:27Z",
Expand Down
2 changes: 2 additions & 0 deletions __tests__/data/tiktok_ads_router_output.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
"body": {
"JSON": {
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"batch": [
{
"event": "CompletePayment",
Expand Down Expand Up @@ -231,6 +232,7 @@
"event": "AddToWishlist",
"event_id": "1616318632825_357",
"pixel_code": "A1T8T4UYGVIQA8ORZMX9",
"partner_name": "RudderStack",
"properties": {
"contents": [
{
Expand Down
3 changes: 3 additions & 0 deletions v0/destinations/tiktok_ads/config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ const ConfigCategory = {
}
};

const PARTNER_NAME = "RudderStack";

const eventNameMapping = {
"product added to wishlist": "AddToWishlist",
"product added": "AddToCart",
Expand All @@ -36,6 +38,7 @@ module.exports = {
TRACK_ENDPOINT,
BATCH_ENDPOINT,
MAX_BATCH_SIZE,
PARTNER_NAME,
trackMapping: mappingConfig[ConfigCategory.TRACK.name],
eventNameMapping
};
13 changes: 10 additions & 3 deletions v0/destinations/tiktok_ads/transform.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ const {
TRACK_ENDPOINT,
BATCH_ENDPOINT,
eventNameMapping,
MAX_BATCH_SIZE
MAX_BATCH_SIZE,
PARTNER_NAME
} = require("./config");

function checkIfValidPhoneNumber(str) {
Expand Down Expand Up @@ -99,8 +100,11 @@ const getTrackResponse = (message, Config, event) => {

response.method = defaultPostRequestConfig.requestMethod;
response.endpoint = TRACK_ENDPOINT;
response.body.JSON = removeUndefinedAndNullValues(payload);

// add partner name
response.body.JSON = removeUndefinedAndNullValues({
...payload,
partner_name: PARTNER_NAME
});
return response;
};

Expand Down Expand Up @@ -187,13 +191,16 @@ function batchEvents(eventsChunk) {
chunk.forEach(ev => {
// Pixel code must be added above "batch": [..]
delete ev.message.body.JSON.pixel_code;
// Partner name must be added above "batch": [..]
delete ev.message.body.JSON.partner_name;
ev.message.body.JSON.type = "track";
batchResponseList.push(ev.message.body.JSON);
metadata.push(ev.metadata);
});

batchEventResponse.batchedRequest.body.JSON = {
pixel_code: pixelCode,
partner_name: PARTNER_NAME,
batch: batchResponseList
};

Expand Down

0 comments on commit 12265a9

Please sign in to comment.