tiktok_business_sdk

A Flutter plugin that provides easy integration with TikTok Business SDK for Android and iOS platforms.

Features

🔧 SDK Initialization: Initialize TikTok Business SDK with your app credentials
👤 User Identification: Set user identity for personalized tracking
📊 Event Tracking: Track custom events and user actions
🔐 Authentication: Handle user login/logout states
🎯 Cross-Platform: Works on both Android and iOS
🐛 Debug Mode: Enable debug mode for development and testing

Getting Started

Prerequisites

Flutter SDK: >=3.3.0
Dart SDK: ^3.9.0
Android: API level 21+
iOS: iOS 11.0+

Installation

Add this to your package's pubspec.yaml file:

dependencies:
  tiktok_business_sdk: ^0.0.1

Then run:

flutter pub get

Platform Setup

Android

Add the following to your android/app/build.gradle:

android {
    defaultConfig {
        minSdkVersion 21
    }
}

Ensure required permissions in android/app/src/main/AndroidManifest.xml:

<manifest ...>
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <!-- Add any additional permissions as required by your integration -->
    <application ...>
        <!-- Your existing configuration -->
    </application>
</manifest>

For the latest Android integration requirements, refer to TikTok Business documentation: Android Integration Guide.

iOS

Set platform in your ios/Podfile:

platform :ios, '11.0'

Add the tracking usage description in your Info.plist:

<key>NSUserTrackingUsageDescription</key>
<string>We need your permission to track your usage of this app</string>

In your AppDelegate (which extends FlutterAppDelegate), request tracking authorization, e.g.:

import UIKit
import Flutter
import TikTokBusinessSDK

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }

  override func applicationDidBecomeActive(_ application: UIApplication) {
    super.applicationDidBecomeActive(application)
    TikTokBusiness.requestTrackingAuthorization()
  }
}

For the latest iOS integration requirements, refer to TikTok Business documentation: iOS Integration Guide.

After making changes, run:

cd ios && pod install

Usage

1. Initialize the SDK

import 'package:tiktok_business_sdk/tiktok_business_sdk.dart';

final tiktokSdk = TiktokBusinessSdk();

// Initialize the SDK
await tiktokSdk.initTiktokBusinessSdk(
  accessToken: 'your_access_token',
  appId: 'your_app_id',
  ttAppId: 'your_tiktok_app_id',
  openDebug: true, // Enable debug mode
  enableAutoIapTrack: true, // Enable automatic in-app purchase tracking
);

2. Set User Identity

// Identify a user
await tiktokSdk.setIdentify(
  externalId: 'user_123',
  externalUserName: 'john_doe',
  phoneNumber: '+1234567890',
  email: '[email protected]',
);

3. Track Events

// Track a login event
await tiktokSdk.trackTTEvent(
  event: EventName.login,
  eventId: 'login_123',
);

// Track a purchase event
await tiktokSdk.trackTTEvent(
  event: EventName.addPaymentInfo,
  eventId: 'purchase_456',
);

// Track without event ID
await tiktokSdk.trackTTEvent(
  event: EventName.completeTutorial,
);

4. Logout

// Logout user
await tiktokSdk.logout();

Available Events

The plugin provides a comprehensive set of predefined events:

Event	Description
`EventName.achieveLevel`	User achieved a level
`EventName.addPaymentInfo`	User added payment information
`EventName.completeTutorial`	User completed tutorial
`EventName.createGroup`	User created a group
`EventName.createRole`	User created a role
`EventName.generateLead`	Generated a lead
`EventName.inAppAdClick`	User clicked in-app ad
`EventName.inAppAdImpr`	In-app ad impression
`EventName.installApp`	App installation
`EventName.joinGroup`	User joined a group
`EventName.launchApp`	App launch
`EventName.loanApplication`	Loan application submitted
`EventName.loanApproval`	Loan approved
`EventName.loanDisbursal`	Loan disbursed
`EventName.login`	User login
`EventName.rate`	User rating
`EventName.registration`	User registration
`EventName.search`	Search performed
`EventName.spendCredits`	Credits spent
`EventName.startTrial`	Trial started
`EventName.subscribe`	User subscription
`EventName.impressionLevelAdRevenue`	Ad revenue impression
`EventName.unlockAchievement`	Achievement unlocked

API Reference