mk.gdx.firebase.analytics.AnalyticsEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gdx-fireapp-core Show documentation
Firebase SDK API for LibGDX projects.
There is a newer version: 3.3.1
/*
 * Copyright 2017 mk
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 mk.gdx.firebase.analytics;

/**
 * Firebase analytics events list.
 * 
 *
 * @see andoird docs
 * @see ios docs
 */
public class AnalyticsEvent {

    private AnalyticsEvent() {
        //
    }

    /**
     * Firebase analytics event: {@value}
     * 

     * Params for this {@code AnalyticsEvent} are undefined.
     */
    public static final String ADD_PAYMENT_INFO = "add_payment_info";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#ITEM_ID},
     * 
{@link AnalyticsParam#ITEM_NAME},
     * 
{@link AnalyticsParam#ITEM_CATEGORY},
     * 
{@link AnalyticsParam#QUANTITY},
     * 
{@link AnalyticsParam#PRICE},
     * 
{@link AnalyticsParam#CURRENCY},
     * 
{@link AnalyticsParam#ORIGIN},
     * 
{@link AnalyticsParam#ITEM_LOCATION_ID},
     * 
{@link AnalyticsParam#DESTINATION},
     * 
{@link AnalyticsParam#START_DATE},
     * 
{@link AnalyticsParam#END_DATE}
     * 

     */
    public static final String ADD_TO_CART = "add_to_cart";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#ITEM_ID},
     * 
{@link AnalyticsParam#ITEM_NAME},
     * 
{@link AnalyticsParam#ITEM_CATEGORY},
     * 
{@link AnalyticsParam#QUANTITY},
     * 
{@link AnalyticsParam#PRICE},
     * 
{@link AnalyticsParam#VALUE},
     * 
{@link AnalyticsParam#CURRENCY},
     * 
{@link AnalyticsParam#ITEM_LOCATION_ID}
     * 

     */
    public static final String ADD_TO_WISHLIST = "add_to_wishlist";

    /**
     * Firebase analytics event: {@value}
     * 

     * Params for this {@code AnalyticsEvent} are undefined.
     */
    public static final String APP_OPEN = "app_open";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#VALUE},
     * 
{@link AnalyticsParam#CURRENCY},
     * 
{@link AnalyticsParam#TRANSACTION_ID},
     * 
{@link AnalyticsParam#NUMBER_OF_NIGHTS},
     * 
{@link AnalyticsParam#NUMBER_OF_ROOMS},
     * 
{@link AnalyticsParam#NUMBER_OF_PASSENGERS},
     * 
{@link AnalyticsParam#ORIGIN},
     * 
{@link AnalyticsParam#DESTINATION},
     * 
{@link AnalyticsParam#START_DATE},
     * 
{@link AnalyticsParam#END_DATE},
     * 
{@link AnalyticsParam#TRAVEL_CLASS}
     * 

     */
    public static final String BEGIN_CHECKOUT = "begin_checkout";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#VIRTUAL_CURRENCY_NAME},
     * 
{@link AnalyticsParam#VALUE}
     * 

     */
    public static final String EARN_VIRTUAL_CURRENCY = "earn_virtual_currency";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#CURRENCY},
     * 
{@link AnalyticsParam#VALUE},
     * 
{@link AnalyticsParam#TRANSACTION_ID},
     * 
{@link AnalyticsParam#TAX},
     * 
{@link AnalyticsParam#SHIPPING},
     * 
{@link AnalyticsParam#COUPON},
     * 
{@link AnalyticsParam#LOCATION},
     * 
{@link AnalyticsParam#NUMBER_OF_NIGHTS},
     * 
{@link AnalyticsParam#NUMBER_OF_ROOMS},
     * 
{@link AnalyticsParam#NUMBER_OF_PASSENGERS},
     * 
{@link AnalyticsParam#ORIGIN},
     * 
{@link AnalyticsParam#DESTINATION},
     * 
{@link AnalyticsParam#START_DATE},
     * 
{@link AnalyticsParam#END_DATE},
     * 
{@link AnalyticsParam#TRAVEL_CLASS}
     * 

     */
    public static final String ECOMMERCE_PURCHASE = "ecommerce_purchase";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#CURRENCY},
     * 
{@link AnalyticsParam#VALUE}
     * 

     */
    public static final String GENERATE_LEAD = "generate_lead";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#GROUP_ID}
     * 

     */
    public static final String JOIN_GROUP = "join_group";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#LEVEL},
     * 
{@link AnalyticsParam#CHARACTER}
     * 

     */
    public static final String LEVEL_UP = "level_up";

    /**
     * Firebase analytics event: {@value}
     * 

     * Params for this {@code AnalyticsEvent} are undefined.
     */
    public static final String LOGIN = "login";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#SCORE},
     * 
{@link AnalyticsParam#LEVEL},
     * 
{@link AnalyticsParam#CHARACTER}
     * 

     */
    public static final String POST_SCORE = "post_score";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#ITEM_ID},
     * 
{@link AnalyticsParam#ITEM_NAME},
     * 
{@link AnalyticsParam#ITEM_CATEGORY},
     * 
{@link AnalyticsParam#QUANTITY},
     * 
{@link AnalyticsParam#PRICE},
     * 
{@link AnalyticsParam#VALUE},
     * 
{@link AnalyticsParam#CURRENCY},
     * 
{@link AnalyticsParam#ITEM_LOCATION_ID}
     * 

     */
    public static final String PRESENT_OFFER = "present_offer";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#CURRENCY},
     * 
{@link AnalyticsParam#VALUE},
     * 
{@link AnalyticsParam#TRANSACTION_ID}
     * 

     */
    public static final String PURCHASE_REFUND = "purchase_refund";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#SEARCH_TERM},
     * 
{@link AnalyticsParam#NUMBER_OF_NIGHTS},
     * 
{@link AnalyticsParam#NUMBER_OF_ROOMS},
     * 
{@link AnalyticsParam#NUMBER_OF_PASSENGERS},
     * 
{@link AnalyticsParam#ORIGIN},
     * 
{@link AnalyticsParam#DESTINATION},
     * 
{@link AnalyticsParam#START_DATE},
     * 
{@link AnalyticsParam#END_DATE},
     * 
{@link AnalyticsParam#TRAVEL_CLASS}
     * 

     */
    public static final String SEARCH = "search";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#CONTENT_TYPE},
     * 
{@link AnalyticsParam#ITEM_ID}
     * 

     */
    public static final String SELECT_CONTENT = "select_content";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#CONTENT_TYPE},
     * 
{@link AnalyticsParam#ITEM_ID}
     * 

     */
    public static final String SHARE = "share";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#SIGN_UP_METHOD}
     * 

     */
    public static final String SIGN_UP = "sign_up";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#ITEM_NAME},
     * 
{@link AnalyticsParam#VIRTUAL_CURRENCY_NAME},
     * 
{@link AnalyticsParam#VALUE}
     * 

     */
    public static final String SPEND_VIRTUAL_CURRENCY = "spend_virtual_currency";

    /**
     * Firebase analytics event: {@value}
     * 

     * Params for this {@code AnalyticsEvent} are undefined.
     */
    public static final String TUTORIAL_BEGIN = "tutorial_begin";

    /**
     * Firebase analytics event: {@value}
     * 

     * Params for this {@code AnalyticsEvent} are undefined.
     */
    public static final String TUTORIAL_COMPLETE = "tutorial_complete";

    /**
     * Firebase analytics event: {@value}
     * 

     * 

     * {@link AnalyticsParam#ACHIEVEMENT_ID}
     * 

     */
    public static final String UNLOCK_ACHIEVEMENT = "unlock_achievement";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#ITEM_ID},
     * 
{@link AnalyticsParam#ITEM_NAME},
     * 
{@link AnalyticsParam#ITEM_CATEGORY},
     * 
{@link AnalyticsParam#ITEM_LOCATION_ID},
     * 
{@link AnalyticsParam#PRICE},
     * 
{@link AnalyticsParam#QUANTITY},
     * 
{@link AnalyticsParam#CURRENCY},
     * 
{@link AnalyticsParam#VALUE},
     * 
{@link AnalyticsParam#FLIGHT_NUMBER},
     * 
{@link AnalyticsParam#NUMBER_OF_NIGHTS},
     * 
{@link AnalyticsParam#NUMBER_OF_ROOMS},
     * 
{@link AnalyticsParam#NUMBER_OF_PASSENGERS},
     * 
{@link AnalyticsParam#ORIGIN},
     * 
{@link AnalyticsParam#DESTINATION},
     * 
{@link AnalyticsParam#START_DATE},
     * 
{@link AnalyticsParam#END_DATE},
     * 
{@link AnalyticsParam#TRAVEL_CLASS}
     * 

     */
    public static final String VIEW_ITEM = "view_item";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#ITEM_CATEGORY}
     * 

     */
    public static final String VIEW_ITEM_LIST = "view_item_list";

    /**
     * Firebase analytics event: {@value}
     * 

     * Available params for this {@code AnalyticsEvent} are:
     * 

     * 

     * {@link AnalyticsParam#SEARCH_TERM}
     * 
     */
    public static final String VIEW_SEARCH_RESULT = "view_search_results";
}