com.amazonaws.mobileconnectors.pinpoint.analytics.monetization

Class GooglePlayMonetizationEventBuilder

java.lang.Object

com.amazonaws.mobileconnectors.pinpoint.analytics.monetization.MonetizationEventBuilder

com.amazonaws.mobileconnectors.pinpoint.analytics.monetization.GooglePlayMonetizationEventBuilder

public class GooglePlayMonetizationEventBuilder
extends MonetizationEventBuilder

Builds monetization events representing a Google Play purchase. This Builder automatically sets the store attribute to "Google Play". This Builder will return null if the ProductId, Currency, Item Price, Quantity, or TransactionId are not set. The example below demonstrates how to create a monetization event after you receive the purchase org.json.JSONObject on the completion of a purchase using Google's In App Billing API. Since Google does not give you any product information in the purchase object, you must have a way to access your store inventory when the purchase is being finalized. In the example below, we use a org.json.JSONObject that was returned by a request to Google's In App Billing API for product skus. Example: // create a builder that can record purchase events for Google Play IAP GooglePlayMonetizationEventBuilder builder = GooglePlayMonetizationEventBuilder.create(pinpointManager.getAnalyticsClient()); // build the monetization event with the product id, formatted item price, // transaction id, and quantity // product id and formatted item price can be obtained from the JSONObject // returned by a product sku request to Google's In App Billing API // transaction id is obtained from the Purchase object that is returned upon the // completion of a purchase // Google IAP currently only supports a quantity of 1 Analytics Event purchaseEvent = builder.withProductId(sku).withFormattedItemPrice(price) .withTransactionId(purchase.getOrderId()).withQuantity(1).build(); // record the monetization event pinpointManager.getAnalyticsClient().recordEvent(purchaseEvent);

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GooglePlayMonetizationEventBuilder(AnalyticsClient analyticsClient) Construct a GooglePlayMonetizationEventBuilder with the specified EventClient

Method Summary

Modifier and Type	Method and Description
static GooglePlayMonetizationEventBuilder	create(AnalyticsClient analyticsClient) Create a GooglePlayMonetizationEventBuilder with the specified Event client
protected boolean	isValid() Returns true only if the ProductId, Quantity, Currency, Item Price, and Transaction Id are set
GooglePlayMonetizationEventBuilder	withCurrency(String currency) Sets the currency of the item purchased.
GooglePlayMonetizationEventBuilder	withFormattedItemPrice(String formattedItemPrice) Deprecated. Will be removed. Please set Currency and Item Price. Replaced by withCurrency(String) and {@link #withItemPrice(Double)
GooglePlayMonetizationEventBuilder	withItemPrice(Double itemPrice) Sets the item price of the item purchased.
GooglePlayMonetizationEventBuilder	withProductId(String productId) Sets the product identifier field of the item being purchased.
GooglePlayMonetizationEventBuilder	withQuantity(Double quantity) Sets the quantity of the item purchased.
GooglePlayMonetizationEventBuilder	withTransactionId(String transactionId) The transaction identifier of the purchase.

Methods inherited from class com.amazonaws.mobileconnectors.pinpoint.analytics.monetization.MonetizationEventBuilder

build, getCurrency, getFormattedItemPrice, getItemPrice, getProductId, getQuantity, getStore, getTransactionId, setCurrency, setFormattedItemPrice, setItemPrice, setProductId, setQuantity, setStore, setTransactionId

Methods inherited from class java.lang.Object

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

Constructor Detail

GooglePlayMonetizationEventBuilder

protected GooglePlayMonetizationEventBuilder(AnalyticsClient analyticsClient)

Construct a GooglePlayMonetizationEventBuilder with the specified EventClient

Parameters:

analyticsClient - The EventClient to use when building the event

Method Detail

create

public static GooglePlayMonetizationEventBuilder create(AnalyticsClient analyticsClient)

Create a GooglePlayMonetizationEventBuilder with the specified Event client

Parameters:

analyticsClient - The event client to use when creating monetization events

Returns:

a GooglePlayMonetizationEventBuilder to build monetization events from the Google Play IAB API

withProductId

public GooglePlayMonetizationEventBuilder withProductId(String productId)

Sets the product identifier field of the item being purchased.

Parameters:

productId - The product id representing the item being purchased

Returns:

this for chaining

withFormattedItemPrice

@Deprecated
public GooglePlayMonetizationEventBuilder withFormattedItemPrice(String formattedItemPrice)

Deprecated. Will be removed. Please set Currency and Item Price. Replaced by withCurrency(String) and {@link #withItemPrice(Double)

Sets the formatted localized item price of the item being purchased (accessed from the product item details price field after calling getSkuDetails()).

Parameters:

formattedItemPrice - The localized formatted price of the item

Returns:

this for chaining

withQuantity

public GooglePlayMonetizationEventBuilder withQuantity(Double quantity)

Sets the quantity of the item purchased.

Parameters:

quantity - Currently, Google Play only supports purchasing 1 item at a time.

Returns:

this for chaining

withItemPrice

public GooglePlayMonetizationEventBuilder withItemPrice(Double itemPrice)

Sets the item price of the item purchased.

Parameters:

itemPrice - The numerical price of the item

Returns:

this for chaining

withCurrency

public GooglePlayMonetizationEventBuilder withCurrency(String currency)

Sets the currency of the item purchased.

Parameters:

currency - The currency code of the currency used to purchase this item (i.e. "USD" or "$")

Returns:

this for chaining

withTransactionId

public GooglePlayMonetizationEventBuilder withTransactionId(String transactionId)

The transaction identifier of the purchase.

Parameters:

transactionId - The orderId found in the INAPP_PURCHASE_DATA of a purchase request

Returns:

this for chaining

isValid

protected boolean isValid()

Returns true only if the ProductId, Quantity, Currency, Item Price, and Transaction Id are set

Specified by:

isValid in class MonetizationEventBuilder

Returns:

true if this builder can create a Monetization event, false otherwise