@segment/action-destinations 3.339.0-staging.0 → 3.339.0

package/dist/destinations/tiktok-conversions-sandbox/common_fields.js

@@ -0,0 +1,244 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.commonFields = void 0;
+exports.commonFields = {
+    event: {
+        label: 'Event Name',
+        type: 'string',
+        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',
+        type: 'string',
+        description: 'Any hashed ID that can identify a unique user/session.',
+        default: {
+            '@path': '$.messageId'
+        }
+    },
+    timestamp: {
+        label: 'Event Timestamp',
+        type: 'string',
+        description: 'Timestamp that the event took place, in ISO 8601 format.',
+        default: {
+            '@path': '$.timestamp'
+        }
+    },
+    phone_number: {
+        label: 'Phone Number',
+        description: 'A single phone number or array of phone numbers in E.164 standard format. Segment will hash this value before sending to TikTok. e.g. +14150000000. Segment will hash this value before sending to TikTok.',
+        type: 'string',
+        multiple: true,
+        default: {
+            '@if': {
+                exists: { '@path': '$.properties.phone' },
+                then: { '@path': '$.properties.phone' },
+                else: { '@path': '$.context.traits.phone' }
+            }
+        }
+    },
+    email: {
+        label: 'Email',
+        description: 'A single email address or an array of email addresses. Segment will hash this value before sending to TikTok.',
+        type: 'string',
+        multiple: true,
+        default: {
+            '@if': {
+                exists: { '@path': '$.properties.email' },
+                then: { '@path': '$.properties.email' },
+                else: { '@path': '$.context.traits.email' }
+            }
+        }
+    },
+    order_id: {
+        label: 'Order ID',
+        type: 'string',
+        description: 'Order ID of the transaction.',
+        default: {
+            '@path': '$.properties.order_id'
+        }
+    },
+    shop_id: {
+        label: 'Shop ID',
+        type: 'string',
+        description: 'Shop ID of the transaction.',
+        default: {
+            '@path': '$.properties.shop_id'
+        }
+    },
+    external_id: {
+        label: 'External ID',
+        description: 'Uniquely identifies the user who triggered the conversion event. Segment will hash this value before sending to TikTok. TikTok Conversions Destination supports both string and string[] types for sending external ID(s).',
+        type: 'string',
+        multiple: true,
+        default: {
+            '@if': {
+                exists: { '@path': '$.userId' },
+                then: { '@path': '$.userId' },
+                else: { '@path': '$.anonymousId' }
+            }
+        }
+    },
+    ttclid: {
+        label: 'TikTok Click ID',
+        description: 'The value of the ttclid used to match website visitor events with TikTok ads. The ttclid is valid for 7 days. See [Set up ttclid](https://ads.tiktok.com/marketing_api/docs?rid=4eezrhr6lg4&id=1681728034437121) for details.',
+        type: 'string',
+        default: {
+            '@if': {
+                exists: { '@path': '$.properties.ttclid' },
+                then: { '@path': '$.properties.ttclid' },
+                else: { '@path': '$.integrations.TikTok Conversions.ttclid' }
+            }
+        }
+    },
+    ttp: {
+        label: 'TikTok Cookie ID',
+        description: 'TikTok Cookie ID. If you also use Pixel SDK and have enabled cookies, Pixel SDK automatically saves a unique identifier in the `_ttp` cookie. The value of `_ttp` is used to match website visitor events with TikTok ads. You can extract the value of `_ttp` and attach the value here. To learn more about the `ttp` parameter, refer to [Events API 2.0 - Send TikTok Cookie](https://ads.tiktok.com/marketing_api/docs?id=%201771100936446977) (`_ttp`).',
+        type: 'string',
+        default: {
+            '@if': {
+                exists: { '@path': '$.properties.ttp' },
+                then: { '@path': '$.properties.ttp' },
+                else: { '@path': '$.integrations.TikTok Conversions.ttp' }
+            }
+        }
+    },
+    lead_id: {
+        label: 'TikTok Lead ID',
+        description: 'ID of TikTok leads. Every lead will have its own lead_id when exported from TikTok. This feature is in Beta. Please contact your TikTok representative to inquire regarding availability',
+        type: 'string',
+        default: { '@path': '$.properties.lead_id' }
+    },
+    locale: {
+        label: 'Locale',
+        description: 'The BCP 47 language identifier. For reference, refer to the [IETF BCP 47 standardized code](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).',
+        type: 'string',
+        default: {
+            '@path': '$.context.locale'
+        }
+    },
+    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 item details for the event.',
+        properties: {
+            price: {
+                label: 'Price',
+                description: 'Price of the item.',
+                type: 'number'
+            },
+            quantity: {
+                label: 'Quantity',
+                description: 'Number of items.',
+                type: 'number'
+            },
+            content_category: {
+                label: 'Content Category',
+                description: 'Category of the product item.',
+                type: 'string'
+            },
+            content_id: {
+                label: 'Content ID',
+                description: 'ID of the product item.',
+                type: 'string'
+            },
+            content_name: {
+                label: 'Content Name',
+                description: 'Name of the product item.',
+                type: 'string'
+            },
+            brand: {
+                label: 'Brand',
+                description: 'Brand name of the product item.',
+                type: 'string'
+            }
+        }
+    },
+    content_type: {
+        label: 'Content Type',
+        description: 'Type of the product item. When the `content_id` in the `Contents` field is specified as a `sku_id`, set this field to `product`. When the `content_id` in the `Contents` field is specified as an `item_group_id`, set this field to `product_group`.',
+        type: 'string',
+        choices: [{ label: 'product', value: 'product' }, { label: 'product_group', value: 'product_group' }],
+        default: 'product'
+    },
+    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'
+        }
+    },
+    limited_data_use: {
+        label: 'Limited Data Use',
+        type: 'boolean',
+        description: 'Use this field to flag an event for limited data processing. TikTok will recognize this parameter as a request for limited data processing, and will limit its processing activities accordingly if the event shared occurred in an eligible location. To learn more about the Limited Data Use feature, refer to [Events API 2.0 - Limited Data Use](https://ads.tiktok.com/marketing_api/docs?id=1771101204435970).',
+        default: {
+            '@path': '$.properties.limited_data_use'
+        }
+    },
+    test_event_code: {
+        label: 'Test Event Code',
+        type: 'string',
+        description: 'Use this field to specify that events should be test events rather than actual traffic. You can find your Test Event Code in your TikTok Events Manager under the "Test Event" tab. You\'ll want to remove your Test Event Code when sending real traffic through this integration.'
+    }
+};
+//# sourceMappingURL=common_fields.js.map

