com.facebook.appevents

Class AppEventsLogger

java.lang.Object

com.facebook.appevents.AppEventsLogger

public class AppEventsLogger
extends java.lang.Object

The AppEventsLogger class allows the developer to log various types of events back to Facebook. In order to log events, the app must create an instance of this class via a newLogger method, and then call the various "log" methods off of that.

This client-side event logging is then available through Facebook App Insights and for use with Facebook Ads conversion tracking and optimization.

The AppEventsLogger class has a few related roles:

• Logging predefined and application-defined events to Facebook App Insights with a numeric value to sum across a large number of events, and an optional set of key/value parameters that define "segments" for this event (e.g., 'purchaserStatus' : 'frequent', or 'gamerLevel' : 'intermediate'). These events may also be used for ads conversion tracking, optimization, and other ads related targeting in the future.
• Methods that control the way in which events are flushed out to the Facebook servers.

Here are some important characteristics of the logging mechanism provided by AppEventsLogger:

• Events are not sent immediately when logged. They're cached and flushed out to the Facebook servers in a number of situations:
  • when an event count threshold is passed (currently 100 logged events).
  • when a time threshold is passed (currently 15 seconds).
  • when an app has gone to background and is then brought back to the foreground.
• Events will be accumulated when the app is in a disconnected state, and sent when the connection is restored and one of the above 'flush' conditions are met.
• The AppEventsLogger class is intended to be used from the thread it was created on. Multiple AppEventsLoggers may be created on other threads if desired.
• The developer can call the setFlushBehavior method to force the flushing of events to only occur on an explicit call to the `flush` method.
• The developer can turn on console debug output for event logging and flushing to the server by calling FacebookSdk.addLoggingBehavior(LoggingBehavior.APP_EVENTS);

Some things to note when logging events:

• There is a limit on the number of unique event names an app can use, on the order of 1000.
• There is a limit to the number of unique parameter names in the provided parameters that can be used per event, on the order of 25. This is not just for an individual call, but for all invocations for that eventName.
• Event names and parameter names must be between 2 and 40 characters, and must consist of alphanumeric characters, _, -, or spaces.
• The length of each parameter value can be no more than on the order of 100 characters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppEventsLogger.FlushBehavior Controls when an AppEventsLogger sends log events to the server

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_APP_EVENTS_FLUSHED The action used to indicate that a flush of app events has occurred.
static java.lang.String	APP_EVENT_PREFERENCES
static java.lang.String	APP_EVENTS_EXTRA_FLUSH_RESULT
static java.lang.String	APP_EVENTS_EXTRA_NUM_EVENTS_FLUSHED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AppEventsLogger(java.lang.String activityName, java.lang.String applicationId, AccessToken accessToken)

Method Summary

Methods

Modifier and Type	Method and Description
static void	activateApp(android.app.Application application) Notifies the events system that the app has launched and activate and deactivate events should start being logged automatically.
static void	activateApp(android.app.Application application, java.lang.String applicationId) Notifies the events system that the app has launched and activate and deactivate events should start being logged automatically.
static void	activateApp(android.content.Context context) Deprecated. Use activateApp(Application)
static void	activateApp(android.content.Context context, java.lang.String applicationId) Deprecated. Use activateApp(Application)
static void	deactivateApp(android.content.Context context) Deprecated. When using activateApp(Application) deactivate app will be logged automatically.
static void	deactivateApp(android.content.Context context, java.lang.String applicationId) Deprecated. When using activateApp(Application) deactivate app will be logged automatically.
void	flush() Explicitly flush any stored events to the server.
static java.lang.String	getAnonymousAppDeviceGUID(android.content.Context context) Each app/device pair gets an GUID that is sent back with App Events and persisted with this app/device pair.
java.lang.String	getApplicationId() Returns the app ID this logger was configured to log to.
static AppEventsLogger.FlushBehavior	getFlushBehavior() Access the behavior that AppEventsLogger uses to determine when to flush logged events to the server.
boolean	isValidForAccessToken(AccessToken accessToken) Determines if the logger is valid for the given access token.
void	logEvent(java.lang.String eventName) Log an app event with the specified name.
void	logEvent(java.lang.String eventName, android.os.Bundle parameters) Log an app event with the specified name and set of parameters.
void	logEvent(java.lang.String eventName, double valueToSum) Log an app event with the specified name and the supplied value.
void	logEvent(java.lang.String eventName, double valueToSum, android.os.Bundle parameters) Log an app event with the specified name, supplied value, and set of parameters.
void	logPurchase(java.math.BigDecimal purchaseAmount, java.util.Currency currency) Logs a purchase event with Facebook, in the specified amount and with the specified currency.
void	logPurchase(java.math.BigDecimal purchaseAmount, java.util.Currency currency, android.os.Bundle parameters) Logs a purchase event with Facebook, in the specified amount and with the specified currency.
void	logPushNotificationOpen(android.os.Bundle payload) Logs an app event that tracks that the application was open via Push Notification.
void	logPushNotificationOpen(android.os.Bundle payload, java.lang.String action) Logs an app event that tracks that the application was open via Push Notification.
void	logSdkEvent(java.lang.String eventName, java.lang.Double valueToSum, android.os.Bundle parameters) This method is intended only for internal use by the Facebook SDK and other use is unsupported.
static AppEventsLogger	newLogger(android.content.Context context) Build an AppEventsLogger instance to log events through.
static AppEventsLogger	newLogger(android.content.Context context, AccessToken accessToken) Build an AppEventsLogger instance to log events through.
static AppEventsLogger	newLogger(android.content.Context context, java.lang.String applicationId) Build an AppEventsLogger instance to log events that are attributed to the application but not to any particular Session.
static AppEventsLogger	newLogger(android.content.Context context, java.lang.String applicationId, AccessToken accessToken) Build an AppEventsLogger instance to log events through.
static void	onContextStop() Call this when the consuming Activity/Fragment receives an onStop() callback in order to persist any outstanding events to disk so they may be flushed at a later time.
static void	setFlushBehavior(AppEventsLogger.FlushBehavior flushBehavior) Set the behavior that this AppEventsLogger uses to determine when to flush logged events to the server.
static void	setPushNotificationsRegistrationId(java.lang.String registrationId) Sets a registration id to register the current app installation for push notifications.

