com.adcolony.sdk

Class AdColonyEventTracker

java.lang.Object

com.adcolony.sdk.AdColonyEventTracker

public class AdColonyEventTracker
extends java.lang.Object

Contains static, public API methods for sending Post Install Events (PIE).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOM_EVENT_1
static java.lang.String	CUSTOM_EVENT_2
static java.lang.String	CUSTOM_EVENT_3
static java.lang.String	CUSTOM_EVENT_4
static java.lang.String	CUSTOM_EVENT_5
static java.lang.String	LOGIN_DEFAULT Valid values for 'logLogin' method parameter.
static java.lang.String	LOGIN_FACEBOOK
static java.lang.String	LOGIN_GOOGLE
static java.lang.String	LOGIN_LINKEDIN
static java.lang.String	LOGIN_OPENID
static java.lang.String	LOGIN_TWITTER
static java.lang.String	REGISTRATION_CUSTOM
static java.lang.String	REGISTRATION_DEFAULT
static java.lang.String	REGISTRATION_FACEBOOK
static java.lang.String	REGISTRATION_GOOGLE
static java.lang.String	REGISTRATION_LINKEDIN
static java.lang.String	REGISTRATION_OPENID
static java.lang.String	REGISTRATION_TWITTER
static java.lang.String	SOCIAL_SHARING_CUSTOM
static java.lang.String	SOCIAL_SHARING_FACEBOOK
static java.lang.String	SOCIAL_SHARING_FLICKR
static java.lang.String	SOCIAL_SHARING_FOURSQUARE
static java.lang.String	SOCIAL_SHARING_GOOGLE
static java.lang.String	SOCIAL_SHARING_INSTAGRAM
static java.lang.String	SOCIAL_SHARING_LINKEDIN
static java.lang.String	SOCIAL_SHARING_PINTEREST
static java.lang.String	SOCIAL_SHARING_SNAPCHAT
static java.lang.String	SOCIAL_SHARING_TUMBLR
static java.lang.String	SOCIAL_SHARING_TWITTER
static java.lang.String	SOCIAL_SHARING_VIMEO
static java.lang.String	SOCIAL_SHARING_VINE
static java.lang.String	SOCIAL_SHARING_YOUTUBE

Constructor Summary

Constructors

Constructor and Description
AdColonyEventTracker()

Method Summary

Modifier and Type	Method and Description
static void	logAchievementUnlocked(java.lang.String description) Log an event when a user unlocks an achievement, e.g.
static void	logActivated() Log an event when the user activates the app of their account.
static void	logAddToCart(java.lang.String itemId) Log an event when the user adds an item(s) to a shopping cart.
static void	logAddToWishlist(java.lang.String itemId) Log an event when the user adds an item(s) to their wishlist.
static void	logAppRated() Log an event when the user has rated your application.
static void	logCheckoutInitiated() Log an event when a user has added items to their cart, but have not yet completed the checkout process.
static void	logContentView(java.lang.String contentId, java.lang.String contentType) Log a content view event.
static void	logCreditsSpent(java.lang.String name, java.lang.Integer quantity, java.lang.Double value, java.lang.String currencyCode) Log a credits spent event, e.g.
static void	logCustomEvent(java.lang.String event, java.lang.String description) Log a custom event.
static void	logEvent(java.lang.String eventName) Logs events that do not have a predefined method within this class.
static void	logEvent(java.lang.String eventName, java.util.HashMap<java.lang.String,java.lang.String> payload) Logs events that do not have a predefined method within this class.
static void	logInvite() Log an invite when a user invites friends to install or re-engage in your app or service.
static void	logLevelAchieved(java.lang.Integer levelAchieved) Log a level achieved event.
static void	logLogin(java.lang.String method) Log a login event if the user has successfully logged in.
static void	logPaymentInfoAdded() Log an event when the user has added payment information.
static void	logRegistrationCompleted(java.lang.String method, java.lang.String description) Log a 'registration completed' event, e.g.
static void	logReservation() Log a reservation event when a user has completed a reservation.
static void	logSearch(java.lang.String searchString) Log a search event when a user has completed a search.
static void	logSocialSharingEvent(java.lang.String network, java.lang.String description) Log a social sharing event, e.g.
static void	logTransaction(java.lang.String itemId, java.lang.Integer quantity, java.lang.Double price, java.lang.String currencyCode, java.lang.String receipt, java.lang.String store, java.lang.String description) Report a transaction/purchase event.
static void	logTutorialCompleted() Log an event when the user completes a tutorial.

Methods inherited from class java.lang.Object

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

Field Detail

SOCIAL_SHARING_FACEBOOK

public static final java.lang.String SOCIAL_SHARING_FACEBOOK

See Also:

Constant Field Values

SOCIAL_SHARING_TWITTER

public static final java.lang.String SOCIAL_SHARING_TWITTER

See Also:

Constant Field Values

SOCIAL_SHARING_GOOGLE

