@segment/action-destinations 3.49.2-alpha.1 → 3.50.1-alpha.3

package/dist/destinations/tiktok-conversions/reportWebEvent/index.js

@@ -8,10 +8,8 @@ const action = {
         event: {
             label: 'Event Name',
             type: 'string',
-            description: 'Conversion event name. Please refer to the "Supported Web Events" section on this [page](https://ads.tiktok.com/marketing_api/docs?id=1701890979375106) for accepted event names.',
-            default: {
-                '@path': '$.event'
-            }
+            required: true,
+            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.'
         },
         event_id: {
             label: 'Event ID',
@@ -24,25 +22,14 @@ const action = {
         timestamp: {
             label: 'Event Timestamp',
             type: 'string',
-            description: 'Timestamp that the event took place, in ISO 8601 format.'
-        },
-        type: {
-            label: 'Segment Event Type',
-            description: 'The Segment event type, e.g. "page".',
-            type: 'string',
+            description: 'Timestamp that the event took place, in ISO 8601 format.',
             default: {
-                '@path': '$.type'
+                '@path': '$.timestamp'
             }
         },
-        properties: {
-            label: 'Properties associated with the event',
-            description: 'Additional properties such as content info, description, and currency.',
-            type: 'object',
-            required: false
-        },
         phone_number: {
             label: 'Phone Number',
-            description: 'Phone number of the user who triggered the conversion event, in E.164 standard format, e.g. +14150000000.',
+            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.',
             type: 'string',
             default: {
                 '@if': {
@@ -54,7 +41,7 @@ const action = {
         },
         email: {
             label: 'Email',
-            description: 'Email address of the user who triggered the conversion event.',
+            description: 'Email address of the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
             type: 'string',
             format: 'email',
             default: {
@@ -67,9 +54,8 @@ const action = {
         },
         external_id: {
             label: 'External ID',
-            description: 'Uniquely identifies the user who triggered the conversion event.',
+            description: 'Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok.',
             type: 'string',
-            required: true,
             default: {
                 '@if': {
                     exists: { '@path': '$.userId' },
@@ -89,15 +75,105 @@ const action = {
                     else: { '@path': '$.traits.ttclid' }
                 }
             }
+        },
+        url: {
+            label: 'Page URL',
+            type: 'string',
+            description: 'The page URL where the conversion event took place.',
+            default: {
+                '@path': '$.context.page.url'
+            }
+        },
+        referrer: {
+            label: 'Page Referrer',
+            type: 'string',
+            description: 'The page referrer.',
+            default: {
+                '@path': '$.context.page.referrer'
+            }
+        },
+        ip: {
+            label: 'IP Address',
+            type: 'string',
+            description: 'IP address of the browser.',
+            default: {
+                '@path': '$.context.ip'
+            }
+        },
+        user_agent: {
+            label: 'User Agent',
+            type: 'string',
+            description: 'User agent from the user’s device.',
+            default: {
+                '@path': '$.context.userAgent'
+            }
+        },
+        contents: {
+            label: 'Contents',
+            type: 'object',
+            multiple: true,
+            description: 'Related items in a web event.',
+            properties: {
+                price: {
+                    label: 'Price',
+                    description: 'Price of the item.',
+                    type: 'number'
+                },
+                quantity: {
+                    label: 'Quantity',
+                    description: 'Number of items.',
+                    type: 'number'
+                },
+                content_type: {
+                    label: 'Content Type',
+                    description: 'Type of the product item.',
+                    type: 'string'
+                },
+                content_id: {
+                    label: 'Content ID',
+                    description: 'ID of the product item.',
+                    type: 'string'
+                }
+            }
+        },
+        currency: {
+            label: 'Currency',
+            type: 'string',
+            description: 'Currency for the value specified as ISO 4217 code.',
+            default: {
+                '@path': '$.properties.currency'
+            }
+        },
+        value: {
+            label: 'Value',
+            type: 'number',
+            description: 'Value of the order or items sold.',
+            default: {
+                '@if': {
+                    exists: { '@path': '$.properties.value' },
+                    then: { '@path': '$.properties.value' },
+                    else: { '@path': '$.properties.revenue' }
+                }
+            }
+        },
+        description: {
+            label: 'Description',
+            type: 'string',
+            description: 'A string description of the web event.'
+        },
+        query: {
+            label: 'Query',
+            type: 'string',
+            description: 'The text string that was searched for.',
+            default: {
+                '@path': '$.properties.query'
+            }
         }
     },
     perform: (request, { payload, settings }) => {
-        const eventId = payload.event_id
-            ? payload.event_id.toString() + '_' + (Math.random() + 1).toString(36).substring(7)
-            : '';
         const userData = {
             hashedExternalId: formatter_1.formatUserId(payload.external_id),
-            hashedEmail: formatter_1.formatEmail(payload.email || ''),
+            hashedEmail: formatter_1.formatEmail(payload.email),
             hashedPhoneNumber: formatter_1.formatPhone(payload.phone_number)
         };
         return request('https://business-api.tiktok.com/open_api/v1.2/pixel/track/', {
@@ -105,7 +181,7 @@ const action = {
             json: {
                 pixel_code: settings.pixel_code,
                 event: payload.event,
-                event_id: eventId,
+                event_id: payload.event_id ? payload.event_id + '_seg' : undefined,
                 timestamp: payload.timestamp,
                 context: {
                     user: {
@@ -115,7 +191,20 @@ const action = {
                     },
                     ad: {
                         callback: payload.ttclid
-                    }
+                    },
+                    page: {
+                        url: payload.url,
+                        referrer: payload.referrer
+                    },
+                    ip: payload.ip,
+                    user_agent: payload.user_agent
+                },
+                properties: {
+                    contents: payload.contents,
+                    currency: payload.currency,
+                    value: payload.value,
+                    description: payload.description,
+                    query: payload.query
                 }
             }
         });

package/dist/destinations/tiktok-conversions/reportWebEvent/index.js.map

@@ -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,WAAW,EACT,mLAAmL;YACrL,OAAO,EAAE;gBACP,OAAO,EAAE,SAAS;aACnB;SACF;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;SACxE;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EAAE,sCAAsC;YACnD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE;gBACP,OAAO,EAAE,QAAQ;aAClB;SACF;QACD,UAAU,EAAE;YACV,KAAK,EAAE,sCAAsC;YAC7C,WAAW,EAAE,wEAAwE;YACrF,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,KAAK;SAChB;QAED,YAAY,EAAE;YACZ,KAAK,EAAE,cAAc;YACrB,WAAW,EACT,2GAA2G;YAC7G,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,EAAE,+DAA+D;YAC5E,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,EAAE,kEAAkE;YAC/E,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;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;KACF;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ;YAC9B,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;YACnF,CAAC,CAAC,EAAE,CAAA;QAEN,MAAM,QAAQ,GAAG;YACf,gBAAgB,EAAE,wBAAY,CAAC,OAAO,CAAC,WAAW,CAAC;YACnD,WAAW,EAAE,uBAAW,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;YAC7C,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,UAAU;gBAC/B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,QAAQ,EAAE,OAAO;gBACjB,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;iBACF;aACF;SACF,CAAC,CAAA;IACJ,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}
+{"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,UAAU;gBAC/B,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,GAAG,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

@@ -1,7 +1,7 @@
 {
   "name": "@segment/action-destinations",
   "description": "Destination Actions engine and definitions.",
-  "version": "3.49.2-alpha.1",
+  "version": "3.50.1-alpha.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",
@@ -38,8 +38,8 @@
   },
   "dependencies": {
     "@amplitude/ua-parser-js": "^0.7.25",
-    "@segment/actions-core": "^3.22.0",
-    "@segment/actions-shared": "^1.3.0",
+    "@segment/actions-core": "^3.22.1-alpha.3",
+    "@segment/actions-shared": "^1.3.1-alpha.3",
     "cheerio": "^1.0.0-rc.10",
     "dayjs": "^1.10.7",
     "escape-goat": "^3",
@@ -62,5 +62,5 @@
       "<rootDir>/test/setup-after-env.ts"
     ]
   },
-  "gitHead": "a6a50deefc81eaf55a4ef41acae01b36630a5e1f"
+  "gitHead": "5852addf626da5bb17b2d93e1dac2b5ef87b2266"
 }