io.rakam.api

Class Revenue

java.lang.Object

io.rakam.api.Revenue

public class Revenue
extends Object

Revenue

Revenue objects are a wrapper for revenue events and revenue properties. This should be used in conjunction with RakamClient.logRevenueV2() to record in-app transactions. Each set method returns the same Revenue object, allowing you to chain multiple set calls together, for example: Revenue revenue = new Revenue().setProductId("com.product.id").setPrice(3.99);

Note: productId and price are required fields. If quantity is not specified, it will default to 1. receipt and receiptSignature are required if you want to verify the revenue event.

Note: the total revenue amount is calculated as price * quantity.

After creating a Revenue object and setting the desired transaction properties, send it to Rakam servers by calling Rakam.getInstance().logRevenueV2(revenue); and pass in the object.

See Also:

Android SDK README for more information on logging revenue.

Field Summary

Fields

Modifier and Type	Field and Description
protected Double	price The Price field (required).
protected String	productId The Product ID field.
protected org.json.JSONObject	properties The Revenue Event Properties field (optional).
protected int	quantity The Quantity field (defaults to 1).
protected String	receipt The Receipt field (required if you want to verify the revenue event).
protected String	receiptSig The Receipt Signature field (required if you want to verify the revenue event).
protected String	revenueType The Revenue Type field (optional).
static String	TAG The class identifier tag used in logging.

Constructor Summary

Constructors

Constructor and Description
Revenue()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Custom equals function to compare 2 revenue objects.
int	hashCode() Custom hashcode generator function for Revenue object.
protected boolean	isValidRevenue() Verifies that revenue object is valid and contains the required fields
Revenue	setEventProperties(org.json.JSONObject eventProperties) Set event properties for the revenue event, like you would for an event during logEvent.
Revenue	setPrice(double price) Set a value for the price.
Revenue	setProductId(String productId) Set a value for the product identifier.
Revenue	setQuantity(int quantity) Set a value for the quantity.
Revenue	setReceipt(String receipt, String receiptSignature) Set the receipt and receipt signature.
Revenue	setRevenueType(String revenueType) Set a value for the revenue type.
protected org.json.JSONObject	toJSONObject() Converts Revenue object into a JSONObject to send to Rakam servers

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final String TAG

The class identifier tag used in logging. TAG = "io.rakam.api.Revenue"

See Also:

Constant Field Values

productId

protected String productId

The Product ID field.

quantity

protected int quantity

The Quantity field (defaults to 1).

price

protected Double price

The Price field (required).

revenueType

protected String revenueType

The Revenue Type field (optional).

receipt

protected String receipt

The Receipt field (required if you want to verify the revenue event).

receiptSig

protected String receiptSig

The Receipt Signature field (required if you want to verify the revenue event).

properties

protected org.json.JSONObject properties

The Revenue Event Properties field (optional).

Constructor Detail

Revenue

public Revenue()

Method Detail

isValidRevenue

protected boolean isValidRevenue()

Verifies that revenue object is valid and contains the required fields

Returns:

true if revenue object is valid, else false

setProductId

public Revenue setProductId(String productId)

Set a value for the product identifier. Empty and invalid strings are ignored.

Parameters:

productId - the product id

Returns:

the same Revenue object

setQuantity

public Revenue setQuantity(int quantity)

Set a value for the quantity. Note: revenue amount is calculated as price * quantity.

Parameters:

quantity - the quantity

Returns:

the same Revenue object

setPrice

public Revenue setPrice(double price)

Set a value for the price. Note: revenue amount is calculated as price * quantity.

Parameters:

price - the price

Returns:

the same Revenue object

setRevenueType

public Revenue setRevenueType(String revenueType)

Set a value for the revenue type.

Parameters:

revenueType - the revenue type

Returns:

the same Revenue object

setReceipt

public Revenue setReceipt(String receipt,
                          String receiptSignature)

Set the receipt and receipt signature. Both fields are required to verify the revenue event.

Parameters:

receipt - the receipt

receiptSignature - the receipt signature

Returns:

the same Revenue object

setEventProperties

public Revenue setEventProperties(org.json.JSONObject eventProperties)

Set event properties for the revenue event, like you would for an event during logEvent.

Parameters:

eventProperties - the event properties

Returns:

the same Revenue object

See Also:

Event Properties for more information about logging event properties.

toJSONObject

protected org.json.JSONObject toJSONObject()

Converts Revenue object into a JSONObject to send to Rakam servers

Returns:

the JSON representation of this Revenue object

equals

public boolean equals(Object o)

Custom equals function to compare 2 revenue objects. 2 Revenue objects are equal if all of their fields are equal. Generated by Android Studio

Overrides:

equals in class Object

Parameters:

o - the other object to compare to

Returns:

true if the two Revenue objects are equal, false otherwise

hashCode

public int hashCode()

Custom hashcode generator function for Revenue object. Generated by Android Studio.

Overrides:

hashCode in class Object

Returns:

the hashcode for this Revenue instance~