com.kongregate.android.api

Interface AnalyticsServices

public interface AnalyticsServices

This interface wraps the functionality provided by the Adjust and Swrve SDKs. It also includeds legacy support for Keen. Ad-X has been removed from the Kongregate SDK.

The primary purpose of this interface is to expose hooks for games to pass events to Swrve and Adjust. It also provides wrappers for some additional Swrve features such as User Properties, A/B Testing, and Push Notifications. See the Mobile SDK Docs for details of the various features.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AnalyticsServices.AutoEventListener
static class	AnalyticsServices.Events
static class	AnalyticsServices.Fields Kongregate automatic fields you may retrieve using the getAutoBoolProperty(String), getAutoIntProperty(String), etc...
static class	AnalyticsServices.IabResult

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADJUST_EVENT_PREFIX
static java.lang.String	DELTA_EVENT_PREFIX
static java.lang.String	SWRVE_EVENT_PREFIX
static java.lang.String	SWRVE_VIRTUAL_ECONOMY_EVENT_GIFT
static java.lang.String	SWRVE_VIRTUAL_ECONOMY_EVENT_PURCHASE
static java.lang.String	SWRVE_VIRTUAL_ECONOMY_PARAM_AMOUNT
static java.lang.String	SWRVE_VIRTUAL_ECONOMY_PARAM_COST
static java.lang.String	SWRVE_VIRTUAL_ECONOMY_PARAM_CURRENCY
static java.lang.String	SWRVE_VIRTUAL_ECONOMY_PARAM_ITEM
static java.lang.String	SWRVE_VIRTUAL_ECONOMY_PARAM_QUANTITY

Method Summary

