| Package | com.myflashlab.air.extensions.firebase.analytics |
| Class | public class AnalyticsParam |
| Inheritance | AnalyticsParam Object |
| Method | Defined By | ||
|---|---|---|---|
Initialize a new instance from this class and add parameters with Key/Value pairs. | AnalyticsParam | ||
addNumber($key:String, $value:Number):void
Use this method to add a parameter with a Numeric type value. | AnalyticsParam | ||
addString($key:String, $value:String):void
Use this method to add a parameter with a String type value. | AnalyticsParam | ||
clean():void | AnalyticsParam | ||
| Constant | Defined By | ||
|---|---|---|---|
| ACHIEVEMENT_ID : String = achievement_id [static] Game achievement ID (String). | AnalyticsParam | ||
| ACLID : String = aclid [static]
CAMPAIGN_DETAILS click ID. | AnalyticsParam | ||
| AFFILIATION : String = affiliation [static]
The store or affiliation from which this transaction occurred. | AnalyticsParam | ||
| ALLOW_PERSONALIZED_ADS : String = allow_personalized_ads [static]
Indicates whether events logged by Google Analytics can be used to personalize ads for the user. | AnalyticsParam | ||
| CAMPAIGN : String = campaign [static]
CAMPAIGN_DETAILS name; used for keyword analysis to identify a specific product promotion or
strategic campaign. | AnalyticsParam | ||
| CHARACTER : String = character [static] Character used in game (String). | AnalyticsParam | ||
| CHECKOUT_OPTION : String = checkout_option [static]
Some option on a step in an ecommerce flow. | AnalyticsParam | ||
| CHECKOUT_STEP : String = checkout_step [static]
The checkout step (1..N). | AnalyticsParam | ||
| CONTENT : String = content [static]
CAMPAIGN_DETAILS content; used for A/B testing and content-targeted ads to differentiate ads
or links that point to the same URL. | AnalyticsParam | ||
| CONTENT_TYPE : String = content_type [static] Type of content selected (String). | AnalyticsParam | ||
| COUPON : String = coupon [static] Coupon code for a purchasable item (String). | AnalyticsParam | ||
| CP1 : String = cp1 [static]
CAMPAIGN_DETAILS custom parameter. | AnalyticsParam | ||
| CREATIVE_NAME : String = creative_name [static]
The name of a creative used in a promotional spot. | AnalyticsParam | ||
| CREATIVE_SLOT : String = creative_slot [static]
The name of a creative slot. | AnalyticsParam | ||
| CURRENCY : String = currency [static] Purchase currency in 3 letter ISO_4217 (http://en.wikipedia.org/wiki/ISO_4217#Active_codes) format (String). | AnalyticsParam | ||
| DESTINATION : String = destination [static] Flight or Travel destination (String). | AnalyticsParam | ||
| END_DATE : String = end_date [static] The arrival date, check-out date, or rental end date for the item (String). | AnalyticsParam | ||
| FLIGHT_NUMBER : String = flight_number [static] Flight number for travel events (String). | AnalyticsParam | ||
| GROUP_ID : String = group_id [static] Group/clan/guild id (String). | AnalyticsParam | ||
| INDEX : String = index [static]
The index of an item in a list. | AnalyticsParam | ||
| ITEM_BRAND : String = item_brand [static]
Item brand. | AnalyticsParam | ||
| ITEM_CATEGORY : String = item_category [static] Item category (String). | AnalyticsParam | ||
| ITEM_ID : String = item_id [static] Item ID (String). | AnalyticsParam | ||
| ITEM_LIST : String = item_list [static]
The list in which the item was presented to the user. | AnalyticsParam | ||
| ITEM_LOCATION_ID : String = item_location_id [static] The Google Place ID (https://developers.google.com/places/place-id) that corresponds to the associated item (String). | AnalyticsParam | ||
| ITEM_NAME : String = item_name [static] Item name (String). | AnalyticsParam | ||
| ITEM_VARIANT : String = item_variant [static]
Item variant. | AnalyticsParam | ||
| LEVEL : String = level [static] Level in game (Number). | AnalyticsParam | ||
| LEVEL_NAME : String = level_name [static] The name of a level in a game (String). | AnalyticsParam | ||
| LOCATION : String = location [static] Location (String). | AnalyticsParam | ||
| MEDIUM : String = medium [static]
CAMPAIGN_DETAILS medium; used to identify a medium such as email or cost-per-click (cpc). | AnalyticsParam | ||
| METHOD : String = method [static]
A particular approach used in an operation; for example, "facebook" or "email" in the context of a
sign_up or login event. | AnalyticsParam | ||
| NUMBER_OF_NIGHTS : String = number_of_nights [static] Number of nights staying at hotel (Number). | AnalyticsParam | ||
| NUMBER_OF_PASSENGERS : String = number_of_passengers [static] Number of passengers traveling (Number). | AnalyticsParam | ||
| NUMBER_OF_ROOMS : String = number_of_rooms [static] Number of rooms for travel events (Number). | AnalyticsParam | ||
| ORIGIN : String = origin [static] Flight or Travel origin (String). | AnalyticsParam | ||
| PRICE : String = price [static] Purchase price (Number). | AnalyticsParam | ||
| QUANTITY : String = quantity [static] Purchase quantity (Number). | AnalyticsParam | ||
| SCORE : String = score [static] Score in game (Number). | AnalyticsParam | ||
| SEARCH_TERM : String = search_term [static] The search string/keywords used (String). | AnalyticsParam | ||
| SHIPPING : String = shipping [static] Shipping cost (Number). | AnalyticsParam | ||
| SOURCE : String = source [static]
CAMPAIGN_DETAILS source; used to identify a search engine, newsletter, or other source. | AnalyticsParam | ||
| START_DATE : String = start_date [static] The departure date, check-in date, or rental start date for the item (String). | AnalyticsParam | ||
| SUCCESS : String = success [static]
The result of an operation (Number). | AnalyticsParam | ||
| TAX : String = tax [static] Tax amount (Number). | AnalyticsParam | ||
| TERM : String = term [static]
CAMPAIGN_DETAILS term; used with paid search to supply the keywords for ads. | AnalyticsParam | ||
| TRANSACTION_ID : String = transaction_id [static] A single ID for a ecommerce group transaction (String). | AnalyticsParam | ||
| TRAVEL_CLASS : String = travel_class [static] Travel class (String). | AnalyticsParam | ||
| VALUE : String = value [static]
A context-specific numeric value which is accumulated automatically for each event type. | AnalyticsParam | ||
| VIRTUAL_CURRENCY_NAME : String = virtual_currency_name [static] Name of virtual currency type (String). | AnalyticsParam | ||
| AnalyticsParam | () | Constructor |
public function AnalyticsParam()Initialize a new instance from this class and add parameters with Key/Value pairs.
| addNumber | () | method |
public function addNumber($key:String, $value:Number):void
Use this method to add a parameter with a Numeric type value. Numeric parameters are used for the following keys (ONLY):
NOTICE: THIS FEATURE IS ONLY AVAILABLE TO MYFLASHLABS CLUB MEMBERS: You can add Numeric type values too but if you're not a club member, you can only add String values. By Joining the club, you are supporting the MyFlashLabs Team to be able to do their job with more ease.
Parameters
$key:String | |
$value:Number |
| addString | () | method |
public function addString($key:String, $value:String):voidUse this method to add a parameter with a String type value. String parameters are used for the following keys: (Or any custom key that you may add yourself.)
Parameters
$key:String | |
$value:String |
| clean | () | method |
public function clean():void| ACHIEVEMENT_ID | Constant |
public static const ACHIEVEMENT_ID:String = achievement_idGame achievement ID (String). The parameter expects a string value
| ACLID | Constant |
public static const ACLID:String = aclid
CAMPAIGN_DETAILS click ID.
| AFFILIATION | Constant |
public static const AFFILIATION:String = affiliationThe store or affiliation from which this transaction occurred.
| ALLOW_PERSONALIZED_ADS | Constant |
public static const ALLOW_PERSONALIZED_ADS:String = allow_personalized_ads
Indicates whether events logged by Google Analytics can be used to personalize ads for the user. Default is enabled.
Android: Set to "true" to enable, or "false" to disable.
FirebaseAnalytics.setUserProperty(AnalyticsParam.ALLOW_PERSONALIZED_ADS, "true");
iOS: Set to "YES" to enable, or "NO" to disable.
| CAMPAIGN | Constant |
public static const CAMPAIGN:String = campaign
CAMPAIGN_DETAILS name; used for keyword analysis to identify a specific product promotion or
strategic campaign.
| CHARACTER | Constant |
public static const CHARACTER:String = characterCharacter used in game (String). The parameter expects a string value
| CHECKOUT_OPTION | Constant |
public static const CHECKOUT_OPTION:String = checkout_optionSome option on a step in an ecommerce flow.
| CHECKOUT_STEP | Constant |
public static const CHECKOUT_STEP:String = checkout_stepThe checkout step (1..N).
| CONTENT | Constant |
public static const CONTENT:String = content
CAMPAIGN_DETAILS content; used for A/B testing and content-targeted ads to differentiate ads
or links that point to the same URL.
| CONTENT_TYPE | Constant |
public static const CONTENT_TYPE:String = content_typeType of content selected (String). The parameter expects a string value
| COUPON | Constant |
public static const COUPON:String = couponCoupon code for a purchasable item (String). The parameter expects a string value
| CP1 | Constant |
public static const CP1:String = cp1
CAMPAIGN_DETAILS custom parameter.
| CREATIVE_NAME | Constant |
public static const CREATIVE_NAME:String = creative_nameThe name of a creative used in a promotional spot.
| CREATIVE_SLOT | Constant |
public static const CREATIVE_SLOT:String = creative_slotThe name of a creative slot.
| CURRENCY | Constant |
public static const CURRENCY:String = currencyPurchase currency in 3 letter ISO_4217 (http://en.wikipedia.org/wiki/ISO_4217#Active_codes) format (String).
| DESTINATION | Constant |
public static const DESTINATION:String = destinationFlight or Travel destination (String).
| END_DATE | Constant |
public static const END_DATE:String = end_dateThe arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD
| FLIGHT_NUMBER | Constant |
public static const FLIGHT_NUMBER:String = flight_numberFlight number for travel events (String). The parameter expects a string value
| GROUP_ID | Constant |
public static const GROUP_ID:String = group_idGroup/clan/guild id (String). The parameter expects a string value
| INDEX | Constant |
public static const INDEX:String = indexThe index of an item in a list.
| ITEM_BRAND | Constant |
public static const ITEM_BRAND:String = item_brandItem brand.
| ITEM_CATEGORY | Constant |
public static const ITEM_CATEGORY:String = item_categoryItem category (String). The parameter expects a string value
| ITEM_ID | Constant |
public static const ITEM_ID:String = item_idItem ID (String). The parameter expects a string value
| ITEM_LIST | Constant |
public static const ITEM_LIST:String = item_listThe list in which the item was presented to the user.
| ITEM_LOCATION_ID | Constant |
public static const ITEM_LOCATION_ID:String = item_location_idThe Google Place ID (https://developers.google.com/places/place-id) that corresponds to the associated item (String). Alternatively, you can supply your own custom Location ID. The parameter expects a string value
| ITEM_NAME | Constant |
public static const ITEM_NAME:String = item_nameItem name (String). The parameter expects a string value
| ITEM_VARIANT | Constant |
public static const ITEM_VARIANT:String = item_variantItem variant.
| LEVEL | Constant |
public static const LEVEL:String = levelLevel in game (Number). The parameter expects a Number value
| LEVEL_NAME | Constant |
public static const LEVEL_NAME:String = level_nameThe name of a level in a game (String).
| LOCATION | Constant |
public static const LOCATION:String = locationLocation (String). The Google Place ID (https://developers.google.com/places/place-id) that corresponds to the associated event. Alternatively, you can supply your own custom Location ID. The parameter expects a string value
| MEDIUM | Constant |
public static const MEDIUM:String = medium
CAMPAIGN_DETAILS medium; used to identify a medium such as email or cost-per-click (cpc).
| METHOD | Constant |
public static const METHOD:String = methodA particular approach used in an operation; for example, "facebook" or "email" in the context of a sign_up or login event. The parameter expects a string value.
| NUMBER_OF_NIGHTS | Constant |
public static const NUMBER_OF_NIGHTS:String = number_of_nightsNumber of nights staying at hotel (Number). The parameter expects a Number value
| NUMBER_OF_PASSENGERS | Constant |
public static const NUMBER_OF_PASSENGERS:String = number_of_passengersNumber of passengers traveling (Number). The parameter expects a Number value
| NUMBER_OF_ROOMS | Constant |
public static const NUMBER_OF_ROOMS:String = number_of_roomsNumber of rooms for travel events (Number). The parameter expects a Number value
| ORIGIN | Constant |
public static const ORIGIN:String = originFlight or Travel origin (String). The parameter expects a string value
| PRICE | Constant |
public static const PRICE:String = pricePurchase price (Number). Expecting a Number value set
| QUANTITY | Constant |
public static const QUANTITY:String = quantityPurchase quantity (Number). The parameter expects a Number value
| SCORE | Constant |
public static const SCORE:String = scoreScore in game (Number). The parameter expects a Number value
| SEARCH_TERM | Constant |
public static const SEARCH_TERM:String = search_termThe search string/keywords used (String). The parameter expects a string value
| SHIPPING | Constant |
public static const SHIPPING:String = shippingShipping cost (Number). Expecting a Number value
| SOURCE | Constant |
public static const SOURCE:String = source
CAMPAIGN_DETAILS source; used to identify a search engine, newsletter, or other source.
| START_DATE | Constant |
public static const START_DATE:String = start_dateThe departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD
| SUCCESS | Constant |
public static const SUCCESS:String = successThe result of an operation (Number). Specify 1 to indicate success and 0 to indicate failure.
| TAX | Constant |
public static const TAX:String = taxTax amount (Number). Expecting a Number value
| TERM | Constant |
public static const TERM:String = term
CAMPAIGN_DETAILS term; used with paid search to supply the keywords for ads.
| TRANSACTION_ID | Constant |
public static const TRANSACTION_ID:String = transaction_idA single ID for a ecommerce group transaction (String). The parameter expects a string value
| TRAVEL_CLASS | Constant |
public static const TRAVEL_CLASS:String = travel_classTravel class (String). The parameter expects a string value
| VALUE | Constant |
public static const VALUE:String = valueA context-specific numeric value which is accumulated automatically for each event type. Value should be specified with Number. This is a general purpose parameter that is useful for accumulating a key metric that pertains to an event. Examples include revenue, distance, time, and points. Notes: Currency-related values should be supplied using type double and should be accompanied by a CURRENCY param. The valid range of accumulated values is [-9,223,372,036,854.77, 9,223,372,036,854.77].
| VIRTUAL_CURRENCY_NAME | Constant |
public static const VIRTUAL_CURRENCY_NAME:String = virtual_currency_nameName of virtual currency type (String). The parameter expects a string value