AdColonyEventTracker Class Reference

Inherits from NSObject
Declared in AdColonyEventTracker.h

Overview

Use the following pre-defined values for the logSocialSharingEventWithNetwork:description method’s “network” parameter.

+ logTransactionWithID:quantity:price:currencyCode:receipt:store:description:

Report a transaction/purchase event.

+ (void)logTransactionWithID:(NSString *)itemID quantity:(NSInteger)quantity price:(NSNumber *)price currencyCode:(NSString *)currencyCode receipt:(NSString *)receipt store:(NSString *)store description:(NSString *)description

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
receipt

The receipt number
store

The store the purchase was made through
description

Description of the purchased product. Max 512 characters.

Discussion

Call this method to track any purchases made by the user.

Declared In

AdColonyEventTracker.h

+ logCreditsSpentWithName:quantity:value:currencyCode:

Report a credits_spent event. @description Invoke, for example, when a user applies credits to purchase in app merchandise. You can also provide additional information about the transaction like the name, quantity, real-world value and currency code

+ (void)logCreditsSpentWithName:(NSString *)name quantity:(NSInteger)quantity value:(NSNumber *)value currencyCode:(NSString *)currencyCode

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.

Declared In

AdColonyEventTracker.h

+ logPaymentInfoAdded

Report a payment_info_added event, when the user has added payment info for transactions.

+ (void)logPaymentInfoAdded

Declared In

AdColonyEventTracker.h

+ logAchievementUnlocked:

Report an achievement_unlocked event.

+ (void)logAchievementUnlocked:(NSString *)description

Parameters

description

A String description of the in-app achievement. Max 512 characters.

Discussion

Invoke when a user completes some goal, for example, ‘complete 200 deliveries’. You can also add a description of the achievement

Declared In

AdColonyEventTracker.h

+ logLevelAchieved:

Report a level_achieved event.

+ (void)logLevelAchieved:(NSInteger)level

Parameters

level

The new level reached by the user

Declared In

AdColonyEventTracker.h

+ logAppRated

Report an app_rated event.

+ (void)logAppRated

Discussion

Invoke when the user has rated the application.

Declared In

AdColonyEventTracker.h

+ logActivated

Report an activated event.

+ (void)logActivated

Discussion

Invoke when the user activates their account within the app.

Declared In

AdColonyEventTracker.h

+ logTutorialCompleted

Report a tutorial_completed event.

+ (void)logTutorialCompleted

Discussion

Invoke when the user completes an introductory tutorial for the app.

Declared In

AdColonyEventTracker.h

+ logSocialSharingEventWithNetwork:description:

Report a social_sharing event.

+ (void)logSocialSharingEventWithNetwork:(NSString *)network description:(NSString *)description

Parameters

network

Associated social network
description

Description of the social sharing event. Max 512 characters.

Discussion

Invoke, for example, when user shares an achievement on Facebook, Twitter, etc.. You can also provide a description of the social sharing event and denote the network on which the event was shared. We recommend using one of the provided constants for the social network: ADCSocialSharingMethodFacebook ADCSocialSharingMethodTwitter ADCSocialSharingMethodGoogle ADCSocialSharingMethodLinkedin ADCSocialSharingMethodPinterest ADCSocialSharingMethodYoutube ADCSocialSharingMethodInstagram ADCSocialSharingMethodTumblr ADCSocialSharingMethodFlickr ADCSocialSharingMethodVimeo ADCSocialSharingMethodFoursquare ADCSocialSharingMethodVine ADCSocialSharingMethodSnapchat ADCSocialSharingMethodCustom

Declared In

AdColonyEventTracker.h

+ logRegistrationCompletedWithMethod:description:

Report a registration_completed event.

+ (void)logRegistrationCompletedWithMethod:(NSString *)method description:(NSString *)description

Parameters

method

The registration method used
description

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

Discussion

