Update TikTok Pixel Destination #1937
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| import { InputField } from '@segment/actions-core' | ||
|
|
||
| export const commonFields: Record<string, InputField> = { | ||
| event: { | ||
| label: 'Event Name', | ||
| type: 'string', | ||
| required: true, | ||
| description: | ||
| 'Conversion event name. Please refer to the "Supported Web Events" section on in TikTok’s [Pixel SDK documentation](https://business-api.tiktok.com/portal/docs?id=1739585696931842) 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' | ||
| } | ||
| }, | ||
| phone_number: { | ||
| label: 'Phone Number', | ||
| description: | ||
| 'A single phone number in E.164 standard format. TikTok Pixel 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. TikTok Pixel will be 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. TikTok Pixel will hash this value before sending to TikTok.', | ||
| type: 'string', | ||
| multiple: true, | ||
| default: { | ||
| '@if': { | ||
| exists: { '@path': '$.userId' }, | ||
| then: { '@path': '$.userId' }, | ||
| else: { '@path': '$.anonymousId' } | ||
| } | ||
| } | ||
| }, | ||
| 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' | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| /* eslint-disable */ | ||
| // @ts-nocheck | ||
| export function initScript(settings) { | ||
| !(function (w, d, t) { | ||
| w.TiktokAnalyticsObject = t | ||
| var ttq = (w[t] = w[t] || []) | ||
|
|
@@ -44,7 +44,9 @@ export function initScript(pixelCode) { | |
| a.parentNode.insertBefore(o, a) | ||
| }) | ||
|
|
||
| ttq.load(settings.pixelCode, { | ||
| limited_data_use: settings.ldu ? settings.ldu : false | ||
| }) | ||
| ttq.page() | ||
| })(window, document, 'ttq') | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,3 +16,8 @@ export function formatPhone(phone: string | undefined): string | undefined { | |
| formattedPhone = formattedPhone.substring(0, 15) | ||
| return formattedPhone | ||
| } | ||
|
|
||
| export function handleArrayInput(array: string[] | undefined): string { | ||
| if (!array) return '' | ||
| return array[0] | ||
| } | ||
|
There was a problem hiding this comment. Should we also handle the case where 'array' is empty? |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like you are changing this from a string to be a string array. It should be fine, but is this deliberate?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed this to be a string array to match the s2s destination mappings, so that clients can re-use the same mappings for both Pixel & S2S destinations.