@segment/action-destinations 3.50.2-alpha.1 → 3.50.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/destinations/adobe-target/adobeTarget_operations.js +1 -2
- package/dist/destinations/adobe-target/adobeTarget_operations.js.map +1 -1
- package/dist/destinations/tiktok-conversions/generated-types.d.ts +1 -1
- package/dist/destinations/tiktok-conversions/index.js +75 -21
- package/dist/destinations/tiktok-conversions/index.js.map +1 -1
- package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.d.ts +3 -3
- package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.js +9 -3
- package/dist/destinations/tiktok-conversions/reportWebEvent/formatter.js.map +1 -1
- package/dist/destinations/tiktok-conversions/reportWebEvent/generated-types.d.ts +16 -6
- package/dist/destinations/tiktok-conversions/reportWebEvent/index.js +117 -28
- package/dist/destinations/tiktok-conversions/reportWebEvent/index.js.map +1 -1
- package/package.json +2 -2
|
@@ -32,9 +32,8 @@ class AdobeTarget {
|
|
|
32
32
|
}
|
|
33
33
|
};
|
|
34
34
|
this.lookupProfile = async (userId, clientCode) => {
|
|
35
|
-
const requestUrl = `https://${clientCode}.tt.omtrdc.net/rest/v1/profiles/thirdPartyId/${userId}?client=${clientCode}`;
|
|
36
35
|
try {
|
|
37
|
-
await this.request(
|
|
36
|
+
await this.request(`https://${clientCode}.tt.omtrdc.net/rest/v1/profiles/thirdPartyId/${userId}?client=${clientCode}`, { method: 'get' });
|
|
38
37
|
}
|
|
39
38
|
catch (error) {
|
|
40
39
|
return new actions_core_1.IntegrationError('No profile found in Adobe Target with this mbox3rdPartyId', 'Profile not found', 404);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adobeTarget_operations.js","sourceRoot":"","sources":["../../../src/destinations/adobe-target/adobeTarget_operations.ts"],"names":[],"mappings":";;AAAA,wDAAuE;AAEvE,SAAS,gBAAgB,CAAC,GAAyB,EAAE,UAAU,GAAG,EAAE,EAAE,aAAsC,EAAE;IAC5G,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC/B,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;QAChE,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,CAAC,EAAE;YAC5C,UAAU,CAAC,cAAc,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;SACjD;aAAM;YACL,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,cAAc,EAAE,UAAU,CAAC,CAAA;SACvD;IACH,CAAC,CAAC,CAAA;IACF,OAAO,UAAU,CAAA;AACnB,CAAC;AACD,MAAM,mBAAmB,GAAG,CAAC,MAAmD,EAAE,EAAE,CAClF,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;KAChB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;KACxD,IAAI,CAAC,GAAG,CAAC,CAAA;AAEd,MAAqB,WAAW;IAM9B,YAAY,MAAc,EAAE,UAAkB,EAAE,MAAc,EAAE,OAAsB;QAOtF,kBAAa,GAAG,KAAK,IAAI,EAAE;YACzB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;YAClE,IAAI,GAAG,EAAE;gBACP,MAAM,GAAG,CAAA;aACV;iBAAM;gBACL,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC5C,MAAM,UAAU,GAAG,WAAW,IAAI,CAAC,UAAU,qBAC3C,IAAI,CAAC,UACP,kCAAkC,IAAI,CAAC,MAAM,IAAI,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAA;gBAE9E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;oBAC9B,MAAM,EAAE,MAAM;iBACf,CAAC,CAAA;aACH;QACH,CAAC,CAAA;QAEO,kBAAa,GAAG,KAAK,EAAE,MAAc,EAAE,UAAkB,EAAyC,EAAE;YAC1G,MAAM,
|
|
1
|
+
{"version":3,"file":"adobeTarget_operations.js","sourceRoot":"","sources":["../../../src/destinations/adobe-target/adobeTarget_operations.ts"],"names":[],"mappings":";;AAAA,wDAAuE;AAEvE,SAAS,gBAAgB,CAAC,GAAyB,EAAE,UAAU,GAAG,EAAE,EAAE,aAAsC,EAAE;IAC5G,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC/B,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;QAChE,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,CAAC,EAAE;YAC5C,UAAU,CAAC,cAAc,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;SACjD;aAAM;YACL,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,cAAc,EAAE,UAAU,CAAC,CAAA;SACvD;IACH,CAAC,CAAC,CAAA;IACF,OAAO,UAAU,CAAA;AACnB,CAAC;AACD,MAAM,mBAAmB,GAAG,CAAC,MAAmD,EAAE,EAAE,CAClF,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;KAChB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC;KACxD,IAAI,CAAC,GAAG,CAAC,CAAA;AAEd,MAAqB,WAAW;IAM9B,YAAY,MAAc,EAAE,UAAkB,EAAE,MAAc,EAAE,OAAsB;QAOtF,kBAAa,GAAG,KAAK,IAAI,EAAE;YACzB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;YAClE,IAAI,GAAG,EAAE;gBACP,MAAM,GAAG,CAAA;aACV;iBAAM;gBACL,MAAM,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC5C,MAAM,UAAU,GAAG,WAAW,IAAI,CAAC,UAAU,qBAC3C,IAAI,CAAC,UACP,kCAAkC,IAAI,CAAC,MAAM,IAAI,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAA;gBAE9E,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;oBAC9B,MAAM,EAAE,MAAM;iBACf,CAAC,CAAA;aACH;QACH,CAAC,CAAA;QAEO,kBAAa,GAAG,KAAK,EAAE,MAAc,EAAE,UAAkB,EAAyC,EAAE;YAC1G,IAAI;gBACF,MAAM,IAAI,CAAC,OAAO,CAChB,WAAW,UAAU,gDAAgD,MAAM,WAAW,UAAU,EAAE,EAClG,EAAE,MAAM,EAAE,KAAK,EAAE,CAClB,CAAA;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,IAAI,+BAAgB,CAAC,2DAA2D,EAAE,mBAAmB,EAAE,GAAG,CAAC,CAAA;aACnH;YAED,OAAO,SAAS,CAAA;QAClB,CAAC,CAAA;QAjCC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CA8BF;AAzCD,8BAyCC"}
|
|
@@ -5,50 +5,104 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
const actions_core_1 = require("@segment/actions-core");
|
|
7
7
|
const reportWebEvent_1 = __importDefault(require("./reportWebEvent"));
|
|
8
|
-
const
|
|
9
|
-
{
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
8
|
+
const productProperties = {
|
|
9
|
+
price: {
|
|
10
|
+
'@path': '$.price'
|
|
11
|
+
},
|
|
12
|
+
quantity: {
|
|
13
|
+
'@path': '$.quantity'
|
|
14
|
+
},
|
|
15
|
+
content_type: {
|
|
16
|
+
'@path': '$.category'
|
|
17
17
|
},
|
|
18
|
+
content_id: {
|
|
19
|
+
'@path': '$.product_id'
|
|
20
|
+
}
|
|
21
|
+
};
|
|
22
|
+
const singleProductContents = {
|
|
23
|
+
...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
|
|
24
|
+
contents: {
|
|
25
|
+
'@arrayPath': [
|
|
26
|
+
'$.properties',
|
|
27
|
+
{
|
|
28
|
+
...productProperties
|
|
29
|
+
}
|
|
30
|
+
]
|
|
31
|
+
}
|
|
32
|
+
};
|
|
33
|
+
const multiProductContents = {
|
|
34
|
+
...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
|
|
35
|
+
contents: {
|
|
36
|
+
'@arrayPath': [
|
|
37
|
+
'$.properties.products',
|
|
38
|
+
{
|
|
39
|
+
...productProperties
|
|
40
|
+
}
|
|
41
|
+
]
|
|
42
|
+
}
|
|
43
|
+
};
|
|
44
|
+
const presets = [
|
|
18
45
|
{
|
|
19
46
|
name: 'View Content',
|
|
20
47
|
subscribe: 'type="page"',
|
|
21
48
|
partnerAction: 'reportWebEvent',
|
|
22
49
|
mapping: {
|
|
23
|
-
...
|
|
50
|
+
...singleProductContents,
|
|
24
51
|
event: 'ViewContent'
|
|
25
52
|
}
|
|
26
53
|
},
|
|
27
54
|
{
|
|
28
|
-
name: '
|
|
55
|
+
name: 'Search',
|
|
29
56
|
subscribe: 'event = "Products Searched"',
|
|
30
57
|
partnerAction: 'reportWebEvent',
|
|
31
58
|
mapping: {
|
|
32
|
-
...
|
|
59
|
+
...singleProductContents,
|
|
33
60
|
event: 'Search'
|
|
34
61
|
}
|
|
35
62
|
},
|
|
63
|
+
{
|
|
64
|
+
name: 'Add to Wishlist',
|
|
65
|
+
subscribe: 'event = "Product Added to Wishlist"',
|
|
66
|
+
partnerAction: 'reportWebEvent',
|
|
67
|
+
mapping: {
|
|
68
|
+
...singleProductContents,
|
|
69
|
+
event: 'AddToWishlist'
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
name: 'Add to Cart',
|
|
74
|
+
subscribe: 'event = "Product Added"',
|
|
75
|
+
partnerAction: 'reportWebEvent',
|
|
76
|
+
mapping: {
|
|
77
|
+
...singleProductContents,
|
|
78
|
+
event: 'AddToCart'
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
name: 'Initiate Checkout',
|
|
83
|
+
subscribe: 'event = "Checkout Started"',
|
|
84
|
+
partnerAction: 'reportWebEvent',
|
|
85
|
+
mapping: {
|
|
86
|
+
...multiProductContents,
|
|
87
|
+
event: 'InitiateCheckout'
|
|
88
|
+
}
|
|
89
|
+
},
|
|
36
90
|
{
|
|
37
91
|
name: 'Add Payment Info',
|
|
38
92
|
subscribe: 'event = "Payment Info Entered"',
|
|
39
93
|
partnerAction: 'reportWebEvent',
|
|
40
94
|
mapping: {
|
|
41
|
-
...
|
|
95
|
+
...multiProductContents,
|
|
42
96
|
event: 'AddPaymentInfo'
|
|
43
97
|
}
|
|
44
98
|
},
|
|
45
99
|
{
|
|
46
|
-
name: 'Order
|
|
100
|
+
name: 'Place an Order',
|
|
47
101
|
subscribe: 'event = "Order Completed"',
|
|
48
102
|
partnerAction: 'reportWebEvent',
|
|
49
103
|
mapping: {
|
|
50
|
-
...
|
|
51
|
-
event: '
|
|
104
|
+
...multiProductContents,
|
|
105
|
+
event: 'PlaceAnOrder'
|
|
52
106
|
}
|
|
53
107
|
}
|
|
54
108
|
];
|
|
@@ -61,14 +115,14 @@ const destination = {
|
|
|
61
115
|
fields: {
|
|
62
116
|
accessToken: {
|
|
63
117
|
label: 'Access Token',
|
|
64
|
-
description:
|
|
118
|
+
description: 'Your TikTok Access Token. Please see TikTok’s [Events API documentation](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106) for information on how to generate an access token via the TikTok Ads Manager or API.',
|
|
65
119
|
type: 'string',
|
|
66
120
|
required: true
|
|
67
121
|
},
|
|
68
|
-
|
|
122
|
+
pixelCode: {
|
|
69
123
|
label: 'Pixel Code',
|
|
70
124
|
type: 'string',
|
|
71
|
-
description: '
|
|
125
|
+
description: 'Your TikTok Pixel ID. Please see TikTok’s [Events API documentation](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106) for information on how to find this value.',
|
|
72
126
|
required: true
|
|
73
127
|
}
|
|
74
128
|
},
|
|
@@ -76,8 +130,8 @@ const destination = {
|
|
|
76
130
|
return request('https://business-api.tiktok.com/open_api/v1.2/pixel/track/', {
|
|
77
131
|
method: 'post',
|
|
78
132
|
json: {
|
|
79
|
-
pixel_code: settings.
|
|
80
|
-
event:
|
|
133
|
+
pixel_code: settings.pixelCode,
|
|
134
|
+
event: 'Test Event',
|
|
81
135
|
timestamp: '',
|
|
82
136
|
context: {}
|
|
83
137
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions/index.ts"],"names":[],"mappings":";;;;;AACA,wDAAqD;AAGrD,sEAA6C;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions/index.ts"],"names":[],"mappings":";;;;;AACA,wDAAqD;AAGrD,sEAA6C;AAE7C,MAAM,iBAAiB,GAAG;IACxB,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY;KACtB;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,YAAY;KACtB;IACD,UAAU,EAAE;QACV,OAAO,EAAE,cAAc;KACxB;CACF,CAAA;AAED,MAAM,qBAAqB,GAAG;IAC5B,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,cAAc;YACd;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAED,MAAM,oBAAoB,GAAG;IAC3B,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;IACvC,QAAQ,EAAE;QACR,YAAY,EAAE;YACZ,uBAAuB;YACvB;gBACE,GAAG,iBAAiB;aACrB;SACF;KACF;CACF,CAAA;AAGD,MAAM,OAAO,GAAqC;IAChD;QACE,IAAI,EAAE,cAAc;QACpB,SAAS,EAAE,aAAa;QACxB,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,KAAK,EAAE,aAAa;SACrB;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,SAAS,EAAE,6BAA6B;QACxC,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,KAAK,EAAE,QAAQ;SAChB;KACF;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,SAAS,EAAE,qCAAqC;QAChD,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,KAAK,EAAE,eAAe;SACvB;KACF;IACD;QACE,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,yBAAyB;QACpC,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,qBAAqB;YACxB,KAAK,EAAE,WAAW;SACnB;KACF;IACD;QACE,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE,4BAA4B;QACvC,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,oBAAoB;YACvB,KAAK,EAAE,kBAAkB;SAC1B;KACF;IACD;QACE,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,gCAAgC;QAC3C,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,oBAAoB;YACvB,KAAK,EAAE,gBAAgB;SACxB;KACF;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,SAAS,EAAE,2BAA2B;QACtC,aAAa,EAAE,gBAAgB;QAC/B,OAAO,EAAE;YACP,GAAG,oBAAoB;YACvB,KAAK,EAAE,cAAc;SACtB;KACF;CACF,CAAA;AAED,MAAM,WAAW,GAAoC;IAInD,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,oBAAoB;IAC1B,IAAI,EAAE,OAAO;IAEb,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,MAAM,EAAE;YACN,WAAW,EAAE;gBACX,KAAK,EAAE,cAAc;gBACrB,WAAW,EACT,+NAA+N;gBACjO,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,SAAS,EAAE;gBACT,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,gLAAgL;gBAClL,QAAQ,EAAE,IAAI;aACf;SACF;QACD,kBAAkB,EAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAG5C,OAAO,OAAO,CAAC,4DAA4D,EAAE;gBAC3E,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE;oBACJ,UAAU,EAAE,QAAQ,CAAC,SAAS;oBAC9B,KAAK,EAAE,YAAY;oBACnB,SAAS,EAAE,EAAE;oBACb,OAAO,EAAE,EAAE;iBACZ;aACF,CAAC,CAAA;QACJ,CAAC;KACF;IACD,aAAa,CAAC,EAAE,QAAQ,EAAE;QACxB,OAAO;YACL,OAAO,EAAE,EAAE,cAAc,EAAE,QAAQ,CAAC,WAAW,EAAE;SAClD,CAAA;IACH,CAAC;IACD,OAAO;IACP,OAAO,EAAE;QACP,cAAc,EAAd,wBAAc;KACf;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export declare function formatEmail(email: string): string;
|
|
2
|
-
export declare function formatUserId(userId: string): string;
|
|
3
|
-
export declare function formatPhone(phone
|
|
1
|
+
export declare function formatEmail(email: string | undefined): string | undefined;
|
|
2
|
+
export declare function formatUserId(userId: string | undefined): string | undefined;
|
|
3
|
+
export declare function formatPhone(phone: string | undefined): string | undefined;
|
|
@@ -3,16 +3,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.formatPhone = exports.formatUserId = exports.formatEmail = void 0;
|
|
4
4
|
const crypto_1 = require("crypto");
|
|
5
5
|
function formatEmail(email) {
|
|
6
|
-
|
|
6
|
+
if (email) {
|
|
7
|
+
return hashAndEncode(email.toLowerCase());
|
|
8
|
+
}
|
|
9
|
+
return undefined;
|
|
7
10
|
}
|
|
8
11
|
exports.formatEmail = formatEmail;
|
|
9
12
|
function formatUserId(userId) {
|
|
10
|
-
|
|
13
|
+
if (userId) {
|
|
14
|
+
return hashAndEncode(userId.toLowerCase().trim());
|
|
15
|
+
}
|
|
16
|
+
return undefined;
|
|
11
17
|
}
|
|
12
18
|
exports.formatUserId = formatUserId;
|
|
13
19
|
function formatPhone(phone) {
|
|
14
20
|
if (!phone)
|
|
15
|
-
return
|
|
21
|
+
return undefined;
|
|
16
22
|
const validatedPhone = phone.match(/[0-9]{0,14}/g);
|
|
17
23
|
if (validatedPhone === null) {
|
|
18
24
|
throw new Error(`${phone} is not a valid E.164 phone number.`);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions/reportWebEvent/formatter.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAKnC,SAAgB,WAAW,CAAC,
|
|
1
|
+
{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions/reportWebEvent/formatter.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAKnC,SAAgB,WAAW,CAAC,KAAyB;IACnD,IAAI,KAAK,EAAE;QACT,OAAO,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;KAC1C;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AALD,kCAKC;AAOD,SAAgB,YAAY,CAAC,MAA0B;IACrD,IAAI,MAAM,EAAE;QACV,OAAO,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,CAAA;KAClD;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AALD,oCAKC;AAOD,SAAgB,WAAW,CAAC,KAAyB;IACnD,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAA;IAE5B,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;IAClD,IAAI,cAAc,KAAK,IAAI,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAA;KAC/D;IAED,IAAI,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAA;IAEvD,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;IAChD,OAAO,aAAa,CAAC,cAAc,CAAC,CAAA;AACtC,CAAC;AAZD,kCAYC;AAED,SAAS,aAAa,CAAC,QAAgB;IACrC,OAAO,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC5D,CAAC"}
|
|
@@ -1,13 +1,23 @@
|
|
|
1
1
|
export interface Payload {
|
|
2
|
-
event
|
|
2
|
+
event: string;
|
|
3
3
|
event_id?: string;
|
|
4
4
|
timestamp?: string;
|
|
5
|
-
type?: string;
|
|
6
|
-
properties?: {
|
|
7
|
-
[k: string]: unknown;
|
|
8
|
-
};
|
|
9
5
|
phone_number?: string;
|
|
10
6
|
email?: string;
|
|
11
|
-
external_id
|
|
7
|
+
external_id?: string;
|
|
12
8
|
ttclid?: string;
|
|
9
|
+
url?: string;
|
|
10
|
+
referrer?: string;
|
|
11
|
+
ip?: string;
|
|
12
|
+
user_agent?: string;
|
|
13
|
+
contents?: {
|
|
14
|
+
price?: number;
|
|
15
|
+
quantity?: number;
|
|
16
|
+
content_type?: string;
|
|
17
|
+
content_id?: string;
|
|
18
|
+
}[];
|
|
19
|
+
currency?: string;
|
|
20
|
+
value?: number;
|
|
21
|
+
description?: string;
|
|
22
|
+
query?: string;
|
|
13
23
|
}
|
|
@@ -8,10 +8,8 @@ const action = {
|
|
|
8
8
|
event: {
|
|
9
9
|
label: 'Event Name',
|
|
10
10
|
type: 'string',
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
'@path': '$.event'
|
|
14
|
-
}
|
|
11
|
+
required: true,
|
|
12
|
+
description: 'Conversion event name. Please refer to the "Supported Web Events" section on in TikTok’s [Events API documentation](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106) for accepted event names.'
|
|
15
13
|
},
|
|
16
14
|
event_id: {
|
|
17
15
|
label: 'Event ID',
|
|
@@ -24,25 +22,14 @@ const action = {
|
|
|
24
22
|
timestamp: {
|
|
25
23
|
label: 'Event Timestamp',
|
|
26
24
|
type: 'string',
|
|
27
|
-
description: 'Timestamp that the event took place, in ISO 8601 format.'
|
|
28
|
-
},
|
|
29
|
-
type: {
|
|
30
|
-
label: 'Segment Event Type',
|
|
31
|
-
description: 'The Segment event type, e.g. "page".',
|
|
32
|
-
type: 'string',
|
|
25
|
+
description: 'Timestamp that the event took place, in ISO 8601 format.',
|
|
33
26
|
default: {
|
|
34
|
-
'@path': '$.
|
|
27
|
+
'@path': '$.timestamp'
|
|
35
28
|
}
|
|
36
29
|
},
|
|
37
|
-
properties: {
|
|
38
|
-
label: 'Properties associated with the event',
|
|
39
|
-
description: 'Additional properties such as content info, description, and currency.',
|
|
40
|
-
type: 'object',
|
|
41
|
-
required: false
|
|
42
|
-
},
|
|
43
30
|
phone_number: {
|
|
44
31
|
label: 'Phone Number',
|
|
45
|
-
description: 'Phone number of the user who triggered the conversion event, in E.164 standard format, e.g. +14150000000.',
|
|
32
|
+
description: 'Phone number of the user who triggered the conversion event, in E.164 standard format, e.g. +14150000000. Segment will hash this value before sending to TikTok.',
|
|
46
33
|
type: 'string',
|
|
47
34
|
default: {
|
|
48
35
|
'@if': {
|
|
@@ -54,7 +41,7 @@ const action = {
|
|
|
54
41
|
},
|
|
55
42
|
email: {
|
|
56
43
|
label: 'Email',
|
|
57
|
-
description: 'Email address of the user who triggered the conversion event.',
|
|
44
|
+
description: 'Email address of the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
|
|
58
45
|
type: 'string',
|
|
59
46
|
format: 'email',
|
|
60
47
|
default: {
|
|
@@ -67,9 +54,8 @@ const action = {
|
|
|
67
54
|
},
|
|
68
55
|
external_id: {
|
|
69
56
|
label: 'External ID',
|
|
70
|
-
description: 'Uniquely identifies the user who triggered the conversion event.',
|
|
57
|
+
description: 'Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
|
|
71
58
|
type: 'string',
|
|
72
|
-
required: true,
|
|
73
59
|
default: {
|
|
74
60
|
'@if': {
|
|
75
61
|
exists: { '@path': '$.userId' },
|
|
@@ -89,23 +75,113 @@ const action = {
|
|
|
89
75
|
else: { '@path': '$.traits.ttclid' }
|
|
90
76
|
}
|
|
91
77
|
}
|
|
78
|
+
},
|
|
79
|
+
url: {
|
|
80
|
+
label: 'Page URL',
|
|
81
|
+
type: 'string',
|
|
82
|
+
description: 'The page URL where the conversion event took place.',
|
|
83
|
+
default: {
|
|
84
|
+
'@path': '$.context.page.url'
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
referrer: {
|
|
88
|
+
label: 'Page Referrer',
|
|
89
|
+
type: 'string',
|
|
90
|
+
description: 'The page referrer.',
|
|
91
|
+
default: {
|
|
92
|
+
'@path': '$.context.page.referrer'
|
|
93
|
+
}
|
|
94
|
+
},
|
|
95
|
+
ip: {
|
|
96
|
+
label: 'IP Address',
|
|
97
|
+
type: 'string',
|
|
98
|
+
description: 'IP address of the browser.',
|
|
99
|
+
default: {
|
|
100
|
+
'@path': '$.context.ip'
|
|
101
|
+
}
|
|
102
|
+
},
|
|
103
|
+
user_agent: {
|
|
104
|
+
label: 'User Agent',
|
|
105
|
+
type: 'string',
|
|
106
|
+
description: 'User agent from the user’s device.',
|
|
107
|
+
default: {
|
|
108
|
+
'@path': '$.context.userAgent'
|
|
109
|
+
}
|
|
110
|
+
},
|
|
111
|
+
contents: {
|
|
112
|
+
label: 'Contents',
|
|
113
|
+
type: 'object',
|
|
114
|
+
multiple: true,
|
|
115
|
+
description: 'Related items in a web event.',
|
|
116
|
+
properties: {
|
|
117
|
+
price: {
|
|
118
|
+
label: 'Price',
|
|
119
|
+
description: 'Price of the item.',
|
|
120
|
+
type: 'number'
|
|
121
|
+
},
|
|
122
|
+
quantity: {
|
|
123
|
+
label: 'Quantity',
|
|
124
|
+
description: 'Number of items.',
|
|
125
|
+
type: 'number'
|
|
126
|
+
},
|
|
127
|
+
content_type: {
|
|
128
|
+
label: 'Content Type',
|
|
129
|
+
description: 'Type of the product item.',
|
|
130
|
+
type: 'string'
|
|
131
|
+
},
|
|
132
|
+
content_id: {
|
|
133
|
+
label: 'Content ID',
|
|
134
|
+
description: 'ID of the product item.',
|
|
135
|
+
type: 'string'
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
},
|
|
139
|
+
currency: {
|
|
140
|
+
label: 'Currency',
|
|
141
|
+
type: 'string',
|
|
142
|
+
description: 'Currency for the value specified as ISO 4217 code.',
|
|
143
|
+
default: {
|
|
144
|
+
'@path': '$.properties.currency'
|
|
145
|
+
}
|
|
146
|
+
},
|
|
147
|
+
value: {
|
|
148
|
+
label: 'Value',
|
|
149
|
+
type: 'number',
|
|
150
|
+
description: 'Value of the order or items sold.',
|
|
151
|
+
default: {
|
|
152
|
+
'@if': {
|
|
153
|
+
exists: { '@path': '$.properties.value' },
|
|
154
|
+
then: { '@path': '$.properties.value' },
|
|
155
|
+
else: { '@path': '$.properties.revenue' }
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
},
|
|
159
|
+
description: {
|
|
160
|
+
label: 'Description',
|
|
161
|
+
type: 'string',
|
|
162
|
+
description: 'A string description of the web event.'
|
|
163
|
+
},
|
|
164
|
+
query: {
|
|
165
|
+
label: 'Query',
|
|
166
|
+
type: 'string',
|
|
167
|
+
description: 'The text string that was searched for.',
|
|
168
|
+
default: {
|
|
169
|
+
'@path': '$.properties.query'
|
|
170
|
+
}
|
|
92
171
|
}
|
|
93
172
|
},
|
|
94
173
|
perform: (request, { payload, settings }) => {
|
|
95
|
-
const eventId = payload.event_id
|
|
96
|
-
? payload.event_id.toString() + '_' + (Math.random() + 1).toString(36).substring(7)
|
|
97
|
-
: '';
|
|
98
174
|
const userData = {
|
|
99
175
|
hashedExternalId: formatter_1.formatUserId(payload.external_id),
|
|
100
|
-
hashedEmail: formatter_1.formatEmail(payload.email
|
|
176
|
+
hashedEmail: formatter_1.formatEmail(payload.email),
|
|
101
177
|
hashedPhoneNumber: formatter_1.formatPhone(payload.phone_number)
|
|
102
178
|
};
|
|
103
179
|
return request('https://business-api.tiktok.com/open_api/v1.2/pixel/track/', {
|
|
104
180
|
method: 'post',
|
|
105
181
|
json: {
|
|
106
|
-
pixel_code: settings.
|
|
182
|
+
pixel_code: settings.pixelCode,
|
|
107
183
|
event: payload.event,
|
|
108
|
-
event_id:
|
|
184
|
+
event_id: payload.event_id ? `${payload.event_id}_seg` : undefined,
|
|
109
185
|
timestamp: payload.timestamp,
|
|
110
186
|
context: {
|
|
111
187
|
user: {
|
|
@@ -115,7 +191,20 @@ const action = {
|
|
|
115
191
|
},
|
|
116
192
|
ad: {
|
|
117
193
|
callback: payload.ttclid
|
|
118
|
-
}
|
|
194
|
+
},
|
|
195
|
+
page: {
|
|
196
|
+
url: payload.url,
|
|
197
|
+
referrer: payload.referrer
|
|
198
|
+
},
|
|
199
|
+
ip: payload.ip,
|
|
200
|
+
user_agent: payload.user_agent
|
|
201
|
+
},
|
|
202
|
+
properties: {
|
|
203
|
+
contents: payload.contents,
|
|
204
|
+
currency: payload.currency,
|
|
205
|
+
value: payload.value,
|
|
206
|
+
description: payload.description,
|
|
207
|
+
query: payload.query
|
|
119
208
|
}
|
|
120
209
|
}
|
|
121
210
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions/reportWebEvent/index.ts"],"names":[],"mappings":";;AAGA,2CAAoE;AAEpE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,6JAA6J;IAC/J,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions/reportWebEvent/index.ts"],"names":[],"mappings":";;AAGA,2CAAoE;AAEpE,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,6JAA6J;IAC/J,MAAM,EAAE;QACN,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,8MAA8M;SACjN;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wDAAwD;YACrE,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QACD,SAAS,EAAE;YACT,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,0DAA0D;YACvE,OAAO,EAAE;gBACP,OAAO,EAAE,aAAa;aACvB;SACF;QAED,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EACT,kKAAkK;YACpK,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;iBACpC;aACF;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,WAAW,EACT,sHAAsH;YACxH,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,OAAO;YACf,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE;iBACpC;aACF;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,WAAW,EACT,yHAAyH;YAC3H,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;oBAC/B,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;oBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;iBACnC;aACF;SACF;QACD,MAAM,EAAE;YACN,KAAK,EAAE,kBAAkB;YACzB,WAAW,EACT,+NAA+N;YACjO,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;oBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,iBAAiB,EAAE;iBACrC;aACF;SACF;QACD,GAAG,EAAE;YACH,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qDAAqD;YAClE,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oBAAoB;YACjC,OAAO,EAAE;gBACP,OAAO,EAAE,yBAAyB;aACnC;SACF;QACD,EAAE,EAAE;YACF,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,4BAA4B;YACzC,OAAO,EAAE;gBACP,OAAO,EAAE,cAAc;aACxB;SACF;QACD,UAAU,EAAE;YACV,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oCAAoC;YACjD,OAAO,EAAE;gBACP,OAAO,EAAE,qBAAqB;aAC/B;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,+BAA+B;YAC5C,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,KAAK,EAAE,OAAO;oBACd,WAAW,EAAE,oBAAoB;oBACjC,IAAI,EAAE,QAAQ;iBACf;gBACD,QAAQ,EAAE;oBACR,KAAK,EAAE,UAAU;oBACjB,WAAW,EAAE,kBAAkB;oBAC/B,IAAI,EAAE,QAAQ;iBACf;gBACD,YAAY,EAAE;oBACZ,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,2BAA2B;oBACxC,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE,YAAY;oBACnB,WAAW,EAAE,yBAAyB;oBACtC,IAAI,EAAE,QAAQ;iBACf;aACF;SACF;QACD,QAAQ,EAAE;YACR,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,oDAAoD;YACjE,OAAO,EAAE;gBACP,OAAO,EAAE,uBAAuB;aACjC;SACF;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mCAAmC;YAChD,OAAO,EAAE;gBACP,KAAK,EAAE;oBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;oBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;iBAC1C;aACF;SACF;QACD,WAAW,EAAE;YACX,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;SACtD;QACD,KAAK,EAAE;YACL,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE;gBACP,OAAO,EAAE,oBAAoB;aAC9B;SACF;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,MAAM,QAAQ,GAAG;YACf,gBAAgB,EAAE,wBAAY,CAAC,OAAO,CAAC,WAAW,CAAC;YACnD,WAAW,EAAE,uBAAW,CAAC,OAAO,CAAC,KAAK,CAAC;YACvC,iBAAiB,EAAE,uBAAW,CAAC,OAAO,CAAC,YAAY,CAAC;SACrD,CAAA;QAGD,OAAO,OAAO,CAAC,4DAA4D,EAAE;YAC3E,MAAM,EAAE,MAAM;YACd,IAAI,EAAE;gBACJ,UAAU,EAAE,QAAQ,CAAC,SAAS;gBAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,MAAM,CAAC,CAAC,CAAC,SAAS;gBAClE,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,OAAO,EAAE;oBACP,IAAI,EAAE;wBACJ,WAAW,EAAE,QAAQ,CAAC,gBAAgB;wBACtC,YAAY,EAAE,QAAQ,CAAC,iBAAiB;wBACxC,KAAK,EAAE,QAAQ,CAAC,WAAW;qBAC5B;oBACD,EAAE,EAAE;wBACF,QAAQ,EAAE,OAAO,CAAC,MAAM;qBACzB;oBACD,IAAI,EAAE;wBACJ,GAAG,EAAE,OAAO,CAAC,GAAG;wBAChB,QAAQ,EAAE,OAAO,CAAC,QAAQ;qBAC3B;oBACD,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,UAAU,EAAE,OAAO,CAAC,UAAU;iBAC/B;gBACD,UAAU,EAAE;oBACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,QAAQ,EAAE,OAAO,CAAC,QAAQ;oBAC1B,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,WAAW,EAAE,OAAO,CAAC,WAAW;oBAChC,KAAK,EAAE,OAAO,CAAC,KAAK;iBACrB;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@segment/action-destinations",
|
|
3
3
|
"description": "Destination Actions engine and definitions.",
|
|
4
|
-
"version": "3.50.2
|
|
4
|
+
"version": "3.50.2",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
7
|
"url": "https://github.com/segmentio/action-destinations",
|
|
@@ -62,5 +62,5 @@
|
|
|
62
62
|
"<rootDir>/test/setup-after-env.ts"
|
|
63
63
|
]
|
|
64
64
|
},
|
|
65
|
-
"gitHead": "
|
|
65
|
+
"gitHead": "64e8c4162f5d742dc389698067aaafe3f7e91bca"
|
|
66
66
|
}
|