Package cn.thinkingdata.analytics.inter

Interface ITDAnalytics

All Known Implementing Classes:

TDAnalytics, ThinkingDataAnalytics

public interface ITDAnalytics

Method Summary

Modifier and Type	Method	Description
void	clearSuperProperties()	clear common properties
void	close()	close and exit sdk
void	flush()	report data immediately
Map<String,Object>	getSuperProperties()	get super properties
void	setDynamicSuperPropertiesTracker(DynamicSuperPropertiesTracker dynamicSuperPropertiesTracker)	set common properties dynamically.
void	setSuperProperties(Map<String,Object> properties)	set common properties.
void	track(String accountId, String distinctId, String eventName, Map<String,Object> properties)	report event
void	trackFirst(String accountId, String distinctId, String eventName, String firstCheckId, Map<String,Object> properties)	first event
void	trackOverwrite(String accountId, String distinctId, String eventName, String eventId, Map<String,Object> properties)
void	trackUpdate(String accountId, String distinctId, String eventName, String eventId, Map<String,Object> properties)
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 user (not recommended)
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.
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

Method Detail

track

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

report event

Parameters:

accountId - account ID

distinctId - distinct ID

eventName - name

properties - properties

Throws:

InvalidArgumentException - data error

trackFirst

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

first event

Parameters:

accountId - account ID

distinctId - distinct ID

eventName - name

firstCheckId - it is flag of the first event

properties - properties

Throws:

InvalidArgumentException - data error

trackUpdate

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

Parameters:

accountId - account ID

distinctId - distinct ID

eventName - name

eventId - event ID

properties - properties

Throws:

InvalidArgumentException - data error

trackOverwrite

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

Parameters:

accountId - account ID

distinctId - distinct ID

eventName - event name

eventId - event ID

properties - properties

Throws:

InvalidArgumentException - data error

setSuperProperties

void setSuperProperties(Map<String,Object> properties)

set common properties. it will add to event automatically

Parameters:

properties - common properties

getSuperProperties

Map<String,Object> getSuperProperties()

get super properties

Returns:

Map

unsetSuperProperties

void unsetSuperProperties(String key)

delete property by key

Parameters:

key - property name

clearSuperProperties

void clearSuperProperties()

clear common properties

setDynamicSuperPropertiesTracker

void setDynamicSuperPropertiesTracker(DynamicSuperPropertiesTracker dynamicSuperPropertiesTracker)

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

Parameters:

dynamicSuperPropertiesTracker - properties

userDelete

void userDelete(String accountId,
                String distinctId)
         throws InvalidArgumentException

delete user (not recommended)

Parameters:

accountId - account ID

distinctId - distinct ID

Throws:

InvalidArgumentException - data error

userAdd

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

to accumulate operations against the property

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - data error

userSetOnce

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

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

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - data error

userSet

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

set user properties. would overwrite existing names

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - data error

userUnset

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

clear the user properties of users

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - data error

userAppend

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

to add user properties of array type

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - data error

userUniqAppend

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

append user properties to array type by unique.

Parameters:

accountId - account ID

distinctId - distinct ID

properties - properties

Throws:

InvalidArgumentException - data error

flush

void flush()

report data immediately

close

void close()

close and exit sdk