package/dist/destinations/tiktok-conversions-sandbox/common_fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common_fields.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions-sandbox/common_fields.ts"],"names":[],"mappings":";;;AAEa,QAAA,YAAY,GAA+B;IACtD,KAAK,EAAE;QACL,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EACT,8MAA8M;KACjN;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wDAAwD;QACrE,OAAO,EAAE;YACP,OAAO,EAAE,aAAa;SACvB;KACF;IACD,SAAS,EAAE;QACT,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,0DAA0D;QACvE,OAAO,EAAE;YACP,OAAO,EAAE,aAAa;SACvB;KACF;IACD,YAAY,EAAE;QACZ,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,4MAA4M;QAC9M,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aAC5C;SACF;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,WAAW,EACT,+GAA+G;QACjH,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,wBAAwB,EAAE;aAC5C;SACF;KACF;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,8BAA8B;QAC3C,OAAO,EAAE;YACP,OAAO,EAAE,uBAAuB;SACjC;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,SAAS;QAChB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,6BAA6B;QAC1C,OAAO,EAAE;YACP,OAAO,EAAE,sBAAsB;SAChC;KACF;IACD,WAAW,EAAE;QACX,KAAK,EAAE,aAAa;QACpB,WAAW,EACT,4NAA4N;QAC9N,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;gBAC/B,IAAI,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;gBAC7B,IAAI,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;aACnC;SACF;KACF;IACD,MAAM,EAAE;QACN,KAAK,EAAE,iBAAiB;QACxB,WAAW,EACT,+NAA+N;QACjO,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;gBAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE;gBACxC,IAAI,EAAE,EAAE,OAAO,EAAE,0CAA0C,EAAE;aAC9D;SACF;KACF;IACD,GAAG,EAAE;QACH,KAAK,EAAE,kBAAkB;QACzB,WAAW,EACT,+bAA+b;QACjc,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE;gBACrC,IAAI,EAAE,EAAE,OAAO,EAAE,uCAAuC,EAAE;aAC3D;SACF;KACF;IACD,OAAO,EAAE;QACP,KAAK,EAAE,gBAAgB;QACvB,WAAW,EACT,0LAA0L;QAC5L,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;KAC7C;IACD,MAAM,EAAE;QACN,KAAK,EAAE,QAAQ;QACf,WAAW,EACT,4IAA4I;QAC9I,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;YACP,OAAO,EAAE,kBAAkB;SAC5B;KACF;IACD,GAAG,EAAE;QACH,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,qDAAqD;QAClE,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oBAAoB;QACjC,OAAO,EAAE;YACP,OAAO,EAAE,yBAAyB;SACnC;KACF;IACD,EAAE,EAAE;QACF,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,4BAA4B;QACzC,OAAO,EAAE;YACP,OAAO,EAAE,cAAc;SACxB;KACF;IACD,UAAU,EAAE;QACV,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oCAAoC;QACjD,OAAO,EAAE;YACP,OAAO,EAAE,qBAAqB;SAC/B;KACF;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,qCAAqC;QAClD,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,oBAAoB;gBACjC,IAAI,EAAE,QAAQ;aACf;YACD,QAAQ,EAAE;gBACR,KAAK,EAAE,UAAU;gBACjB,WAAW,EAAE,kBAAkB;gBAC/B,IAAI,EAAE,QAAQ;aACf;YACD,gBAAgB,EAAE;gBAChB,KAAK,EAAE,kBAAkB;gBACzB,WAAW,EAAE,+BAA+B;gBAC5C,IAAI,EAAE,QAAQ;aACf;YACD,UAAU,EAAE;gBACV,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,yBAAyB;gBACtC,IAAI,EAAE,QAAQ;aACf;YACD,YAAY,EAAE;gBACZ,KAAK,EAAE,cAAc;gBACrB,WAAW,EAAE,2BAA2B;gBACxC,IAAI,EAAE,QAAQ;aACf;YACD,KAAK,EAAE;gBACL,KAAK,EAAE,OAAO;gBACd,WAAW,EAAE,iCAAiC;gBAC9C,IAAI,EAAE,QAAQ;aACf;SACF;KACF;IACD,YAAY,EAAE;QACZ,KAAK,EAAE,cAAc;QACrB,WAAW,EACT,uPAAuP;QACzP,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAE,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;QACtG,OAAO,EAAE,SAAS;KACnB;IACD,QAAQ,EAAE;QACR,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE;YACP,OAAO,EAAE,uBAAuB;SACjC;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,mCAAmC;QAChD,OAAO,EAAE;YACP,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACzC,IAAI,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE;gBACvC,IAAI,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE;aAC1C;SACF;KACF;IACD,WAAW,EAAE;QACX,KAAK,EAAE,aAAa;QACpB,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wCAAwC;KACtD;IACD,KAAK,EAAE;QACL,KAAK,EAAE,OAAO;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wCAAwC;QACrD,OAAO,EAAE;YACP,OAAO,EAAE,oBAAoB;SAC9B;KACF;IACD,gBAAgB,EAAE;QAChB,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,SAAS;QACf,WAAW,EACT,uZAAuZ;QACzZ,OAAO,EAAE;YACP,OAAO,EAAE,+BAA+B;SACzC;KACF;IACD,eAAe,EAAE;QACf,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,qRAAqR;KACxR;CACF,CAAA"}

