Update TikTok Pixel Destination #1937
Conversation
packages/browser-destinations/destinations/tiktok-pixel/src/index.ts
Outdated
Show resolved
Hide resolved
packages/browser-destinations/destinations/tiktok-pixel/src/reportWebEvent/index.ts
Outdated
Show resolved
Hide resolved
packages/browser-destinations/destinations/tiktok-pixel/src/reportWebEvent/index.ts
Outdated
Show resolved
Hide resolved
packages/browser-destinations/destinations/tiktok-pixel/src/index.ts
Outdated
Show resolved
Hide resolved
| }, | ||
| useExistingPixel: { | ||
| // TODO: HOW TO DELETE (reusing will not include Segment Partner name) | ||
| label: '[Deprecated]Use Existing Pixel', |
There was a problem hiding this comment.
| label: '[Deprecated]Use Existing Pixel', | |
| label: '[Deprecated] Use Existing Pixel', |
| */ | ||
| event: string | ||
| /** | ||
| * Any hashed ID that can identify a unique user/session. | ||
| */ | ||
| event_id?: string | ||
| /** | ||
| * 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. | ||
| * 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. |
There was a problem hiding this comment.
The Offline Conversions desription for this field also includes the following:
At least one phone number value is required if both Email and External ID fields are empty.
Should this apply for TikTok pixel as well?
| /** | ||
| * Email address of the user who triggered the conversion event. Segment will hash this value before sending to TikTok. | ||
| * A single email address. TikTok Pixel will be hash this value before sending to TikTok. |
There was a problem hiding this comment.
The same field in the TikTok Offline Conversions Destination also includes the following:
At least one email value is required if both Phone Number and External ID fields are empty.
Should this apply for TikTok pixel as well?
| */ | ||
| shop_id?: string | ||
| /** | ||
| * Uniquely identifies the user who triggered the conversion event. TikTok Pixel will hash this value before sending to TikTok. |
There was a problem hiding this comment.
TikTok Offline Conversions also includes the following:
TikTok Offline Conversions Destination supports both string and string[] types for sending external ID(s). At least one external ID value is required if both Email and Phone Number fields are empty.
Should something similar apply for TikTok Pixel?
| description: | ||
| 'Uniquely identifies the user who triggered the conversion event. TikTok Pixel will hash this value before sending to TikTok.', | ||
| type: 'string', | ||
| multiple: true, |
There was a problem hiding this comment.
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.
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.
| email: handleArrayInput(payload.email), | ||
| phone_number: formatPhone(handleArrayInput(payload.phone_number)), | ||
| external_id: handleArrayInput(payload.external_id) |
There was a problem hiding this comment.
Has this been tested so that it works if a single string or an array of strings has been passed in? I'm thinking it might need to be able to handle both?
There was a problem hiding this comment.
I thought it would only need to handle string array since the parameter type defined as string array in the common_fields - will those variables come in as string types?
| 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?
Should we also handle the case where array is a single string? i.e not an array?
Is it intentional that only the first item from the array is being forwarded on to TikTok?
* add all presets for pixel sdk & update event properties support * update default values & global settings * use existing pixel setting * revert pixel init script * update --------- Co-authored-by: Jaehyuk Rhee <jaehyuk.rhee@bytedance.com>
|
PR deployed |
Update TikTok Pixel Destination to support all TikTok standard web events & event properties.