Quick Tracking:Java SDK

1. Integrate the Java SDK

Manually introduce the JAR package "quickaplus-log-collector-java-sdk-1.0.1-SNAPSHOT.jar". You can contact QT Q&A personnel to obtain

2 Basic Configurations (Required!)

Set the appkey, data collection endpoint, and authentication information

1. Set the appkey

QtSdkConfig.setAppKey("Your appkey");

2. Set the data collection endpoint

QtSdkConfig.setQlcEndpoint("Your data collection endpoint");

Note: You must add the suffix "/server" to the domain.

3. Enter the authentication information

QtSdkConfig.setServiceId("Your ServiceID");
QtSdkConfig.setServiceSecret("Your ServiceSecret"); 

Obtain the location in the 「management console-track information- server tracking information」.

3. Global property settings

// Add a property.
QtGlobalPropertiesConfig.put("a", "1");
QtGlobalPropertiesConfig.put("b", "2");
// Delete a property.
QtGlobalPropertiesConfig.remove("a");
// Query all properties.
QtGlobalPropertiesConfig.getAll();
// Clear properties.
QtGlobalPropertiesConfig.clear();

4. Tracking Report

QtLog log = new QtLog.Builder()
        . eventId("order_success") // The event code. This parameter is required.
        . deviceId("dev-001") // Set the device ID (both the device ID and account ID are required)
        . userId("user-001") // Specify the account ID. You must specify one of the device ID and account ID.
        . pageName("pageName") // Set the page encoding (optional)
        . customProperty(new HashMap<>()) // Set event properties (optional)
        . systemProperty(new HashMap<>()) // Set system properties (optional)
    		. idTracking(new HashMap<>()) // Set the device identifier of the system property.
        . debugKey("dk-0001") // Set the tracking verification flag bit (optional), which must be deleted when you go online.
        . eventTimestamp(System.currentTimeMillis()) // Specify the timestamp of the client. This parameter is required.
        . serverTimestamp(System.currentTimeMillis()) // Set the server timestamp. This parameter is optional.
  			. uuid("xxxx") // Set the unique identifier of an event log. This parameter is used to generate a log_id. This parameter is supported in 1.0.1.
        . build(); // The log is built. 

1. System properties only support the reporting of the following properties. When you submit a system property, you must enter the same key as the following, including case-sensitive keys.

5 Logo Delivery

When sending logs, call the following API to send logs.

 QtLogSenderHelper.syncSendLog(log);

6 Demo

package com.alibaba.lingyang.quick.tracking.qlc.java.sdk.model;

import com.alibaba.lingyang.quick.tracking.qlc.java.sdk.config.QtGlobalPropertiesConfig;
import com.alibaba.lingyang.quick.tracking.qlc.java.sdk.config.QtSdkConfig;
import com.alibaba.lingyang.quick.tracking.qlc.java.sdk.sender.QtLogSenderHelper;
import org.junit.Test;

import java.util.HashMap;
import java.util.Map;

/**
 * Test sending logs.
 */
public class TestSendLog {
    /**
     * Test
     */
    @Test
    public void testSend() {
        // Configure
        QtSdkConfig.setServiceId("Your ServiceId");
        QtSdkConfig.setServiceSecret("Your ServiceSecret");
        QtSdkConfig.setAppKey("Your appkey");
        QtSdkConfig.setQlcEndpoint("Your domain name");
        QtSdkConfig.setOpenLog(true);
        QtSdkConfig.setCallback(ctx -> {
            System.out.println(ctx.getResponseCode());
            System.out.println(ctx.getResponseMessage());
            System.out.println(ctx.getSendSuccess());
            System.out.println(ctx.getSendData());
            System.out.println(ctx.getResponseData());
            System.out.println(ctx.getErrors());
        });

        // Add an attribute.
        QtGlobalPropertiesConfig.put("a", "1");
        QtGlobalPropertiesConfig.put("b", "2");
        // Delete a property.
        QtGlobalPropertiesConfig.remove("a");
        // Query all properties.
        QtGlobalPropertiesConfig.getAll();
        // Clear properties.
        QtGlobalPropertiesConfig.clear();

        Map<String,String> idTracking = new HashMap();
        idTracking.put("mac","id1");
        idTracking.put("oaid","id2");
        idTracking.put("android_id","id3");

        // Construct a log object.
        QtLog log = new QtLog.Builder()
                . eventId("order_success") // The event code. This parameter is required.
                . deviceId("dev-001") // Set the device ID (both the device ID and account ID are required)
                . userId("user-001") // Specify the account ID. You must specify one of the device ID and account ID.
                . pageName("pageName") // Set the page encoding (optional)
                . customProperty(new HashMap<>()) // Set event properties (optional)
                . systemProperty(new HashMap<>()) // Set system properties (optional)
              	. idTracking(new HashMap<>()) // Set the device identifier of the system property.
                . debugKey("dk-0001") // Set the tracking verification flag bit (optional), which must be deleted when you go online.
                . eventTimestamp(System.currentTimeMillis()) // Specify the timestamp of the client. This parameter is required.
                . serverTimestamp(System.currentTimeMillis()) // Set the server timestamp. This parameter is optional.
        // Send logs.
        QtLogSenderHelper.syncSendLog(log);
    }

}

7 Other configurations

1. The scope of a service instance to be upgraded. By default, Service Configurations is selected.

2. Configure callbacks

Register the callback function demo

// Register the callback function.
QtSdkConfig.setCallback(ctx -> {
 System.out.println(ctx.getResponseCode());
 System.out.println(ctx.getResponseMessage());
 System.out.println(ctx.getSendSuccess());
 System.out.println(ctx.getSendData());
 System.out.println(ctx.getResponseData());
 System.out.println(ctx.getErrors());
});

3. Generation of unique log id--log_id

By default, the SDK generates a uuid for each event log as the generation factor of the log unique id 「log_id」. If you want the 「log_id」 to be more unique, you can set the UUID. Perform the following operations:

QtLog log = new QtLog.Builder()
        .eventId("order_success")  
        .deviceId("dev-001")		
        .userId("user-001")		
        .pageName("pageName")
        .customProperty(new HashMap<>())
        .systemProperty(new HashMap<>())
    		.idTracking(new HashMap<>())
        . debugKey("dk-0001")// Set the tracking verification flag bit (optional), which must be deleted when you go online.
        .eventTimestamp(System.currentTimeMillis())
  			. uuid("xxxx") // Set the unique identifier of an event log. This parameter is used to generate a log_id. This parameter is supported in 1.0.1.
        .build();