Modifier and Type	Method and Description
void	addEvent(java.lang.String eventCollection, java.util.Map<java.lang.String,java.lang.Object> event) Add an analytics event.
void	addEvent(java.lang.String collection, java.lang.String eventJson, java.lang.String commonPropsJson) Add analytic event using formatted JSON strings
void	addFilterType(java.lang.String value) Adds a filter type to the list of filters
void	addIapTransaction(double revenueUSD, java.lang.String receiptOriginalJSON, java.lang.String receiptSignature, java.util.Map<java.lang.String,java.lang.Object> gameFields) Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google Purchase.
void	addIapTransaction(double revenueUSD, java.lang.String receiptOriginalJSON, java.lang.String receiptSignature, java.lang.String gameFieldsJson) Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google Purchase.
void	addIapTransactionWithCurrency(double revenue, java.lang.String revenueCurrency, java.lang.String receiptOriginalJSON, java.lang.String receiptSignature, java.util.Map<java.lang.String,java.lang.Object> gameFields) Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google Purchase.
void	addIapTransactionWithCurrency(double revenue, java.lang.String revenueCurrency, java.lang.String receiptOriginalJSON, java.lang.String receiptSignature, java.lang.String gameFieldsJson) Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google Purchase.
void	addIapTransactionWithoutReceipt(double revenue, java.lang.String revenueCurrency, java.lang.String productId, java.util.Map<java.lang.String,java.lang.Object> gameFields) Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google App IAP Purchase.
void	addIapTransactionWithoutReceipt(double revenue, java.lang.String revenueCurrency, java.lang.String productId, java.lang.String gameFieldsJson) Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google App IAP Purchase.
void	finishPromoAward(java.lang.String eventPayload) Notify the Kongregate SDK that a promo award has been handled.
void	finishPurchase(AnalyticsServices.IabResult resultCode, java.lang.String resultData, java.util.Map<java.lang.String,java.lang.Object> gameFields) Creates either iap_transactions or iap_fails purchase events depending on resultCode and state of the resultData.
void	finishPurchase(AnalyticsServices.IabResult resultCode, java.lang.String resultData, java.util.Map<java.lang.String,java.lang.Object> gameFields, java.lang.String dataSignature) Creates either iap_transactions or iap_fails purchase events depending on resultCode and state of the resultData.
void	finishPurchase(java.lang.String resultCode, java.lang.String resultData, java.lang.String gameFieldsJson) Creates either iap_transactions or iap_fails purchase events depending on resultCode and state of the resultData.
void	finishPurchase(java.lang.String resultCode, java.lang.String resultData, java.lang.String gameFieldsJson, java.lang.String dataSignature) Creates either iap_transactions or iap_fails purchase events depending on resultCode and state of the resultData.
void	gameUserUpdate(java.util.Map<java.lang.String,java.lang.String> props) Update game specific Swrve user properties.
void	gameUserUpdate(java.lang.String propsJson) Update game specific Swrve user properties from a JSON formated string.
boolean	getAutoBoolProperty(java.lang.String field) Get a boolean automatic property
double	getAutoDoubleProperty(java.lang.String field) Get a double automatic property
int	getAutoIntProperty(java.lang.String field) Get an int automatic property
long	getAutoLongProperty(java.lang.String field) Get a long automatic property
java.lang.String	getAutoPropertiesJSON() Get kongregate automatic properties as a JSON formatted string
java.lang.String	getAutoStringProperty(java.lang.String field) Get a string automatic property
java.lang.String	getAutoUTCProperty(java.lang.String field) Get an UTC formated Timestamp automatic property
java.lang.String	getInstallReferrer() Get the referrer string
java.lang.String	getKongPropertiesJSON() Returns the common analytics properties collected by the Kongregate SDK
java.util.Set<java.lang.String>	getResouceNames() Retrieve the set of Swrve resource names
boolean	getResourceAsBool(java.lang.String resourceId, java.lang.String attributeId, boolean defValue) Retrieve a Swrve A/B test resource as a boolean.
float	getResourceAsFloat(java.lang.String resourceId, java.lang.String attributeId, float defValue) Retrieve a Swrve A/B test resource as a float.
int	getResourceAsInt(java.lang.String resourceId, java.lang.String attributeId, int defValue) Retrieve a Swrve A/B test resource as an int.
java.lang.String	getResourceAsString(java.lang.String resourceId, java.lang.String attributeId, java.lang.String defValue) Retrieve a Swrve A/B test resource as a string.
java.lang.String	getResourceNamesAsJson() Retrieve the set of Swrve resource names as a JSON array
java.util.Map<java.lang.String,java.lang.Object>	getResources() Retrieve the map of Swrve resources
void	setAutoEventListener(AnalyticsServices.AutoEventListener listener) Sets a listener for analytic events the Kongregate SDK automatically fires.
void	setCommonProperties(java.util.Map<java.lang.String,java.lang.Object> commonProps) Set the common props from a JSON object which will be added to the next event fired, if setCommonPropertiesEvaluator(CommonPropertiesEvaluator) is not set.
void	setCommonProperties(java.lang.String commonPropsJson) Set the common props from a JSON object which will be added to the next event fired, if setCommonPropertiesEvaluator(CommonPropertiesEvaluator) is not set.
void	setCommonPropertiesEvaluator(CommonPropertiesEvaluator evaluator) Set common props evaluator which will be invoked each time an event is fired to retrieve a fresh map of common properties.
void	setFilterType(java.lang.String value) Deprecated.
void	setPushToken(java.lang.String token) Sets the push token used by Adjust for uninstall tracking.
void	start(android.app.Activity activity) When using KongregateAPI.KONGREGATE_OPTION_DEFER_ANALYTICS, this allows you to start the analytics subsystem.
void	startPurchase(java.lang.String productId, java.util.Map<java.lang.String,java.lang.Object> gameFields) Tracks the start of the purchase flow.
void	startPurchase(java.lang.String productId, java.lang.String gameFieldsJson) Tracks the start of the purchase flow.
void	trackPurchase(java.lang.String productID) Deprecated.
void	trackPurchase(java.lang.String productId, java.util.Map<java.lang.String,java.lang.Object> gameFields) Deprecated.
void	trackPurchase(java.lang.String productId, java.lang.String gameFieldsJSON) Deprecated.

Field Detail

SWRVE_VIRTUAL_ECONOMY_EVENT_PURCHASE

static final java.lang.String SWRVE_VIRTUAL_ECONOMY_EVENT_PURCHASE

See Also:

Constant Field Values

SWRVE_VIRTUAL_ECONOMY_EVENT_GIFT

static final java.lang.String SWRVE_VIRTUAL_ECONOMY_EVENT_GIFT

See Also:

Constant Field Values

SWRVE_VIRTUAL_ECONOMY_PARAM_ITEM

static final java.lang.String SWRVE_VIRTUAL_ECONOMY_PARAM_ITEM

See Also:

Constant Field Values

SWRVE_VIRTUAL_ECONOMY_PARAM_CURRENCY

static final java.lang.String SWRVE_VIRTUAL_ECONOMY_PARAM_CURRENCY

