com.amazonaws.mobileconnectors.pinpoint.analytics.monetization

Class VirtualMonetizationEventBuilder

java.lang.Object

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

com.amazonaws.mobileconnectors.pinpoint.analytics.monetization.VirtualMonetizationEventBuilder

public class VirtualMonetizationEventBuilder
extends MonetizationEventBuilder

Builds monetization events representing a purchase from a Virtual or In-Game store. This Builder automatically sets the store attribute to "Virtual". This Builder will return null if the ProductId, Price, Currency, or Quantity are not set. The example below shows how to record a monetization event for the purchase of 1 sword that costs 500 Gold. Example: // create a builder that can record purchase events for a Virtual In Game Store VirtualMonetizationEventBuilder builder = VirtualMonetizationEventBuilder.create(pinpointManager.getAnalyticsClient()); // build the monetization event with the product id, item price, currency type, // and quantity AnalyticsEvent purchaseEvent = builder.withProductId("com.yourgame.sword").withItemPrice(500) .withCurrency("Gold").withQuantity(1).build(); // record the monetization event pinpointManager.getAnalyticsClient().recordEvent(purchaseEvent);

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static VirtualMonetizationEventBuilder	create(AnalyticsClient analyticsClient) Create a VirtualMonetizationEventBuilder with the specified Event client
protected boolean	isValid() Determines if all builder methods on this builder have been called
VirtualMonetizationEventBuilder	withCurrency(String currency) Sets the currency of the item being purchased.
VirtualMonetizationEventBuilder	withItemPrice(double itemPrice) Sets the numerical price of the item being purchased
VirtualMonetizationEventBuilder	withProductId(String productId) Sets the product identifier field of the item being purchased.
VirtualMonetizationEventBuilder	withQuantity(Double quantity) Sets the quantity of the item being purchased.

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

VirtualMonetizationEventBuilder

protected VirtualMonetizationEventBuilder(AnalyticsClient analyticsClient)

Construct a VirtualMonetizationEventBuilder with the specified EventClient

Parameters:

analyticsClient - The EventClient to use when building the event

Method Detail

create

public static VirtualMonetizationEventBuilder create(AnalyticsClient analyticsClient)

Create a VirtualMonetizationEventBuilder with the specified Event client

Parameters:

analyticsClient - The event client to use when creating monetization events

Returns:

a VirtualMonetizationEventBuilder to build monetization events from a Virtual Store

withProductId

public VirtualMonetizationEventBuilder 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

withItemPrice

public VirtualMonetizationEventBuilder withItemPrice(double itemPrice)

Sets the numerical price of the item being purchased

Parameters:

itemPrice - The numerical price of the item

Returns:

this for chaining

withQuantity

public VirtualMonetizationEventBuilder withQuantity(Double quantity)

Sets the quantity of the item being purchased.

Parameters:

quantity - The number of items purchased in this transaction

Returns:

this for chaining

withCurrency

public VirtualMonetizationEventBuilder withCurrency(String currency)

Sets the currency of the item being purchased.

Parameters:

currency - The name of the virtual currency used to purchase this item (i.e. Coins or Gold)

Returns:

this for chaining

isValid

protected boolean isValid()

Description copied from class: MonetizationEventBuilder

Determines if all builder methods on this builder have been called

Specified by:

isValid in class MonetizationEventBuilder

Returns:

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