Package cn.thinkingdata.analytics

Class TDAnalytics

java.lang.Object

cn.thinkingdata.analytics.TDAnalytics

All Implemented Interfaces:

ITDAnalytics

Direct Known Subclasses:

ThinkingDataAnalytics

public class TDAnalytics
extends Object
implements ITDAnalytics

Entry of SDK

Constructor Summary

Constructors

Constructor	Description
TDAnalytics(ITDConsumer consumer)	Construct function
TDAnalytics(ITDConsumer consumer, boolean enableUUID)	Construct function
TDAnalytics(ITDConsumer consumer, boolean enableUUID, boolean isStrictModel)	Construct function

Method Summary

Modifier and Type	Method	Description
void	clearSuperProperties()	clear common properties
void	close()	close and exit sdk
static void	enableLog(boolean isPrintLog)	Is enabled log or not.
void	flush()	report data immediately
Map<String,Object>	getSuperProperties()	get super properties
void	setDynamicSuperPropertiesTracker(DynamicSuperPropertiesTracker dynamicSuperPropertiesTracker)	set common properties dynamically.
static void	setLogger(ITDLogger logger)	Developers can set up a custom logging system based on requirements
void	setSuperProperties(Map<String,Object> properties)	Sets the properties that each event carries
void	track(String accountId, String distinctId, String eventName, Map<String,Object> properties)	Report normal event
void	trackFirst(String accountId, String distinctId, String eventName, String firstCheckId, Map<String,Object> properties)	Report first event
void	trackOverwrite(String accountId, String distinctId, String eventName, String eventId, Map<String,Object> properties)	Report overwrite event
void	trackUpdate(String accountId, String distinctId, String eventName, String eventId, Map<String,Object> properties)	Report update event
void	unsetSuperProperties(String key)	delete property by key
void	userAdd(String accountId, String distinctId, Map<String,Object> properties)	To accumulate operations against the property
void	userAppend(String accountId, String distinctId, Map<String,Object> properties)	To add user properties of array type
void	userDelete(String accountId, String distinctId)	Delete a user, This operation is not reversible
void	userSet(String accountId, String distinctId, Map<String,Object> properties)	Set user properties.
void	userSetOnce(String accountId, String distinctId, Map<String,Object> properties)	Set user properties, this message would be neglected If such property had been set before
void	userUniqAppend(String accountId, String distinctId, Map<String,Object> properties)	Append user properties to array type by unique.
void	userUnset(String accountId, String distinctId, String... properties)	Clear the user properties of users

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TDAnalytics

public TDAnalytics(ITDConsumer consumer)

Construct function

Parameters:

consumer - BatchConsumer or LoggerConsumer or DebugConsumer

TDAnalytics

public TDAnalytics(ITDConsumer consumer,
                   boolean enableUUID)

Construct function

Parameters:

consumer - BatchConsumer or LoggerConsumer or DebugConsumer

enableUUID - Whether to allow uuid creation for events automatically

TDAnalytics

public TDAnalytics(ITDConsumer consumer,
                   boolean enableUUID,
                   boolean isStrictModel)

Construct function

Parameters:

consumer - BatchConsumer or LoggerConsumer or DebugConsumer

enableUUID - Whether to allow uuid creation for events automatically

isStrictModel - Whether to enable property verification

Method Detail

enableLog

public static void enableLog(boolean isPrintLog)

Is enabled log or not. it is enabled in DebugConsumer

Parameters:

isPrintLog - enabled

setLogger

public static void setLogger(ITDLogger logger)

Developers can set up a custom logging system based on requirements

Parameters:

logger - custom logger

track

public void track(String accountId,
                  String distinctId,
                  String eventName,
                  Map<String,Object> properties)
           throws InvalidArgumentException

Report normal event

Specified by:

track in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

eventName - name

properties - properties

Throws:

InvalidArgumentException - exception

trackFirst

public void trackFirst(String accountId,
                       String distinctId,
                       String eventName,
                       String firstCheckId,
                       Map<String,Object> properties)
                throws InvalidArgumentException

