Skip to content

Latest commit

 

History

History
61 lines (33 loc) · 3.28 KB

README.md

File metadata and controls

61 lines (33 loc) · 3.28 KB

TikTok Managed Component

Find out more about Managed Components here for inspiration and motivation details.

Released under the Apache license. PRs welcome! code style: prettier

🚀 Quickstart local dev environment

  1. Make sure you're running node version >=17.
  2. Install dependencies with npm i
  3. Run unit test watcher with npm run test:dev

⚙️ Tool Settings

Settings are used to configure the tool in a Component Manager config file

Pixel Code string required

pixelCode is a long number that identifies your Facebook Ads account.

API Access Token required

accessToken is a string used to authenticate when sending server side events in your name. You can obtain it following the information here.

Test Event Code

testKey is used to test your app or web browser events using test events tool Learn more

🧱 Fields Description

Fields are properties that can/must be sent with certain events

Tiktok Standard Event Name string required

ev can be "ContentView", "PlaceAnOrder", "Add to Cart" one of the standard Tiktok events.

Custom Event Name string required

cev can be any custom event name. Do not use sensitive words in the name of Custom Events. Learn more.

Email string

email user email. Automatically hashed.

Phone string

phone The phone number of the customer. Normalize the phone number to E.164 format (for example, '+12133734253'). Country code must be included and prefixed with the '+' sign, without any parentheses or leading '0's. No spaces, letters or symbols except the '+' for the country code are included. Zaraz will SHA-256 hash the phone number automatically. Learn more.

Limited Data Use string

ldu can be true or false. If set to 'true', 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. Learn more.

External ID string

external_id IDs that represent any unique identifier on the advertiser's side, such as loyalty membership IDs, user IDs, and external cookie IDs. Automatically hashed.

TikTok Pixel Cookie ID string

ttp can be _ttp Cookie value. 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. Learn more.