cordova-plugin-tiktok
v1.0.0
Published
Cordova plugin for TikTok App Events SDK
Maintainers
Readme
cordova-plugin-tiktok
Cordova plugin for TikTok App Events SDK (iOS & Android).
Installation
cordova plugin add cordova-plugin-tiktokRequirements
- Cordova >= 9.0.0
- iOS >= 13.0
- Android >= API 21
- TikTok Events Manager credentials (Access Token & TikTok App ID)
Usage
Initialize
document.addEventListener('deviceready', async () => {
await window.TikTok.initialize({
accessToken: 'YOUR_ACCESS_TOKEN',
appId: 'com.your.app',
tiktokAppId: 'YOUR_TIKTOK_APP_ID'
});
});Track Events
// Standard event
await window.TikTok.trackEvent('Purchase', {
value: 9.99,
currency: 'USD',
content_id: 'product_123'
});
// Custom event
await window.TikTok.trackCustomEvent('card_created', {
card_type: 'gratitude'
});Standard events: CompleteRegistration, Subscribe, ViewContent, AddToCart, AddToWishlist, Checkout, Search, Purchase
User Identification
// Identify user (improves attribution)
await window.TikTok.identify({
externalId: 'user_123',
email: '[email protected]'
});
// Clear on logout
await window.TikTok.logout();API
| Method | Parameters | Description |
|--------|------------|-------------|
| initialize(config) | { accessToken, appId, tiktokAppId } | Initialize SDK |
| trackEvent(name, props?) | event name, properties object | Track standard event |
| trackCustomEvent(name, props?) | event name, properties object | Track custom event |
| identify(userInfo) | { externalId?, email?, phoneNumber?, externalUserName? } | Identify user |
| logout() | - | Clear user data |
License
MIT
