com.adobe.mobile

Class Analytics

java.lang.Object

com.adobe.mobile.Analytics

public final class Analytics
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Analytics.BEACON_PROXIMITY
static interface	Analytics.TimedActionBlock<Boolean> The interface definition for the logic block that can be passed to the method trackTimedActionEnd to perform custom logic.

Constructor Summary

Constructors

Constructor and Description
Analytics()

Method Summary

Modifier and Type	Method and Description
static void	clearBeacon()
static void	clearQueue() Removes all unsent hits from the queue
static long	getQueueSize() Returns the total number of hits currently in the queue WARNING - this call will block the thread it is being called from and wait for a return.
static java.lang.String	getTrackingIdentifier() Retrieves identifier generated by Analytics for this app/device instance WARNING - this call will block the thread it is being called from and wait for a return.
static void	processGooglePlayInstallReferrerUrl(java.lang.String referrerUrl) Retrieves acquisition data from the provided Google Play Install Referrer URL The data collected from this API will be sent on install hits sent to Analytics, and will be available in the Adobe Data Callback.
static void	processReferrer(Context context, Intent intent) Processes referrer campaign data from the Google Play Store for later use.
static void	sendQueuedHits() Sends all queued hits
static void	trackAction(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> contextData)
static void	trackBeacon(java.lang.String uuid, java.lang.String major, java.lang.String minor, Analytics.BEACON_PROXIMITY proximity, java.util.Map<java.lang.String,java.lang.Object> contextData)
static boolean	trackingTimedActionExists(java.lang.String action) Checks to see if a timed action exists
static void	trackLifetimeValueIncrease(java.math.BigDecimal amount, java.util.HashMap<java.lang.String,java.lang.Object> contextData)
static void	trackLocation(Location location, java.util.Map<java.lang.String,java.lang.Object> contextData)
static void	trackState(java.lang.String state, java.util.Map<java.lang.String,java.lang.Object> contextData)
static void	trackTimedActionEnd(java.lang.String action, Analytics.TimedActionBlock<java.lang.Boolean> logic) Tracks the end of a timed action This method will send a tracking hit if the parameter logic is nil or returns YES.
static void	trackTimedActionStart(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> contextData) Tracks the start of a timed action This method does not send a tracking hit.
static void	trackTimedActionUpdate(java.lang.String action, java.util.Map<java.lang.String,java.lang.Object> contextData) Tracks the update of a timed action This method does not send a tracking hit When the timed action is updated the contents of the parameter data will overwrite existing context data keys and append new ones.

Methods inherited from class java.lang.Object

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

Constructor Detail

Analytics

public Analytics()

Method Detail

trackState

public static void trackState(java.lang.String state,
                              java.util.Map<java.lang.String,java.lang.Object> contextData)

trackAction

public static void trackAction(java.lang.String action,
                               java.util.Map<java.lang.String,java.lang.Object> contextData)

trackLocation

public static void trackLocation(Location location,
                                 java.util.Map<java.lang.String,java.lang.Object> contextData)

trackBeacon

public static void trackBeacon(java.lang.String uuid,
                               java.lang.String major,
                               java.lang.String minor,
                               Analytics.BEACON_PROXIMITY proximity,
                               java.util.Map<java.lang.String,java.lang.Object> contextData)

clearBeacon

public static void clearBeacon()

trackLifetimeValueIncrease

public static void trackLifetimeValueIncrease(java.math.BigDecimal amount,
                                              java.util.HashMap<java.lang.String,java.lang.Object> contextData)

trackTimedActionStart

public static void trackTimedActionStart(java.lang.String action,
                                         java.util.Map<java.lang.String,java.lang.Object> contextData)

Tracks the start of a timed action This method does not send a tracking hit. If a timed action with the same name already exists it will be deleted and a new one will replace it.

Parameters:

action - a required String that denotes the name of the timed action to track.

contextData - optional HashMap containing context data to track with this timed action.

trackTimedActionUpdate

public static void trackTimedActionUpdate(java.lang.String action,
                                          java.util.Map<java.lang.String,java.lang.Object> contextData)

Tracks the update of a timed action This method does not send a tracking hit When the timed action is updated the contents of the parameter data will overwrite existing context data keys and append new ones.

Parameters:

action - a required String that denotes the name of the timed action to track.

contextData - optional HashMap containing context data to track with this timed action.

trackTimedActionEnd

public static void trackTimedActionEnd(java.lang.String action,
                                       Analytics.TimedActionBlock<java.lang.Boolean> logic)

Tracks the end of a timed action This method will send a tracking hit if the parameter logic is nil or returns YES. Valid values for inAppDuration and totalDuration are non-negative and fewer than the number of seconds in a year. If the value returned is negative, it is considered corrupt and will be ignored.

Parameters:

action - a required String that denotes the name of the timed action to finish tracking.

logic - optional TimedActionBlock to perform logic and update parameters when this timed action ends, this block can cancel the sending of the hit by returning NO.

See Also:

Analytics.TimedActionBlock

trackingTimedActionExists

public static boolean trackingTimedActionExists(java.lang.String action)

Checks to see if a timed action exists

Parameters:

action - a required String that denotes the name of the timed action to check for.

Returns:

boolean indicating if the named action exists

processReferrer

public static void processReferrer(Context context,
                                   Intent intent)

Processes referrer campaign data from the Google Play Store for later use. This method does not send a tracking hit.

Parameters:

context - a required Context to be forwarded from your BroadcastReceiver.

intent - a required Intent to be forwarded from your BroadcastReceiver.

processGooglePlayInstallReferrerUrl

public static void processGooglePlayInstallReferrerUrl(java.lang.String referrerUrl)

Retrieves acquisition data from the provided Google Play Install Referrer URL The data collected from this API will be sent on install hits sent to Analytics, and will be available in the Adobe Data Callback. If referrer data has already been collected by the SDK, calling this method will result in a no-op. For information on how to retrieve the referrer URL, see the Google documentation: https://developer.android.com/google/play/installreferrer/library

Parameters:

referrerUrl - String containing the string returned by InstallReferrerClient.getInstallReferrer()

See Also:

Config.AdobeDataCallback

getTrackingIdentifier

public static java.lang.String getTrackingIdentifier()

Retrieves identifier generated by Analytics for this app/device instance WARNING - this call will block the thread it is being called from and wait for a return.

getQueueSize

public static long getQueueSize()

Returns the total number of hits currently in the queue WARNING - this call will block the thread it is being called from and wait for a return.

Returns:

size of the unsent hits queue

clearQueue

public static void clearQueue()

Removes all unsent hits from the queue

sendQueuedHits

public static void sendQueuedHits()

Sends all queued hits