Invoke when a user has finished the registration process within the app. You can also denote the registration method used: Facebook, Google, etc. We recommend using one of the provided constants for the method: ADCRegistrationMethodDefault ADCRegistrationMethodFacebook ADCRegistrationMethodTwitter ADCRegistrationMethodGoogle ADCRegistrationMethodLinkedIn ADCRegistrationMethodOpenID ADCRegistrationMethodCustom

Declared In

AdColonyEventTracker.h

+ logCustomEvent:description:

Report a custom_event.

+ (void)logCustomEvent:(NSString *)event description:(NSString *)description

Parameters

event

The custom event slot
description

The description of the custom event. Max 512 characters.

Discussion

Currently, publishers are allowed up to 5 custom event slots and are required to keep track of what each corresponds to on their end. We recommend using one of the provided constants for the event: ADCCustomEventSlot1 ADCCustomEventSlot2 ADCCustomEventSlot3 ADCCustomEventSlot4 ADCCustomEventSlot5

Declared In

AdColonyEventTracker.h

+ logAddToCartWithID:

Report an add_to_cart event.

+ (void)logAddToCartWithID:(NSString *)itemID

Parameters

itemID

Identifier of item added to cart

Discussion

Invoke when the user adds an item to a shopping cart. You can also report the product identifier for the item.

Declared In

AdColonyEventTracker.h

+ logAddToWishlistWithID:

Report an add_to_wishlist event.

+ (void)logAddToWishlistWithID:(NSString *)itemID

Parameters

itemID

Identifier of item added to cart

Discussion

Invoke when the user adds an item to their wishlist. You can also report the product identifier for the item.

Declared In

AdColonyEventTracker.h

+ logCheckoutInitiated

Report an checkout_initiated event

+ (void)logCheckoutInitiated

Discussion

Invoke when a user has begun the final checkout process.

Declared In

AdColonyEventTracker.h

+ logContentViewWithID:contentType:

Report a content_view event.

+ (void)logContentViewWithID:(NSString *)contentID contentType:(NSString *)contentType

Parameters

contentID

Identifier of content viewed
contentType

Type of content viewed

Discussion

Invoke when the user viewed the contents of a purchasable product

Declared In

AdColonyEventTracker.h

+ logInvite

Report an invite event.

+ (void)logInvite

Discussion

Invoke when a user invites friends or family to install or otherwise re-engage in your app or service.

Declared In

AdColonyEventTracker.h

+ logLoginWithMethod:

Report a login event.

+ (void)logLoginWithMethod:(NSString *)method

Parameters

method

The login method used.

Discussion

Invoke whenever the user has successfully logged in to the app. We recommend using one of the provided constants for the method: ADCLoginMethodDefault ADCLoginMethodFacebook ADCLoginMethodTwitter ADCLoginMethodGoogle ADCLoginMethodLinkedIn ADCLoginMethodOpenID ADCLoginMethodCustom

Declared In

AdColonyEventTracker.h

+ logReservation

Report a reservation event.

+ (void)logReservation

Declared In

AdColonyEventTracker.h

+ logSearchWithQuery:

Report a search event.

+ (void)logSearchWithQuery:(NSString *)queryString

Parameters

queryString

Search terms, keywords, or queries. As provided by the user.

Declared In

AdColonyEventTracker.h

+ logEvent:withDictionary:

Log an event.

+ (void)logEvent:(NSString *)name withDictionary:(NSDictionary *)payload

Parameters

name

Name of the event
payload

Event data, including both required and optional meta information.

Discussion

Provided to allow the construction and logging of events that do not have a predefined method within this class. We recommend using one of the provided constants for the event name: ADCEventTransaction ADCEventCreditsSpent ADCEventPaymentInfoAdded ADCEventAchievementUnlocked ADCEventLevelAchieved ADCEventAppRated ADCEventActivated ADCEventTutorialCompleted ADCEventSocialSharingEvent ADCEventRegistrationCompleted ADCEventCustomEvent ADCEventAddToCart ADCEventAddToWishlist ADCEventCheckoutInitiated ADCEventContentView ADCEventInvite ADCEventLogin ADCEventReservation ADCEventSearch

Declared In

AdColonyEventTracker.h