Methods inherited from class java.lang.Object

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

Field Detail

APP_EVENT_PREFERENCES

public static final java.lang.String APP_EVENT_PREFERENCES

See Also:

Constant Field Values

ACTION_APP_EVENTS_FLUSHED

public static final java.lang.String ACTION_APP_EVENTS_FLUSHED

The action used to indicate that a flush of app events has occurred. This should be used as an action in an IntentFilter and BroadcastReceiver registered with the LocalBroadcastManager.

See Also:

Constant Field Values

APP_EVENTS_EXTRA_NUM_EVENTS_FLUSHED

public static final java.lang.String APP_EVENTS_EXTRA_NUM_EVENTS_FLUSHED

See Also:

Constant Field Values

APP_EVENTS_EXTRA_FLUSH_RESULT

public static final java.lang.String APP_EVENTS_EXTRA_FLUSH_RESULT

See Also:

Constant Field Values

Constructor Detail

AppEventsLogger

protected AppEventsLogger(java.lang.String activityName,
               java.lang.String applicationId,
               AccessToken accessToken)

Method Detail

activateApp

public static void activateApp(android.app.Application application)

Notifies the events system that the app has launched and activate and deactivate events should start being logged automatically. This should be called from the OnCreate method of you application.

Parameters:

application - The running application

activateApp

public static void activateApp(android.app.Application application,
               java.lang.String applicationId)

Notifies the events system that the app has launched and activate and deactivate events should start being logged automatically. This should be called from the OnCreate method of you application. Call this if you wish to use a different Application ID then the one specified in the Facebook SDK.

Parameters:

application - The running application

applicationId - The application id used to log activate/deactivate events.

activateApp

@Deprecated
public static void activateApp(android.content.Context context)

Deprecated. Use activateApp(Application)

Notifies the events system that the app has launched & logs an activatedApp event. Should be called whenever your app becomes active, typically in the onResume() method of each long-running Activity of your app.

Use this method if your application ID is stored in application metadata, otherwise see activateApp(android.content.Context, String).

Parameters:

context - Used to access the applicationId and the attributionId for non-authenticated users.

activateApp

@Deprecated
public static void activateApp(android.content.Context context,
                          java.lang.String applicationId)

Deprecated. Use activateApp(Application)

Notifies the events system that the app has launched & logs an activatedApp event. Should be called whenever your app becomes active, typically in the onResume() method of each long-running Activity of your app.

Parameters:

context - Used to access the attributionId for non-authenticated users.

applicationId - The specific applicationId to report the activation for.

deactivateApp

@Deprecated
public static void deactivateApp(android.content.Context context)

Deprecated. When using activateApp(Application) deactivate app will be logged automatically.