package/dist/destinations/tiktok-conversions-sandbox/formatter.d.ts

@@ -0,0 +1,3 @@
+export declare const formatEmails: (email_addresses: string[] | undefined) => string[];
+export declare const formatPhones: (phone_numbers: string[] | undefined) => string[];
+export declare function formatUserIds(userIds: string[] | undefined): string[];

package/dist/destinations/tiktok-conversions-sandbox/formatter.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatUserIds = exports.formatPhones = exports.formatEmails = void 0;
+const crypto_1 = require("crypto");
+const formatEmails = (email_addresses) => {
+    const result = [];
+    if (email_addresses) {
+        email_addresses.forEach((email) => {
+            result.push(hashAndEncode(email.toLowerCase()));
+        });
+    }
+    return result;
+};
+exports.formatEmails = formatEmails;
+const formatPhones = (phone_numbers) => {
+    const result = [];
+    if (!phone_numbers)
+        return result;
+    phone_numbers.forEach((phone) => {
+        const validatedPhone = phone.match(/[0-9]{0,14}/g);
+        if (validatedPhone === null) {
+            throw new Error(`${phone} is not a valid E.164 phone number.`);
+        }
+        const formattedPhone = `+${phone.replace(/[^0-9]/g, '')}`;
+        result.push(hashAndEncode(formattedPhone.substring(0, 15)));
+    });
+    return result;
+};
+exports.formatPhones = formatPhones;
+function formatUserIds(userIds) {
+    const result = [];
+    if (userIds) {
+        userIds.forEach((userId) => {
+            result.push(hashAndEncode(userId.toLowerCase()));
+        });
+    }
+    return result;
+}
+exports.formatUserIds = formatUserIds;
+function hashAndEncode(property) {
+    return crypto_1.createHash('sha256').update(property).digest('hex');
+}
+//# sourceMappingURL=formatter.js.map