Report first event

Specified by:

trackFirst in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

eventName - event name

properties - properties (must add "#first_check_id" in properties, because it is flag of the first event)

firstCheckId - it is flag of the first event

Throws:

InvalidArgumentException - exception

trackUpdate

public void trackUpdate(String accountId,
                        String distinctId,
                        String eventName,
                        String eventId,
                        Map<String,Object> properties)
                 throws InvalidArgumentException

Report update event

Specified by:

trackUpdate in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

eventName - event name

eventId - event id

properties - properties

Throws:

InvalidArgumentException - exception

trackOverwrite

public void trackOverwrite(String accountId,
                           String distinctId,
                           String eventName,
                           String eventId,
                           Map<String,Object> properties)
                    throws InvalidArgumentException

Report overwrite event

Specified by:

trackOverwrite in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

eventName - event name

eventId - event id

properties - properties

Throws:

InvalidArgumentException - exception

setSuperProperties

public void setSuperProperties(Map<String,Object> properties)

Sets the properties that each event carries

Specified by:

setSuperProperties in interface ITDAnalytics

Parameters:

properties - common properties

getSuperProperties

public Map<String,Object> getSuperProperties()

Description copied from interface: ITDAnalytics

get super properties

Specified by:

getSuperProperties in interface ITDAnalytics

Returns:

Map

unsetSuperProperties

public void unsetSuperProperties(String key)

Description copied from interface: ITDAnalytics

delete property by key

Specified by:

unsetSuperProperties in interface ITDAnalytics

Parameters:

key - property name

clearSuperProperties

public void clearSuperProperties()

Description copied from interface: ITDAnalytics

clear common properties

Specified by:

clearSuperProperties in interface ITDAnalytics

setDynamicSuperPropertiesTracker

public void setDynamicSuperPropertiesTracker(DynamicSuperPropertiesTracker dynamicSuperPropertiesTracker)

Description copied from interface: ITDAnalytics

set common properties dynamically. not recommend to add the operation which with a lot of computation

Specified by:

setDynamicSuperPropertiesTracker in interface ITDAnalytics

Parameters:

dynamicSuperPropertiesTracker - properties

userDelete

public void userDelete(String accountId,
                       String distinctId)
                throws InvalidArgumentException

Delete a user, This operation is not reversible

Specified by:

userDelete in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

Throws:

InvalidArgumentException - exception

userAdd

public void userAdd(String accountId,
                    String distinctId,
                    Map<String,Object> properties)
             throws InvalidArgumentException

To accumulate operations against the property

Specified by:

userAdd in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - exception

userSetOnce

public void userSetOnce(String accountId,
                        String distinctId,
                        Map<String,Object> properties)
                 throws InvalidArgumentException

Set user properties, this message would be neglected If such property had been set before

Specified by:

userSetOnce in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - exception

userSet

public void userSet(String accountId,
                    String distinctId,
                    Map<String,Object> properties)
             throws InvalidArgumentException

Set user properties. would overwrite existing names

Specified by:

userSet in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - exception

userUnset

public void userUnset(String accountId,
                      String distinctId,
                      String... properties)
               throws InvalidArgumentException

Clear the user properties of users

Specified by:

userUnset in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - exception

userAppend

public void userAppend(String accountId,
                       String distinctId,
                       Map<String,Object> properties)
                throws InvalidArgumentException

To add user properties of array type

Specified by:

userAppend in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - exception

userUniqAppend

public void userUniqAppend(String accountId,
                           String distinctId,
                           Map<String,Object> properties)
                    throws InvalidArgumentException

Append user properties to array type by unique.

Specified by:

userUniqAppend in interface ITDAnalytics

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - exception

flush

public void flush()

Description copied from interface: ITDAnalytics

report data immediately

Specified by:

flush in interface ITDAnalytics

close

public void close()

Description copied from interface: ITDAnalytics

close and exit sdk

Specified by:

close in interface ITDAnalytics