See Also:

Constant Field Values

SWRVE_VIRTUAL_ECONOMY_PARAM_COST

static final java.lang.String SWRVE_VIRTUAL_ECONOMY_PARAM_COST

See Also:

Constant Field Values

SWRVE_VIRTUAL_ECONOMY_PARAM_QUANTITY

static final java.lang.String SWRVE_VIRTUAL_ECONOMY_PARAM_QUANTITY

See Also:

Constant Field Values

SWRVE_VIRTUAL_ECONOMY_PARAM_AMOUNT

static final java.lang.String SWRVE_VIRTUAL_ECONOMY_PARAM_AMOUNT

See Also:

Constant Field Values

SWRVE_EVENT_PREFIX

static final java.lang.String SWRVE_EVENT_PREFIX

See Also:

Constant Field Values

DELTA_EVENT_PREFIX

static final java.lang.String DELTA_EVENT_PREFIX

See Also:

Constant Field Values

ADJUST_EVENT_PREFIX

static final java.lang.String ADJUST_EVENT_PREFIX

See Also:

Constant Field Values

Method Detail

addEvent

void addEvent(java.lang.String eventCollection,
              java.util.Map<java.lang.String,java.lang.Object> event)

Add an analytics event.

Parameters:

eventCollection -

event -

addEvent

void addEvent(java.lang.String collection,
              java.lang.String eventJson,
              java.lang.String commonPropsJson)

Add analytic event using formatted JSON strings

Parameters:

collection - the collection to add the event to

eventJson - json object for the event

commonPropsJson - json object for the common event properties

setCommonPropertiesEvaluator

void setCommonPropertiesEvaluator(CommonPropertiesEvaluator evaluator)

Set common props evaluator which will be invoked each time an event is fired to retrieve a fresh map of common properties.

Parameters:

evaluator - The evaluator to be invoked with each event.

setAutoEventListener

void setAutoEventListener(AnalyticsServices.AutoEventListener listener)

Sets a listener for analytic events the Kongregate SDK automatically fires. Most games will not need to listen for these events. It's useful if you wish to echo the events to your own analytics collection system.

Parameters:

listener -

setCommonProperties

void setCommonProperties(java.lang.String commonPropsJson)

Set the common props from a JSON object which will be added to the next event fired, if setCommonPropertiesEvaluator(CommonPropertiesEvaluator) is not set.

Parameters:

commonPropsJson - A JSON formatted string of common properties

setCommonProperties

void setCommonProperties(java.util.Map<java.lang.String,java.lang.Object> commonProps)

Set the common props from a JSON object which will be added to the next event fired, if setCommonPropertiesEvaluator(CommonPropertiesEvaluator) is not set.

Parameters:

commonProps - A map of common properties

gameUserUpdate

void gameUserUpdate(java.lang.String propsJson)

Update game specific Swrve user properties from a JSON formated string. All values must be strings.

Parameters:

propsJson -

gameUserUpdate

void gameUserUpdate(java.util.Map<java.lang.String,java.lang.String> props)

Update game specific Swrve user properties.

Parameters:

props -

setPushToken

void setPushToken(java.lang.String token)

Sets the push token used by Adjust for uninstall tracking.

Parameters:

token -

setFilterType

@Deprecated
void setFilterType(java.lang.String value)

Deprecated.

see addFilterType(String)

addFilterType

void addFilterType(java.lang.String value)

Adds a filter type to the list of filters

Parameters:

value -

getAutoPropertiesJSON

java.lang.String getAutoPropertiesJSON()

Get kongregate automatic properties as a JSON formatted string

Returns:

JSON string of kong auto props

getInstallReferrer

java.lang.String getInstallReferrer()

Get the referrer string

Returns:

the referrer string if set, or an empty string

getAutoStringProperty

java.lang.String getAutoStringProperty(java.lang.String field)

Get a string automatic property

Parameters:

field - The field name

Returns:

the prop value

getAutoLongProperty

long getAutoLongProperty(java.lang.String field)

Get a long automatic property

Parameters:

field - The field name

Returns:

the prop value

getAutoIntProperty

int getAutoIntProperty(java.lang.String field)

Get an int automatic property

Parameters:

field - The field name

Returns:

the prop value

getAutoUTCProperty

java.lang.String getAutoUTCProperty(java.lang.String field)

Get an UTC formated Timestamp automatic property

