bytedance / tiktok-business-android-sdk

TikTok Business Mobile SDK for Reporting App Events

** For details including integration instructions, see the TikTok Business Mobile SDK Documentation. **

Objective

The TikTok Business SDK is the easiest way to log events (e.g. app install, purchase) in your mobile application and send these events to TikTok for targeting, measurement, conversion optimization, etc. We provide an Android SDK and an iOS SDK that you can integrate into your app easily.

Note In essence, the SDK reports app events through the App events marketing API. See the "Report App Events" documentation as a source of truth of the app events/properties TikTok marketing API accepts.**

How it Works

There are two types of app events:

• Automatically logged app events: The TikTok business SDK automatically logs InstallApp, LaunchAPP, 2Dretention, and (iOS only) Purchase app events.

• Manually logged app events: You can use the function provided by the TikTok business SDK to track events specific to your app. For a complete list of app events (and properties) supported by the TikTok marketing API, see the "Report App Events" marketing API documentation.

The TikTok business SDK takes the automatically/manually logged events, and reports these events to TikTok app events marketing API for downstream processing. The reported events will

• [Coming soon] Show up in reporting if attributed to TikTok.

• Be used for audience and DPA.

• Be used in optimization models based on app events.

Benefits

• Easiest way to log events (e.g. App install, purchase) in your mobile application and send these events to TikTok

  • Automatically logs InstallApp, LaunchAPP, 2Dretention, and (iOS only) Purchase.
  • Provides simple functions to manually log events.
  • Handles logic to save app events and flush app events to TikTok marketing API.

• Currently, advertisers are only able to send app event data through their measurement partners. Some advertisers prefer to directly send app event data to TikTok.

  • We may use this app event data for subsequent retargeting and dynamic product ads like we do with app event data forwarded from measurement partners.
  • In the near future, we will introduce our own attribution solutions and input into our optimization models based on these app events.

** For details including integration instructions, see the TikTok Business Mobile SDK Documentation. **

tiktok-business-android-sdk's Issues

Format Flaw

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/util/TimeUtil.java

Line 39 in 9424a95

return sdf.format(c1.getTime());

The methods parse() and format() in java.text.Format contains a race condition that can cause one user to see another user's data.

Unreleased Resource: Streams

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/util/HttpRequestUtil.java

Line 69 in 9424a95

result = streamToString(connection.getInputStream());

The GetInputStream could not be released correctly.Most unreleased resource issues cause general software reliability problems.However, if an attacker can intentionally trigger a resource leak, an attacker can launch a denial-of-service attack by depleting the resource pool.

[identify] - No static method encodeHexString

Hello,

I have an issue while trying to use identify method of the TikTokBusinessSdk.
I'm currently using version 1.2.6 of this library, and my targetSdkVersion and compileSdkVersion are 30.
I've set up the project following the documentation here

I got this error in console :

     Caused by: java.lang.NoSuchMethodError: No static method encodeHexString([B)Ljava/lang/String; in class Lorg/apache/commons/codec/binary/Hex; or its super classes (declaration of 'org.apache.commons.codec.binary.Hex' appears in /system/framework/org.apache.http.legacy.jar)
        at org.apache.commons.codec.digest.DigestUtils.sha256Hex(DigestUtils.java:722)
        at com.tiktok.appevents.TTUserInfo.toSha256(TTUserInfo.java:41)
        at com.tiktok.appevents.TTUserInfo.setExternalId(TTUserInfo.java:55)
        at com.tiktok.appevents.TTAppEventLogger.identify(TTAppEventLogger.java:181)
        at com.tiktok.TikTokBusinessSdk.identify(TikTokBusinessSdk.java:466)

I tried to add implementation 'commons-codec:commons-codec:1.15' in my build.gradle, but it doesn't fix the problem.

It seems that there are some compatibility issues between Apache DigestUtils and Android (see here - the post is old, but the problem still seems to be here).

Thank you !

Unreleased Resource: Streams

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/util/HttpRequestUtil.java

Line 126 in 9424a95

result = streamToString(connection.getInputStream());

The GetInputStream could not be released correctly.Most unreleased resource issues cause general software reliability problems.However, if an attacker can intentionally trigger a resource leak, an attacker can launch a denial-of-service attack by depleting the resource pool.

Format Flaw

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/appevents/TTAutoEventsManager.java

Line 104 in 9424a95

store.set(TTSDK_APP_LAST_LAUNCH, timeFormat.format(new Date()));

The methods parse() and format() in java.text.Format contains a race condition that can cause one user to see another user's data.

Format Flaw

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/appevents/TTAutoEventsManager.java

Line 95 in 9424a95

store.set(TTSDK_APP_2DR_TIME, timeFormat.format(now));

The methods parse() and format() in java.text.Format contains a race condition that can cause one user to see another user's data.

Format Flaw

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/appevents/TTAutoEventsManager.java

Line 66 in 9424a95

hm.put(TTSDK_APP_FIRST_INSTALL, timeFormat.format(now));

The methods parse() and format() in java.text.Format contains a race condition that can cause one user to see another user's data.

403 Forbidden for maven

As per your document i added below maven into project
maven { url 'https://dl.bintray.com/aweme-open-sdk-team/public' }

after adding maven url getting error 403 forbidden error for this url (https://dl.bintray.com/aweme-open-sdk-team/public)

Due to that project can not build successfully.

Format Flaw

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/util/TimeUtil.java

Line 28 in 9424a95

return df.format(date);

The methods parse() and format() in java.text.Format contains a race condition that can cause one user to see another user's data.

Unused Field

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/appevents/TTCrashHandler.java

Line 21 in e490c4c

private static volatile TTCrashHandler instance = new TTCrashHandler();

This field is never used.

Format Flaw

tiktok-business-android-sdk/business-core/src/main/java/com/tiktok/appevents/TTAutoEventsManager.java

Line 90 in 9424a95

Date firstLaunchTime = timeFormat.parse(firstInstall);

The methods parse() and format() in java.text.Format contains a race condition that can cause one user to see another user's data.