package/dist/destinations/tiktok-conversions-sandbox/formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatter.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions-sandbox/formatter.ts"],"names":[],"mappings":";;;AAAA,mCAAmC;AAK5B,MAAM,YAAY,GAAG,CAAC,eAAqC,EAAY,EAAE;IAC9E,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,eAAe,EAAE;QACnB,eAAe,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;YACxC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;KACH;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AARY,QAAA,YAAY,gBAQxB;AAOM,MAAM,YAAY,GAAG,CAAC,aAAmC,EAAY,EAAE;IAC5E,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,CAAC,aAAa;QAAE,OAAO,MAAM,CAAA;IAEjC,aAAa,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,EAAE;QACtC,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;QAClD,IAAI,cAAc,KAAK,IAAI,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,qCAAqC,CAAC,CAAA;SAC/D;QAED,MAAM,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,CAAA;QAEzD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;IAC7D,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAhBY,QAAA,YAAY,gBAgBxB;AAOD,SAAgB,aAAa,CAAC,OAA6B;IACzD,MAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,OAAO,CAAC,CAAC,MAAc,EAAE,EAAE;YACjC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QAClD,CAAC,CAAC,CAAA;KACH;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AARD,sCAQC;AAED,SAAS,aAAa,CAAC,QAAgB;IACrC,OAAO,mBAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC5D,CAAC"}

package/dist/destinations/tiktok-conversions-sandbox/generated-types.d.ts

@@ -0,0 +1,4 @@
+export interface Settings {
+    accessToken: string;
+    pixelCode: string;
+}

package/dist/destinations/tiktok-conversions-sandbox/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/tiktok-conversions-sandbox/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions-sandbox/generated-types.ts"],"names":[],"mappings":""}

package/dist/destinations/tiktok-conversions-sandbox/index.d.ts

@@ -0,0 +1,4 @@
+import type { DestinationDefinition } from '@segment/actions-core';
+import type { Settings } from './generated-types';
+declare const destination: DestinationDefinition<Settings>;
+export default destination;

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