public static final java.lang.String SOCIAL_SHARING_GOOGLE

See Also:

Constant Field Values

SOCIAL_SHARING_LINKEDIN

public static final java.lang.String SOCIAL_SHARING_LINKEDIN

See Also:

Constant Field Values

SOCIAL_SHARING_PINTEREST

public static final java.lang.String SOCIAL_SHARING_PINTEREST

See Also:

Constant Field Values

SOCIAL_SHARING_YOUTUBE

public static final java.lang.String SOCIAL_SHARING_YOUTUBE

See Also:

Constant Field Values

SOCIAL_SHARING_INSTAGRAM

public static final java.lang.String SOCIAL_SHARING_INSTAGRAM

See Also:

Constant Field Values

SOCIAL_SHARING_TUMBLR

public static final java.lang.String SOCIAL_SHARING_TUMBLR

See Also:

Constant Field Values

SOCIAL_SHARING_FLICKR

public static final java.lang.String SOCIAL_SHARING_FLICKR

See Also:

Constant Field Values

SOCIAL_SHARING_VIMEO

public static final java.lang.String SOCIAL_SHARING_VIMEO

See Also:

Constant Field Values

SOCIAL_SHARING_FOURSQUARE

public static final java.lang.String SOCIAL_SHARING_FOURSQUARE

See Also:

Constant Field Values

SOCIAL_SHARING_VINE

public static final java.lang.String SOCIAL_SHARING_VINE

See Also:

Constant Field Values

SOCIAL_SHARING_SNAPCHAT

public static final java.lang.String SOCIAL_SHARING_SNAPCHAT

See Also:

Constant Field Values

SOCIAL_SHARING_CUSTOM

public static final java.lang.String SOCIAL_SHARING_CUSTOM

See Also:

Constant Field Values

REGISTRATION_DEFAULT

public static final java.lang.String REGISTRATION_DEFAULT

See Also:

Constant Field Values

REGISTRATION_FACEBOOK

public static final java.lang.String REGISTRATION_FACEBOOK

See Also:

Constant Field Values

REGISTRATION_TWITTER

public static final java.lang.String REGISTRATION_TWITTER

See Also:

Constant Field Values

REGISTRATION_GOOGLE

public static final java.lang.String REGISTRATION_GOOGLE

See Also:

Constant Field Values

REGISTRATION_LINKEDIN

public static final java.lang.String REGISTRATION_LINKEDIN

See Also:

Constant Field Values

REGISTRATION_OPENID

public static final java.lang.String REGISTRATION_OPENID

See Also:

Constant Field Values

REGISTRATION_CUSTOM

public static final java.lang.String REGISTRATION_CUSTOM

See Also:

Constant Field Values

CUSTOM_EVENT_1

public static final java.lang.String CUSTOM_EVENT_1

See Also:

Constant Field Values

CUSTOM_EVENT_2

public static final java.lang.String CUSTOM_EVENT_2

See Also:

Constant Field Values

CUSTOM_EVENT_3

public static final java.lang.String CUSTOM_EVENT_3

See Also:

Constant Field Values

CUSTOM_EVENT_4

public static final java.lang.String CUSTOM_EVENT_4

See Also:

Constant Field Values

CUSTOM_EVENT_5

public static final java.lang.String CUSTOM_EVENT_5

See Also:

Constant Field Values

LOGIN_DEFAULT

public static final java.lang.String LOGIN_DEFAULT

Valid values for 'logLogin' method parameter.

See Also:

Constant Field Values

LOGIN_FACEBOOK

public static final java.lang.String LOGIN_FACEBOOK

See Also:

Constant Field Values

LOGIN_TWITTER

public static final java.lang.String LOGIN_TWITTER

See Also:

Constant Field Values

LOGIN_GOOGLE

public static final java.lang.String LOGIN_GOOGLE

See Also:

Constant Field Values

LOGIN_LINKEDIN

public static final java.lang.String LOGIN_LINKEDIN

See Also:

Constant Field Values

LOGIN_OPENID

public static final java.lang.String LOGIN_OPENID

See Also:

Constant Field Values

Constructor Detail

AdColonyEventTracker

public AdColonyEventTracker()

Method Detail

logTransaction

public static void logTransaction(@Nullable
                                  java.lang.String itemId,
                                  @Nullable
                                  java.lang.Integer quantity,
                                  @Nullable
                                  java.lang.Double price,
                                  @Nullable
                                  java.lang.String currencyCode,
                                  @Nullable
                                  java.lang.String receipt,
                                  @Nullable
                                  java.lang.String store,
                                  @Nullable
                                  java.lang.String description)

Report a transaction/purchase event. You can also provide additional information about the transaction like the quantity, price and currency code.

Parameters:

itemId - Identifier of item purchased

quantity - Quantity of items purchased

price - Total price of the items purchased

currencyCode - The real-world three-letter ISO 4217 (e.g. USD) currency code of the transaction

store - The store the purchase was made through