Notifies the events system that the app has been deactivated (put in the background) and tracks the application session information. Should be called whenever your app becomes inactive, typically in the onPause() method of each long-running Activity of your app. Use this method if your application ID is stored in application metadata, otherwise see deactivateApp(android.content.Context, String).

Parameters:

context - Used to access the applicationId and the attributionId for non-authenticated users.

deactivateApp

@Deprecated
public static void deactivateApp(android.content.Context context,
                            java.lang.String applicationId)

Deprecated. When using activateApp(Application) deactivate app will be logged automatically.

Notifies the events system that the app has been deactivated (put in the background) and tracks the application session information. Should be called whenever your app becomes inactive, typically in the onPause() method of each long-running Activity of your app.

Parameters:

context - Used to access the attributionId for non-authenticated users.

applicationId - The specific applicationId to track session information for.

newLogger

public static AppEventsLogger newLogger(android.content.Context context)

Build an AppEventsLogger instance to log events through. The Facebook app that these events are targeted at comes from this application's metadata. The application ID used to log events will be determined from the app ID specified in the package metadata.

Parameters:

context - Used to access the applicationId and the attributionId for non-authenticated users.

Returns:

AppEventsLogger instance to invoke log* methods on.

newLogger

public static AppEventsLogger newLogger(android.content.Context context,
                        AccessToken accessToken)

Build an AppEventsLogger instance to log events through.

Parameters:

context - Used to access the attributionId for non-authenticated users.

accessToken - Access token to use for logging events. If null, the active access token will be used, if any; if not the logging will happen against the default app ID specified in the package metadata.

newLogger

public static AppEventsLogger newLogger(android.content.Context context,
                        java.lang.String applicationId,
                        AccessToken accessToken)

Build an AppEventsLogger instance to log events through.

Parameters:

context - Used to access the attributionId for non-authenticated users.

applicationId - Explicitly specified Facebook applicationId to log events against. If null, the default app ID specified in the package metadata will be used.

accessToken - Access token to use for logging events. If null, the active access token will be used, if any; if not the logging will happen against the default app ID specified in the package metadata.

Returns:

AppEventsLogger instance to invoke log* methods on.

newLogger

public static AppEventsLogger newLogger(android.content.Context context,
                        java.lang.String applicationId)

Build an AppEventsLogger instance to log events that are attributed to the application but not to any particular Session.

Parameters:

context - Used to access the attributionId for non-authenticated users.

applicationId - Explicitly specified Facebook applicationId to log events against. If null, the default app ID specified in the package metadata will be used.

Returns:

AppEventsLogger instance to invoke log* methods on.

getFlushBehavior

public static AppEventsLogger.FlushBehavior getFlushBehavior()

Access the behavior that AppEventsLogger uses to determine when to flush logged events to the server. This setting applies to all instances of AppEventsLogger.

Returns:

Specified flush behavior.

setFlushBehavior

public static void setFlushBehavior(AppEventsLogger.FlushBehavior flushBehavior)

Set the behavior that this AppEventsLogger uses to determine when to flush logged events to the server. This setting applies to all instances of AppEventsLogger.

Parameters:

flushBehavior - the desired behavior.

logEvent

public void logEvent(java.lang.String eventName)

Log an app event with the specified name.

Parameters:

eventName - eventName used to denote the event. Choose amongst the EVENT_NAME_* constants in AppEventsConstants when possible. Or create your own if none of the EVENT_NAME_* constants are applicable. Event names should be 40 characters or less, alphanumeric, and can include spaces, underscores or hyphens, but must not have a space or hyphen as the first character. Any given app should have no more than 1000 distinct event names.

logEvent

public void logEvent(java.lang.String eventName,
            double valueToSum)

Log an app event with the specified name and the supplied value.

Parameters:

eventName - eventName used to denote the event. Choose amongst the EVENT_NAME_* constants in AppEventsConstants when possible. Or create your own if none of the EVENT_NAME_* constants are applicable. Event names should be 40 characters or less, alphanumeric, and can include spaces, underscores or hyphens, but must not have a space or hyphen as the first character. Any given app should have no more than 1000 distinct event names. * @param eventName

valueToSum - a value to associate with the event which will be summed up in Insights for across all instances of the event, so that average values can be determined, etc.

logEvent

public void logEvent(java.lang.String eventName,
            android.os.Bundle parameters)

Log an app event with the specified name and set of parameters.

Parameters:

eventName - eventName used to denote the event. Choose amongst the EVENT_NAME_* constants in AppEventsConstants when possible. Or create your own if none of the EVENT_NAME_* constants are applicable. Event names should be 40 characters or less, alphanumeric, and can include spaces, underscores or hyphens, but must not have a space or hyphen as the first character. Any given app should have no more than 1000 distinct event names.