Parameters:

field - The field name

Returns:

the prop value

getAutoBoolProperty

boolean getAutoBoolProperty(java.lang.String field)

Get a boolean automatic property

Parameters:

field - The field name

Returns:

the prop value

getAutoDoubleProperty

double getAutoDoubleProperty(java.lang.String field)

Get a double automatic property

Parameters:

field - The field name

Returns:

the prop value

trackPurchase

@Deprecated
void trackPurchase(java.lang.String productID)

Deprecated.

see finishPurchase(IabResult, String, Map, String)

trackPurchase

@Deprecated
void trackPurchase(java.lang.String productId,
                               java.util.Map<java.lang.String,java.lang.Object> gameFields)

Deprecated.

see finishPurchase(IabResult, String, Map, String)

trackPurchase

@Deprecated
void trackPurchase(java.lang.String productId,
                               java.lang.String gameFieldsJSON)

Deprecated.

see finishPurchase(IabResult, String, Map, String)

startPurchase

void startPurchase(java.lang.String productId,
                   java.util.Map<java.lang.String,java.lang.Object> gameFields)

Tracks the start of the purchase flow. Fires the the iap_attempts event.

Parameters:

productId - The productId tht is attempting to be purchased

gameFields - A map of the game fileds.

startPurchase

void startPurchase(java.lang.String productId,
                   java.lang.String gameFieldsJson)

Tracks the start of the purchase flow. Same as startPurchase(String, java.util.Map), but accepts the game fields as a JSON String.

Parameters:

productId - The productId that is attempting to be purchased

gameFieldsJson - The game fields as a JSON string.

finishPurchase

void finishPurchase(java.lang.String resultCode,
                    java.lang.String resultData,
                    java.lang.String gameFieldsJson)

Creates either iap_transactions or iap_fails purchase events depending on resultCode and state of the resultData. Invoke this after the purchase is complete and the receipt verified (is using Receipt Verification).

Parameters:

resultCode -

• one of SUCCESS, FAIL, RECEIPT_FAIL

resultData -

• on SUCCESS or RECEIPT_FAIL this should be the orginalJson returned from the playstore. If using IABHelper classes: Purchase.getOriginalJson()). If the result is fail, pass the error message from the result. Again if ussing IABHelper classes: IabResult.getMessage()

gameFieldsJson -

• additional json values to pass along with the event (e.g. soft_currency_gained)

finishPurchase

void finishPurchase(java.lang.String resultCode,
                    java.lang.String resultData,
                    java.lang.String gameFieldsJson,
                    java.lang.String dataSignature)

Creates either iap_transactions or iap_fails purchase events depending on resultCode and state of the resultData. Invoke this after the purchase is complete and the receipt verified (is using Receipt Verification).

Parameters:

resultCode -

• one of SUCCESS, FAIL, RECEIPT_FAIL

resultData -

• on SUCCESS or RECEIPT_FAIL this should be the orginalJson returned from the playstore. If using IABHelper classes: Purchase.getOriginalJson()). If the result is fail, pass the error message from the result. Again if ussing IABHelper classes: IabResult.getMessage()

gameFieldsJson -

• additional json values to pass along with the event (e.g. soft_currency_gained)

dataSignature - the signature used to sign result data. Used by SWRVE analytics to verify the purchase.

finishPurchase

void finishPurchase(AnalyticsServices.IabResult resultCode,
                    java.lang.String resultData,
                    java.util.Map<java.lang.String,java.lang.Object> gameFields)

Creates either iap_transactions or iap_fails purchase events depending on resultCode and state of the resultData. Invoke this after the purchase is complete and the receipt verified (is using Receipt Verification).

Parameters:

resultCode -

• one of SUCCESS, FAIL, RECEIPT_FAIL

resultData -

• on SUCCESS or RECEIPT_FAIL this should be the orginalJson returned from the playstore. If using IABHelper classes: Purchase.getOriginalJson()). If the result is fail, pass the error message from the result. Again if ussing IABHelper classes: IabResult.getMessage()

gameFields -

• additional json values to pass along with the event (e.g. soft_currency_gained)

finishPurchase

void finishPurchase(AnalyticsServices.IabResult resultCode,
                    java.lang.String resultData,
                    java.util.Map<java.lang.String,java.lang.Object> gameFields,
                    java.lang.String dataSignature)

