MonetizationEventBuilder (AWS SDK for Android

java.lang.Object
- com.amazonaws.mobileconnectors.pinpoint.analytics.monetization.MonetizationEventBuilder

Direct Known Subclasses:

AmazonMonetizationEventBuilder, CustomMonetizationEventBuilder, GooglePlayMonetizationEventBuilder, VirtualMonetizationEventBuilder
```
public abstract class MonetizationEventBuilder
extends Object
```
Base class for handling the required attributes and metrics for monetization Events. Currently, AmazonMonetizationEventBuilder is used to create monetization events for Amazon purchases, GooglePlayMonetizationEventBuilder is used to create monetization events for Google Play purchases and VirtualMonetizationEventBuilder is used to create monetization events for virtual In-Game Store purchases. This class can be extended if you need to record monetization events from other purchase frameworks. Derived classes must override the isValid method so that MonetizationEventBuilder knows if the derived builder is in a valid state. Derived builders should then call the appropriate setters on this class to build a monetization event appropriate for their framework. When creating derived classes, the following setters must be called on this class or else the builder will return null
- The ProductId must be set
- The Quantity must be set
- The Store must be set
- Either the (Currency and ItemPrice) or the ForrmattedItemPrice must be set

Constructor Summary

Constructors
Modifier Constructor and Description

protected MonetizationEventBuilder(AnalyticsClient analyticsClient)
Creates a MonetizationEventBuilder with the specified EventClient

Constructors
Modifier	Constructor and Description
`protected`	`MonetizationEventBuilder(AnalyticsClient analyticsClient)` Creates a MonetizationEventBuilder with the specified EventClient

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AnalyticsEvent`	`build()` Builds a monetization event.
`protected String`	`getCurrency()` Accessor for the currency
`protected String`	`getFormattedItemPrice()` Deprecated. Will be removed. Please set Currency and Item Price
`protected Double`	`getItemPrice()` Accessor for the item price
`protected String`	`getProductId()` Accessor for the product identifier
`protected Double`	`getQuantity()` Accessor for the quantity
`protected String`	`getStore()` Accessor for the store
`protected String`	`getTransactionId()` Accessor for the transaction identifier
`protected abstract boolean`	`isValid()` Determines if all builder methods on this builder have been called
`protected void`	`setCurrency(String currency)` Sets the item price currency to use when building the monetization event
`protected void`	`setFormattedItemPrice(String formattedItemPrice)` Deprecated. Will be removed. Please set Currency and Item Price
`protected void`	`setItemPrice(Double itemPrice)` Sets the numerical item price to use when building the monetization event
`protected void`	`setProductId(String productId)` Sets the product id to use when building the monetization event
`protected void`	`setQuantity(Double quantity)` Sets the quantity that will be used to build the monetization event
`protected void`	`setStore(String store)` Sets the name of the Store where this purchase was made.
`protected void`	`setTransactionId(String transactionId)` Sets the transaction id to use when building the monetization event

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MonetizationEventBuilder
```
protected MonetizationEventBuilder(AnalyticsClient analyticsClient)
```
    Creates a MonetizationEventBuilder with the specified EventClient
    
    Parameters:
    
    analyticsClient - The EventClient to use when building events
- Method Detail
  - build
```
public AnalyticsEvent build()
```
    Builds a monetization event.
    
    Returns:
    
    A monetization event that can be recorded. If the builder is in an invalid state, this method returns null.
  - isValid
```
protected abstract boolean isValid()
```
    Determines if all builder methods on this builder have been called
    
    Returns:
    
    true if this builder can create a Monetization event, false otherwise
  - getProductId
```
protected String getProductId()
```
    Accessor for the product identifier
    
    Returns:
    
    The product identifier that will be used to build the monetization event
  - setProductId
```
protected void setProductId(String productId)
```
    Sets the product id to use when building the monetization event
    
    Parameters:
    
    productId - The product id of the item being purchased
  - getQuantity
```
protected Double getQuantity()
```
    Accessor for the quantity
    
    Returns:
    
    The quantity that will be used to build the monetization event
  - setQuantity
```
protected void setQuantity(Double quantity)
```
    Sets the quantity that will be used to build the monetization event
    
    Parameters:
    
    quantity - The quantity of items purchased
  - getItemPrice
```
protected Double getItemPrice()
```
    Accessor for the item price
    
    Returns:
    
    The numerical item price that will be used to build the monetization event
  - setItemPrice
```
protected void setItemPrice(Double itemPrice)
```
    Sets the numerical item price to use when building the monetization event
    
    Parameters:
    
    itemPrice - the price of the item being purchased
  - getFormattedItemPrice
```
@Deprecated
protected String getFormattedItemPrice()
```
    Deprecated. Will be removed. Please set Currency and Item Price
    
    Accessor for the formatted item price
    
    Returns:
    
    The formatted item price that will be used to build the monetization event. Price should be formatted for the locale and currency representing the transaction.
  - setFormattedItemPrice
```
@Deprecated
protected void setFormattedItemPrice(String formattedItemPrice)
```
    Deprecated. Will be removed. Please set Currency and Item Price
    
    Sets the formatted item price (in its local currency) to use when building the monetization event
    
    Parameters:
    
    formattedItemPrice - the formatted item price in its local currency
  - getCurrency
```
protected String getCurrency()
```
    Accessor for the currency
    
    Returns:
    
    The currency that will be used to build the monetization event
  - setCurrency
```
protected void setCurrency(String currency)
```
    Sets the item price currency to use when building the monetization event
    
    Parameters:
    
    currency - the ISO currency code or virtual curreny name of the item price
  - getStore
```
protected String getStore()
```
    Accessor for the store
    
    Returns:
    
    The store that will be used to build the monetization event
  - setStore
```
protected void setStore(String store)
```
    Sets the name of the Store where this purchase was made. For example "Google Play" for purchases originating from Google Play, "Amazon" for purchases originating from Amazon, or "Virtual" if the purchase was performed in your in-game store.
    
    Parameters:
    
    store - The store of the purchase
  - getTransactionId
```
protected String getTransactionId()
```
    Accessor for the transaction identifier
    
    Returns:
    
    The transaction identifier that will be used to build the monetization event
  - setTransactionId
```
protected void setTransactionId(String transactionId)
```
    Sets the transaction id to use when building the monetization event
    
    Parameters:
    
    transactionId - the transaction id of the purchase

Class MonetizationEventBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MonetizationEventBuilder

Method Detail

build

isValid

getProductId

setProductId

getQuantity

setQuantity

getItemPrice

setItemPrice

getFormattedItemPrice

setFormattedItemPrice

getCurrency

setCurrency

getStore

setStore

getTransactionId

setTransactionId