Quick Tracking:Import & configure the SDK

SDK basic information

1 Quick integration

Quick Tracking generates unique integration code for each app. Follow the in-product guide to complete the integration.Note: If you are already using the Umeng+ SDK, you must change the SDK file path. For more information, see section 1.2 in this document.

1.1 Product path

Go to the Quick Tracking homepage and open the Management Console. Navigate to the Organization List, find the organization that contains your application, and click Manage Application. On the Application Management page, click Integrate next to your application.

After you click Integrate, a new page appears where you can obtain the unique integration code. Click Next to proceed to Integration Validation. You can then scan the QR code to launch the app and confirm that the integration was successful.

1.2 Check for conflicts with the Umeng+ SDK

Note: If you are already using the Umeng+ SDK, you must change the SDK file path.

2 Detailed integration code

If you cannot access the page mentioned in the previous section for any reason and need to use this document for the integration, the detailed integration code is provided in the following sections.

2.1 Prepare parameters

appKey: Obtain this from the application list.

Data collection domain name: Obtain this from the Collect Information module in the Management Console.

SDK information: Obtain this from the Collect Information module in the Management Console.Add web link

2.2 Import the SDK

2.2.1 Automatic integration

maven { url 'https://repo1.maven.org/maven2/' }

buildscript {
    repositories {
        google()
        jcenter()
        maven { url 'https://repo1.maven.org/maven2/' }
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.0'
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        maven { url 'https://repo1.maven.org/maven2/' }
    }
}

dependencies {
    implementation fileTree(include the following:['*.jar'], dir:'libs')

    //QuickTracking analytics SDK
    implementation 'com.lydaas.qtsdk:qt-px-common:1.8.9.PX'
  
}

pluginManagement {
    repositories {
        google {
            content {
                includeGroupByRegex("com\\.android.*")
                includeGroupByRegex("com\\.google.*")
                includeGroupByRegex("androidx.*")
            }
        }
        mavenCentral()
        gradlePluginPortal()
        maven { url 'https://repo1.maven.org/maven2/' }
    }

}
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://repo1.maven.org/maven2/' }
    }
}

dependencies {
    //QuickTracking analytics SDK
    implementation 'com.lydaas.qtsdk:qt-px-common:1.8.9.PX'
}

2.2.2 Manual integration

Select and download the SDK components. Unzip the .zip file to obtain the component packages:

• qt-px-common-1.x.x.PX.aar // Analytics SDK. This component is required.

• In Android Studio, copy the relevant component JAR packages to the libs directory of your project. Then, right-click the project and select Open Module Settings. In the Project Structure dialog box, select the Dependencies tab. Click the plus sign (+) in the lower-left corner, select the component package type, and import the corresponding packages.

• In Eclipse, right-click the project root directory and select Properties > Java Build Path > Libraries. Then, click Add External JARs..., select the path to the JAR file, and click OK to complete the import. (Manual import is not required for ADT 17 and later).

repositories{
    flatDir{
        dirs 'libs'
    }
}

dependencies {
    implementation fileTree(include the following: ['*.jar'], dir: 'libs')
    implementation files('libs/qt-px-common-1.x.x.PX.aar') // Required
}

dependencies {
    implementation fileTree(include the following: ['*.jar'], dir: 'libs')
    implementation files('libs/qt-px-common-1.x.x.PX.aar') // Required
}

2.3 Configure permissions

The analytics SDK requires the host app to grant the following permissions:

The following code provides an example of the AndroidManifest.xml manifest file:

<manifest>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
    <uses-permission android:name="android.permission.READ_PHONE_STATE"/>
    <uses-permission android:name="android.permission.INTERNET"/>
</manifest>

2.4 Obfuscation configuration

If your application uses code obfuscation, you must add the following configuration. This prevents the Quick Tracking SDK from being incorrectly obfuscated, which would render it unusable.

-keep class com.umeng.** {*;}
-keep class org.repackage.** {*;}

-keep class com.quick.qt.** {*;}
-keep class rpk.quick.qt.** {*;}

-keepclassmembers class * {
   public <init> (org.json.JSONObject);
}
-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
}

The SDK needs to reference resource files that are imported into the project. It uses a reflection mechanism to obtain the resource reference file R.java. However, when you process the APK with obfuscation or optimization tools, such as ProGuard, the R.java file might be deleted. If this issue occurs, add the following configuration:

-keep public class [your_app_package_name].R$*{
public static final int *;
} 

2.5 Tracking validation configuration

In the AndroidManifest.xml file, find the activity that responds to android.intent.action.MAIN. This is the first activity that can be launched from outside the application. Add the following code to allow a specific scheme link to launch the application:

<intent-filter>
    <action android:name="android.intent.action.VIEW"/>
    <category android:name="android.intent.category.DEFAULT" />
    <category android:name="android.intent.category.BROWSABLE" />
    <data android:scheme="atm.your_appKey" />
</intent-filter>

Note:

1. Use a separate intent-filter. You must place it at the same level as other intent-filters. Do not add the preceding code inside another intent-filter.

2. Replace "your_appKey" with your application's appKey.