Creates either iap_transactions or iap_fails purchase events depending on resultCode and state of the resultData. Invoke this after the purchase is complete and the receipt verified (is using Receipt Verification).

Parameters:

resultCode -

• one of SUCCESS, FAIL, RECEIPT_FAIL

resultData -

• on SUCCESS or RECEIPT_FAIL this should be the orginalJson returned from the playstore. If using IABHelper classes: Purchase.getOriginalJson()). If the result is fail, pass the error message from the result. Again if ussing IABHelper classes: IabResult.getMessage()

gameFields -

• additional json values to pass along with the event (e.g. soft_currency_gained)

dataSignature - the signature used to sign result data. Used by SWRVE analytics to verify the purchase.

addIapTransaction

void addIapTransaction(double revenueUSD,
                       java.lang.String receiptOriginalJSON,
                       java.lang.String receiptSignature,
                       java.lang.String gameFieldsJson)

Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google Purchase.

This is the preferred method to use when the purchased product does not conform to the TXX_description naming convention. It is preferred because the revenue is explicitly provided in USD where we are unable to infer the USD cost from the ID. By including the original receipt and signature we can extract additional information about the purchase and validate the receipt.

This should be invoked after the purchase is complete and the receipt verified.

Parameters:

revenueUSD - the purchase price of the item in US Dollars

receiptOriginalJSON - the original JSON receipt returned by the Google Play Store

receiptSignature - the signature returned by the Google Play Store

gameFieldsJson - JSON formated object of additional fields to include with the event (e.g. soft_currency_change )

addIapTransaction

void addIapTransaction(double revenueUSD,
                       java.lang.String receiptOriginalJSON,
                       java.lang.String receiptSignature,
                       java.util.Map<java.lang.String,java.lang.Object> gameFields)

Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google Purchase.

This is the preferred method to use when the purchased product does not conform to the TXX_description naming convention. It is preferred because the revenue is explicitly provided in USD where we are unable to infer the USD cost from the ID. By including the original receipt and signature we can extract additional information about the purchase and validate the receipt.

This should be invoked after the purchase is complete and the receipt verified.

Parameters:

revenueUSD - the purchase price of the item in US Dollars

receiptOriginalJSON - the original JSON receipt returned by the Google Play Store

receiptSignature - the signature returned by the Google Play Store

gameFields - Dictionary of additional fields to include with the event (e.g. soft_currency_change )

addIapTransactionWithCurrency

void addIapTransactionWithCurrency(double revenue,
                                   java.lang.String revenueCurrency,
                                   java.lang.String receiptOriginalJSON,
                                   java.lang.String receiptSignature,
                                   java.lang.String gameFieldsJson)

Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google Purchase.

AddGoogleIapTransaction() is the preferred method to use since it allows revenue to be normalized to USD. This method may be used when the USD price is unknown. Adjust does convert the revenue to USD in it's sale event, however Kongregate Analytics will not.

This should be invoked after the purchase is complete and the receipt verified.

Parameters:

revenue - the purchase price of the item in the given currency

revenueCurrency - the currency code the revenue is reported in.

receiptOriginalJSON - the original JSON receipt returned by the Google Play Store

receiptSignature - the signature returned by the Google Play Store

gameFieldsJson - JSON formated object of additional fields to include with the event (e.g. soft_currency_change )

addIapTransactionWithCurrency

void addIapTransactionWithCurrency(double revenue,
                                   java.lang.String revenueCurrency,
                                   java.lang.String receiptOriginalJSON,
                                   java.lang.String receiptSignature,
                                   java.util.Map<java.lang.String,java.lang.Object> gameFields)

Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google Purchase.

AddGoogleIapTransaction() is the preferred method to use since it allows revenue to be normalized to USD. This method may be used when the USD price is unknown. Adjust does convert the revenue to USD in it's sale event, however Kongregate Analytics will not.

This should be invoked after the purchase is complete and the receipt verified.

Parameters:

revenue - the purchase price of the item in the given currency

revenueCurrency - the currency code the revenue is reported in.

receiptOriginalJSON - the original JSON receipt returned by the Google Play Store

receiptSignature - the signature returned by the Google Play Store

gameFields - Dictionary of additional fields to include with the event (e.g. soft_currency_change )

addIapTransactionWithoutReceipt

void addIapTransactionWithoutReceipt(double revenue,
                                     java.lang.String revenueCurrency,
                                     java.lang.String productId,
                                     java.lang.String gameFieldsJson)

Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google App IAP Purchase.