receipt - The receipt number

description - Description of the purchased product

logCreditsSpent

public static void logCreditsSpent(@Nullable
                                   java.lang.String name,
                                   @Nullable
                                   java.lang.Integer quantity,
                                   @Nullable
                                   java.lang.Double value,
                                   @Nullable
                                   java.lang.String currencyCode)

Log a credits spent event, e.g. when a user applies credits to purchase something of value. You can also provide additional information about the transaction like the name, quantity, real-world value and currency code.

Parameters:

name - The type of credits the user has spent

quantity - The quantity of the credits spent

value - The real-world value of the credits spent

currencyCode - The real-world three-letter ISO 4217 (e.g. USD) currency code of the transaction.

logPaymentInfoAdded

public static void logPaymentInfoAdded()

Log an event when the user has added payment information.

logAchievementUnlocked

public static void logAchievementUnlocked(@Nullable
                                          java.lang.String description)

Log an event when a user unlocks an achievement, e.g. 'complete 200 deliveries'. You can also add a description of the achievement.

Parameters:

description - Description of the event

logLevelAchieved

public static void logLevelAchieved(@Nullable
                                    java.lang.Integer levelAchieved)

Log a level achieved event. You can also add the level achieved by the user.

Parameters:

levelAchieved - The level achieved by the user

logAppRated

public static void logAppRated()

Log an event when the user has rated your application.

logActivated

public static void logActivated()

Log an event when the user activates the app of their account.

logTutorialCompleted

public static void logTutorialCompleted()

Log an event when the user completes a tutorial.

logSocialSharingEvent

public static void logSocialSharingEvent(@Nullable
                                         java.lang.String network,
                                         @Nullable
                                         java.lang.String description)

Log a social sharing event, e.g. 'user shared an achievement on Facebook'. You can also provide a description of the social sharing event and denote the network on which the event was shared.

Parameters:

network - Associated Social Network (requires the SOCIAL_SHARING_* constants defined within this class)

description - Description of the social sharing event - must be less than 512 characters

logRegistrationCompleted

public static void logRegistrationCompleted(@Nullable
                                            java.lang.String method,
                                            @Nullable
                                            java.lang.String description)

Log a 'registration completed' event, e.g. when a user has finished the registration process. You can also denote the registration method used: Facebook, Google, etc.

Parameters:

method - The registration method used (requires the REGISTRATION_* constants defined within this class)

description - Description describing the registration event. Passing a null value is allowed. Should only pass this in if you are passing in REGISTRATION_CUSTOM for the method. Will be ignored otherwise. Max 512 characters

logCustomEvent

public static void logCustomEvent(@Nullable
                                  java.lang.String event,
                                  @Nullable
                                  java.lang.String description)

Log a custom event. Currently, publishers are allowed up to 5 custom events and are required to keep track of what each CUSTOM_EVENT_* corresponds to on their end.

Parameters:

event - The name of the custom event (requires the CUSTOM_EVENT_* constants defined within this class)

description - The description of the custom event

logAddToCart

public static void logAddToCart(@Nullable
                                java.lang.String itemId)

Log an event when the user adds an item(s) to a shopping cart. You can also add the product identifier for the item purchased.

Parameters:

itemId - Identifier of item added to cart

logAddToWishlist

public static void logAddToWishlist(@Nullable
                                    java.lang.String itemId)

Log an event when the user adds an item(s) to their wishlist. You can also add the product identifier for the item(s) added to the wishlist.

Parameters:

itemId - Identifier of item added to wishlist

logCheckoutInitiated

public static void logCheckoutInitiated()

Log an event when a user has added items to their cart, but have not yet completed the checkout process.

logContentView

public static void logContentView(@Nullable
                                  java.lang.String contentId,
                                  @Nullable
                                  java.lang.String contentType)

Log a content view event. You can also log the content ID and content type viewed.

Parameters:

contentId - Identifier of content viewed

contentType - Type of content viewed

logInvite

public static void logInvite()

Log an invite when a user invites friends to install or re-engage in your app or service.

logLogin

public static void logLogin(@Nullable
                            java.lang.String method)

Log a login event if the user has successfully logged in.

Parameters:

method - The login method used (requires the LOGIN_* constants defined within this class)

logReservation

public static void logReservation()

Log a reservation event when a user has completed a reservation.

logSearch

public static void logSearch(@Nullable
                             java.lang.String searchString)

Log a search event when a user has completed a search.

Parameters:

searchString - Search terms, keywords, or queries

logEvent

public static void logEvent(@Nullable
                            java.lang.String eventName)

Logs events that do not have a predefined method within this class.

Parameters:

eventName - Name of the event

logEvent

public static void logEvent(@NonNull
                            java.lang.String eventName,
                            @Nullable
                            java.util.HashMap<java.lang.String,java.lang.String> payload)

Logs events that do not have a predefined method within this class.

Parameters:

eventName - Name of the event

payload - Event passed with any additional parameters required