AppEventsConstants
A more recent version of this class is available. Check out the latest version.
Predefined event and parameter names for logging events common to many apps. Logging occurs through the AppEventsLogger.logEvent(String, android.os.Bundle) family of methods.
| Extends: | Object |
| Package: | appevents |
Constructors
AppEventsConstants()public AppEventsConstants() Constants
EVENT_NAME_ACTIVATED_APPLog this event when an app is being activated.
public static final String EVENT_NAME_ACTIVATED_APPEVENT_NAME_DEACTIVATED_APPpublic static final String EVENT_NAME_DEACTIVATED_APPEVENT_NAME_SESSION_INTERRUPTIONSpublic static final String EVENT_NAME_SESSION_INTERRUPTIONSEVENT_NAME_TIME_BETWEEN_SESSIONSpublic static final String EVENT_NAME_TIME_BETWEEN_SESSIONSEVENT_NAME_COMPLETED_REGISTRATIONLog this event when the user has completed registration with the app.
public static final String EVENT_NAME_COMPLETED_REGISTRATIONEVENT_NAME_VIEWED_CONTENTLog this event when the user has viewed a form of content in the app.
public static final String EVENT_NAME_VIEWED_CONTENTEVENT_NAME_SEARCHEDLog this event when the user has performed a search within the app.
public static final String EVENT_NAME_SEARCHEDEVENT_NAME_RATEDLog this event when the user has rated an item in the app.
The valueToSum passed to logEvent should be the numeric rating.
public static final String EVENT_NAME_RATEDEVENT_NAME_COMPLETED_TUTORIALLog this event when the user has completed a tutorial in the app.
public static final String EVENT_NAME_COMPLETED_TUTORIALEVENT_NAME_ADDED_TO_CARTLog this event when the user has added an item to their cart.
The valueToSum passed to logEvent should be the item's price.
public static final String EVENT_NAME_ADDED_TO_CARTEVENT_NAME_ADDED_TO_WISHLISTLog this event when the user has added an item to their wishlist.
The valueToSum passed to logEvent should be the item's price.
public static final String EVENT_NAME_ADDED_TO_WISHLISTEVENT_NAME_INITIATED_CHECKOUTLog this event when the user has entered the checkout process.
The valueToSum passed to logEvent should be the total price in the cart.
public static final String EVENT_NAME_INITIATED_CHECKOUTEVENT_NAME_ADDED_PAYMENT_INFOLog this event when the user has entered their payment info.
public static final String EVENT_NAME_ADDED_PAYMENT_INFOEVENT_NAME_PURCHASEDpublic static final String EVENT_NAME_PURCHASEDEVENT_NAME_ACHIEVED_LEVELLog this event when the user has achieved a level in the app.
public static final String EVENT_NAME_ACHIEVED_LEVELEVENT_NAME_UNLOCKED_ACHIEVEMENTLog this event when the user has unlocked an achievement in the app.
public static final String EVENT_NAME_UNLOCKED_ACHIEVEMENTEVENT_NAME_SPENT_CREDITSLog this event when the user has spent app credits.
The valueToSum passed to logEvent should be the number of credits spent.
public static final String EVENT_NAME_SPENT_CREDITSEVENT_PARAM_CURRENCYParameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See
ISO-4217
for specific values.
public static final String EVENT_PARAM_CURRENCYEVENT_PARAM_REGISTRATION_METHODParameter key used to specify the method the user has used to register for the app, e.g.,
"Facebook", "email", "Twitter", etc.
public static final String EVENT_PARAM_REGISTRATION_METHODEVENT_PARAM_CONTENT_TYPEParameter key used to specify a generic content type/family for the logged event, e.g.
"music", "photo", "video". Options to use will vary depending on the nature of the app.
public static final String EVENT_PARAM_CONTENT_TYPEEVENT_PARAM_CONTENT_IDParameter key used to specify an ID for the specific piece of content being logged about.
This could be an EAN, article identifier, etc., depending on the nature of the app.
public static final String EVENT_PARAM_CONTENT_IDEVENT_PARAM_SEARCH_STRINGParameter key used to specify the string provided by the user for a search operation.
public static final String EVENT_PARAM_SEARCH_STRINGEVENT_PARAM_SUCCESSParameter key used to specify whether the activity being logged about was successful or not.
EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good canonical values to use for this
parameter.
public static final String EVENT_PARAM_SUCCESSEVENT_PARAM_MAX_RATING_VALUEParameter key used to specify the maximum rating available for the EVENT_NAME_RATE event.
E.g., "5" or "10".
public static final String EVENT_PARAM_MAX_RATING_VALUEEVENT_PARAM_PAYMENT_INFO_AVAILABLEParameter key used to specify whether payment info is available for the
EVENT_NAME_INITIATED_CHECKOUT event. EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good
canonical values to use for this parameter.
public static final String EVENT_PARAM_PAYMENT_INFO_AVAILABLEEVENT_PARAM_NUM_ITEMSParameter key used to specify how many items are being processed for an
EVENT_NAME_INITIATED_CHECKOUT or EVENT_NAME_PURCHASE event.
public static final String EVENT_PARAM_NUM_ITEMSEVENT_PARAM_LEVELParameter key used to specify the level achieved in an EVENT_NAME_LEVEL_ACHIEVED event.
public static final String EVENT_PARAM_LEVELEVENT_PARAM_DESCRIPTIONParameter key used to specify a description appropriate to the event being logged.
E.g., the name of the achievement unlocked in the EVENT_NAME_ACHIEVEMENT_UNLOCKED event.
public static final String EVENT_PARAM_DESCRIPTIONEVENT_PARAM_SOURCE_APPLICATIONParameter key used to specify source application package.
public static final String EVENT_PARAM_SOURCE_APPLICATIONEVENT_PARAM_VALUE_YESYes-valued parameter value to be used with parameter keys that need a Yes/No value
public static final String EVENT_PARAM_VALUE_YESEVENT_PARAM_VALUE_NONo-valued parameter value to be used with parameter keys that need a Yes/No value
public static final String EVENT_PARAM_VALUE_NO