parameters - A Bundle of parameters to log with the event. Insights will allow looking at the logs of these events via different parameter values. You can log on the order of 25 parameters with each distinct eventName. It's advisable to limit the number of unique values provided for each parameter in the thousands. As an example, don't attempt to provide a unique parameter value for each unique user in your app. You won't get meaningful aggregate reporting on so many parameter values. The values in the bundles should be Strings or numeric values.

logEvent

public void logEvent(java.lang.String eventName,
            double valueToSum,
            android.os.Bundle parameters)

Log an app event with the specified name, supplied value, and set of parameters.

Parameters:

eventName - eventName used to denote the event. Choose amongst the EVENT_NAME_* constants in AppEventsConstants when possible. Or create your own if none of the EVENT_NAME_* constants are applicable. Event names should be 40 characters or less, alphanumeric, and can include spaces, underscores or hyphens, but must not have a space or hyphen as the first character. Any given app should have no more than 1000 distinct event names.

valueToSum - a value to associate with the event which will be summed up in Insights for across all instances of the event, so that average values can be determined, etc.

parameters - A Bundle of parameters to log with the event. Insights will allow looking at the logs of these events via different parameter values. You can log on the order of 25 parameters with each distinct eventName. It's advisable to limit the number of unique values provided for each parameter in the thousands. As an example, don't attempt to provide a unique parameter value for each unique user in your app. You won't get meaningful aggregate reporting on so many parameter values. The values in the bundles should be Strings or numeric values.

logPurchase

public void logPurchase(java.math.BigDecimal purchaseAmount,
               java.util.Currency currency)

Logs a purchase event with Facebook, in the specified amount and with the specified currency.

Parameters:

purchaseAmount - Amount of purchase, in the currency specified by the 'currency' parameter. This value will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).

currency - Currency used to specify the amount.

logPurchase

public void logPurchase(java.math.BigDecimal purchaseAmount,
               java.util.Currency currency,
               android.os.Bundle parameters)

Logs a purchase event with Facebook, in the specified amount and with the specified currency. Additional detail about the purchase can be passed in through the parameters bundle.

Parameters:

purchaseAmount - Amount of purchase, in the currency specified by the 'currency' parameter. This value will be rounded to the thousandths place (e.g., 12.34567 becomes 12.346).

currency - Currency used to specify the amount.

parameters - Arbitrary additional information for describing this event. This should have no more than 24 entries, and keys should be mostly consistent from one purchase event to the next.

logPushNotificationOpen

public void logPushNotificationOpen(android.os.Bundle payload)

Logs an app event that tracks that the application was open via Push Notification.

Parameters:

payload - Notification payload received.

logPushNotificationOpen

public void logPushNotificationOpen(android.os.Bundle payload,
                           java.lang.String action)

Logs an app event that tracks that the application was open via Push Notification.

Parameters:

payload - Notification payload received.

flush

public void flush()

Explicitly flush any stored events to the server. Implicit flushes may happen depending on the value of getFlushBehavior. This method allows for explicit, app invoked flushing.

onContextStop

public static void onContextStop()

Call this when the consuming Activity/Fragment receives an onStop() callback in order to persist any outstanding events to disk so they may be flushed at a later time. The next flush (explicit or not) will check for any outstanding events and if present, include them in that flush. Note that this call may trigger an I/O operation on the calling thread. Explicit use of this method is necessary.

isValidForAccessToken

public boolean isValidForAccessToken(AccessToken accessToken)

Determines if the logger is valid for the given access token.

Parameters:

accessToken - The access token to check.

Returns:

True if the access token is valid for this logger.

setPushNotificationsRegistrationId

public static void setPushNotificationsRegistrationId(java.lang.String registrationId)

Sets a registration id to register the current app installation for push notifications.

Parameters:

registrationId - RegistrationId received from GCM.

logSdkEvent

public void logSdkEvent(java.lang.String eventName,
               java.lang.Double valueToSum,
               android.os.Bundle parameters)

This method is intended only for internal use by the Facebook SDK and other use is unsupported.

getApplicationId

public java.lang.String getApplicationId()

Returns the app ID this logger was configured to log to.

Returns:

the Facebook app ID

getAnonymousAppDeviceGUID

public static java.lang.String getAnonymousAppDeviceGUID(android.content.Context context)

Each app/device pair gets an GUID that is sent back with App Events and persisted with this app/device pair.

Parameters:

context - The application context.

Returns:

The GUID for this app/device pair.