@@ -0,0 +1,247 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const actions_core_1 = require("@segment/actions-core");
+const reportWebEvent_1 = __importDefault(require("./reportWebEvent"));
+const productProperties = {
+    price: {
+        '@path': '$.price'
+    },
+    quantity: {
+        '@path': '$.quantity'
+    },
+    content_category: {
+        '@path': '$.category'
+    },
+    content_id: {
+        '@path': '$.product_id'
+    },
+    content_name: {
+        '@path': '$.name'
+    },
+    brand: {
+        '@path': '$.brand'
+    }
+};
+const singleProductContents = {
+    ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+    contents: {
+        '@arrayPath': [
+            '$.properties',
+            {
+                ...productProperties
+            }
+        ]
+    }
+};
+const multiProductContents = {
+    ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+    contents: {
+        '@arrayPath': [
+            '$.properties.products',
+            {
+                ...productProperties
+            }
+        ]
+    }
+};
+const destination = {
+    name: 'Tiktok Conversions Sandbox',
+    slug: 'tiktok-conversions-sandbox',
+    mode: 'cloud',
+    authentication: {
+        scheme: 'custom',
+        fields: {
+            accessToken: {
+                label: 'Access Token',
+                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.',
+                type: 'string',
+                required: true
+            },
+            pixelCode: {
+                label: 'Pixel Code',
+                type: 'string',
+                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.',
+                required: true
+            }
+        },
+        testAuthentication: (request, { settings }) => {
+            return request('https://business-api.tiktok.com/open_api/v1.3/pixel/track/', {
+                method: 'post',
+                json: {
+                    pixel_code: settings.pixelCode,
+                    event: 'Test Event',
+                    timestamp: '',
+                    context: {}
+                }
+            });
+        }
+    },
+    extendRequest({ settings }) {
+        return {
+            headers: {
+                'Access-Token': settings.accessToken,
+                'Content-Type': 'application/json'
+            }
+        };
+    },
+    presets: [
+        {
+            name: 'Complete Payment',
+            subscribe: 'event = "Order Completed"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'CompletePayment'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Contact',
+            subscribe: 'event = "Callback Started"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+                event: 'Contact'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Subscribe',
+            subscribe: 'event = "Subscription Created"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+                event: 'Subscribe'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Submit Form',
+            subscribe: 'event = "Form Submitted"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+                event: 'SubmitForm'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Page View',
+            subscribe: 'type="page"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'PageView'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'View Content',
+            subscribe: 'event = "Product Viewed"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'ViewContent'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Click Button',
+            subscribe: 'event = "Product Clicked"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'ClickButton'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Search',
+            subscribe: 'event = "Products Searched"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'Search'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Add to Wishlist',
+            subscribe: 'event = "Product Added to Wishlist"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'AddToWishlist'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Add to Cart',
+            subscribe: 'event = "Product Added"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...singleProductContents,
+                event: 'AddToCart'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Initiate Checkout',
+            subscribe: 'event = "Checkout Started"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'InitiateCheckout'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Add Payment Info',
+            subscribe: 'event = "Payment Info Entered"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'AddPaymentInfo'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Place an Order',
+            subscribe: 'event = "Order Placed"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...multiProductContents,
+                event: 'PlaceAnOrder'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Download',
+            subscribe: 'event = "Download Link Clicked"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+                event: 'Download'
+            },
+            type: 'automatic'
+        },
+        {
+            name: 'Complete Registration',
+            subscribe: 'event = "Signed Up"',
+            partnerAction: 'reportWebEvent',
+            mapping: {
+                ...actions_core_1.defaultValues(reportWebEvent_1.default.fields),
+                event: 'CompleteRegistration'
+            },
+            type: 'automatic'
+        }
+    ],
+    actions: {
+        reportWebEvent: reportWebEvent_1.default
+    }
+};
+exports.default = destination;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/tiktok-conversions-sandbox/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,gBAAgB,EAAE;QAChB,OAAO,EAAE,YAAY;KACtB;IACD,UAAU,EAAE;QACV,OAAO,EAAE,cAAc;KACxB;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,QAAQ;KAClB;IACD,KAAK,EAAE;QACL,OAAO,EAAE,SAAS;KACnB;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;AAED,MAAM,WAAW,GAAoC;IAInD,IAAI,EAAE,4BAA4B;IAClC,IAAI,EAAE,4BAA4B;IAClC,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;gBACP,cAAc,EAAE,QAAQ,CAAC,WAAW;gBACpC,cAAc,EAAE,kBAAkB;aACnC;SACF,CAAA;IACH,CAAC;IACD,OAAO,EAAE;QACP;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,2BAA2B;YACtC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,iBAAiB;aACzB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,SAAS;YACf,SAAS,EAAE,4BAA4B;YACvC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,SAAS;aACjB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,WAAW;aACnB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,0BAA0B;YACrC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,YAAY;aACpB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,aAAa;YACxB,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,UAAU;aAClB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,0BAA0B;YACrC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,aAAa;aACrB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,cAAc;YACpB,SAAS,EAAE,2BAA2B;YACtC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,aAAa;aACrB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,6BAA6B;YACxC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,QAAQ;aAChB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,iBAAiB;YACvB,SAAS,EAAE,qCAAqC;YAChD,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,eAAe;aACvB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,yBAAyB;YACpC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,qBAAqB;gBACxB,KAAK,EAAE,WAAW;aACnB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,mBAAmB;YACzB,SAAS,EAAE,4BAA4B;YACvC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,kBAAkB;aAC1B;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,SAAS,EAAE,gCAAgC;YAC3C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,gBAAgB;aACxB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,gBAAgB;YACtB,SAAS,EAAE,wBAAwB;YACnC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,oBAAoB;gBACvB,KAAK,EAAE,cAAc;aACtB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,UAAU;YAChB,SAAS,EAAE,iCAAiC;YAC5C,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,UAAU;aAClB;YACD,IAAI,EAAE,WAAW;SAClB;QACD;YACE,IAAI,EAAE,uBAAuB;YAC7B,SAAS,EAAE,qBAAqB;YAChC,aAAa,EAAE,gBAAgB;YAC/B,OAAO,EAAE;gBACP,GAAG,4BAAa,CAAC,wBAAc,CAAC,MAAM,CAAC;gBACvC,KAAK,EAAE,sBAAsB;aAC9B;YACD,IAAI,EAAE,WAAW;SAClB;KACF;IACD,OAAO,EAAE;QACP,cAAc,EAAd,wBAAc;KACf;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.d.ts