addIapTransaction is the preferred methods. addIapTransactionWithoutReceipt may be used when the Google receipt is not available.

This should be invoked of the purchase is complete and the receipt has been verified.

Parameters:

revenue - the purchase price of the item in the given currency

revenueCurrency - the currency code the revenue is reported in.

productId - the identifier for the purchased product

gameFieldsJson - JSON formated object of additional fields to include with the event (e.g. soft_currency_change)

addIapTransactionWithoutReceipt

void addIapTransactionWithoutReceipt(double revenue,
                                     java.lang.String revenueCurrency,
                                     java.lang.String productId,
                                     java.util.Map<java.lang.String,java.lang.Object> gameFields)

Add a Kongregate Analytics iap_transaction event and Adjust sale event for a Google App IAP Purchase.

addIapTransaction is the preferred methods. addIapTransactionWithoutReceipt may be used when the Google receipt is not available.

This should be invoked of the purchase is complete and the receipt has been verified.

Parameters:

revenue - the purchase price of the item in the given currency

revenueCurrency - the currency code the revenue is reported in.

productId - the identifier for the purchased product

gameFields - Dictionary of additional fields to include with the event (e.g. soft_currency_change)

start

void start(android.app.Activity activity)

When using KongregateAPI.KONGREGATE_OPTION_DEFER_ANALYTICS, this allows you to start the analytics subsystem. You should attempt to call this function as quickly as possible after calling APIBootstrap.initializeNativeAPI(Activity, long, String, Map), or you may lose events.

getKongPropertiesJSON

java.lang.String getKongPropertiesJSON()

Returns the common analytics properties collected by the Kongregate SDK

getResources

java.util.Map<java.lang.String,java.lang.Object> getResources()

Retrieve the map of Swrve resources

getResouceNames

java.util.Set<java.lang.String> getResouceNames()

Retrieve the set of Swrve resource names

getResourceNamesAsJson

java.lang.String getResourceNamesAsJson()

Retrieve the set of Swrve resource names as a JSON array

getResourceAsString

java.lang.String getResourceAsString(java.lang.String resourceId,
                                     java.lang.String attributeId,
                                     java.lang.String defValue)

Retrieve a Swrve A/B test resource as a string.

Parameters:

resourceId - the ID of the Swrve resource

attributeId - the ID of the attribute

defValue - a devault value if the resource/attribute is not found.

Returns:

the value of the attribute in the resource, or the default alue if not found.

getResourceAsInt

int getResourceAsInt(java.lang.String resourceId,
                     java.lang.String attributeId,
                     int defValue)

Retrieve a Swrve A/B test resource as an int.

Parameters:

resourceId - the ID of the Swrve resource

attributeId - the ID of the attribute

defValue - a devault value if the resource/attribute is not found.

Returns:

the value of the attribute in the resource, or the default alue if not found.

getResourceAsFloat

float getResourceAsFloat(java.lang.String resourceId,
                         java.lang.String attributeId,
                         float defValue)

Retrieve a Swrve A/B test resource as a float.

Parameters:

resourceId - the ID of the Swrve resource

attributeId - the ID of the attribute

defValue - a devault value if the resource/attribute is not found.

Returns:

the value of the attribute in the resource, or the default alue if not found.

getResourceAsBool

boolean getResourceAsBool(java.lang.String resourceId,
                          java.lang.String attributeId,
                          boolean defValue)

Retrieve a Swrve A/B test resource as a boolean.

Parameters:

resourceId - the ID of the Swrve resource

attributeId - the ID of the attribute

defValue - a devault value if the resource/attribute is not found.

Returns:

the value of the attribute in the resource, or the default alue if not found.

finishPromoAward

void finishPromoAward(java.lang.String eventPayload)

Notify the Kongregate SDK that a promo award has been handled. This will update a Swrve User Property that may be used as a filter for additional Swrve messaging.

It's a good idea, particularly if your game has a server component, to also track awarded promoIds and to display a message if your game is asked to award a promo that has already been awarded. This will handle an edge case where a user can trick the client into showing an in-app message to perform the award again.

NOTE: you may also simply pass the promoID for the event, rather than the complete payload. When only the promoID is passed, the user property will be updated. When the full event payload is included, the SDK will parse the payload and may automatically preform other actions such as open an install URL.

Parameters:

eventPayload - the event payload for the PROMO_AWARD event.