com.amazonaws.mobileconnectors.amazonmobileanalytics.monetization.AmazonMonetizationEventBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aws-android-sdk-mobileanalytics Show documentation
Amazon Web Services SDK for Android
There is a newer version: 2.20.1
Show newest version
/*
 * Copyright 2010-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package com.amazonaws.mobileconnectors.amazonmobileanalytics.monetization;

import android.util.Log;

import com.amazonaws.mobileconnectors.amazonmobileanalytics.EventClient;

/**
 * Builds monetization events representing an Amazon purchase. This Builder
 * automatically sets the store attribute to "Amazon". This Builder will return
 * null if the ProductId, Formatted Localized Price, or Quantity are not set.
 *  Example:
 *
 *  * // get the event client from your MobileAnalyticsManager instance
 * EventClient eventClient = mobileAnalyticsManager.getEventClient();
 *
 * // create a builder that can record purchase events for Amazon IAP
 * AmazonMonetizationEventBuilder builder = AmazonMonetizationEventBuilder.create(eventClient);
 *
 * // build the monetization event with the product id, formatted item price, and
 * // quantity
 * // product id and formatted item price are obtained from the Item object
 * // Amazon IAP currently only supports a quantity of 1
 * Event purchaseEvent = builder.withProductId(purchasedItem.getSku())
 *         .withFormattedItemPrice(purchasedItem.getPrice()).withQuantity(1).build();
 *
 * // record the monetization event
 * eventClient.recordEvent(purchaseEvent);
 * 
 */
public class AmazonMonetizationEventBuilder extends MonetizationEventBuilder {

    private static final String TAG = "AmazonMonetizationEventBuilder";

    /**
     * Create a AmazonMonetizationEventBuilder with the specified Event client
     *
     * @param eventClient The event client to use when creating monetization
     *            events
     * @return a AmazonMonetizationEventBuilder to build monetization events
     *         from the Amazon IAP API
     */
    public static AmazonMonetizationEventBuilder create(EventClient eventClient) {
        return new AmazonMonetizationEventBuilder(eventClient);
    }

    /**
     * Sets the product identifier field of the item being purchased
     *
     * @param productId The product id representing the item being purchased
     * @return this for chaining
     */
    public AmazonMonetizationEventBuilder withProductId(String productId) {
        setProductId(productId);
        return this;
    }

    /**
     * Sets the formatted localized price of the item being purchased (accessed
     * from the getPrice() method of the Item class).
     *
     * @param formattedItemPrice The localized formatted price of the item
     * @return this for chaining
     */
    public AmazonMonetizationEventBuilder withFormattedItemPrice(String formattedItemPrice) {
        setFormattedItemPrice(formattedItemPrice);
        return this;
    }

    /**
     * Sets the quantity of the item being purchased.
     *
     * @param quantity Currently, Amazon IAP only supports purchasing 1 item at
     *            a time.
     * @return this for chaining
     */
    public AmazonMonetizationEventBuilder withQuantity(Double quantity) {
        setQuantity(quantity);
        return this;
    }

    /**
     * Construct a AmazonMonetizationEventBuilder with the specified EventClient
     *
     * @param eventClient The EventClient to use when building the event
     */
    protected AmazonMonetizationEventBuilder(EventClient eventClient) {
        super(eventClient);
        setStore(AMAZON_STORE);
    }

    @Override
    protected boolean isValid() {
        // we must always have a product id, quantity, and store
        if (getProductId() == null) {
            Log.w(TAG, "Amazon Monetization event is not valid: it is missing the product id");
            return false;
        }

        if (getQuantity() == null) {
            Log.w(TAG, "Amazon Monetization event is not valid: it is missing the quantity");
            return false;
        }

        if (getFormattedItemPrice() == null) {
            Log.w(TAG,
                    "Amazon Monetization event is not valid: it is missing the formatted localized price");
            return false;
        }

        return true;
    }
}