@@ -0,0 +1,33 @@
+export interface Payload {
+    event: string;
+    event_id?: string;
+    timestamp?: string;
+    phone_number?: string[];
+    email?: string[];
+    order_id?: string;
+    shop_id?: string;
+    external_id?: string[];
+    ttclid?: string;
+    ttp?: string;
+    lead_id?: string;
+    locale?: string;
+    url?: string;
+    referrer?: string;
+    ip?: string;
+    user_agent?: string;
+    contents?: {
+        price?: number;
+        quantity?: number;
+        content_category?: string;
+        content_id?: string;
+        content_name?: string;
+        brand?: string;
+    }[];
+    content_type?: string;
+    currency?: string;
+    value?: number;
+    description?: string;
+    query?: string;
+    limited_data_use?: boolean;
+    test_event_code?: string;
+}

package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generated-types.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions-sandbox/reportWebEvent/generated-types.ts"],"names":[],"mappings":""}

package/dist/destinations/tiktok-conversions-sandbox/reportWebEvent/index.d.ts

@@ -0,0 +1,5 @@
+import { ActionDefinition } from '@segment/actions-core';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: ActionDefinition<Settings, Payload>;
+export default action;

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_fields_1 = require("../common_fields");
+const utils_1 = require("../utils");
+const action = {
+    title: 'Report Web Event',
+    description: 'Report Web events directly to TikTok. Data shared can power TikTok solutions like dynamic product ads, custom targeting, campaign optimization and attribution.',
+    fields: {
+        ...common_fields_1.commonFields
+    },
+    perform: (request, { payload, settings }) => {
+        return utils_1.performWebEvent(request, settings, payload);
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/tiktok-conversions-sandbox/reportWebEvent/index.ts"],"names":[],"mappings":";;AAGA,oDAA+C;AAC/C,oCAA0C;AAE1C,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,iKAAiK;IACnK,MAAM,EAAE;QACN,GAAG,4BAAY;KAChB;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC1C,OAAO,uBAAe,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAA;IACpD,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/destinations/tiktok-conversions-sandbox/utils.d.ts

@@ -0,0 +1,4 @@
+import { RequestClient } from '@segment/actions-core';
+import { Settings } from './generated-types';
+import { Payload } from './reportWebEvent/generated-types';
+export declare function performWebEvent(request: RequestClient, settings: Settings, payload: Payload): Promise<import("@segment/actions-core").ModifiedResponse<unknown>>;