Packagecom.myflashlab.air.extensions.firebase.analytics
Classpublic class AnalyticsParam
InheritanceAnalyticsParam Inheritance Object

Params supply information that contextualize Events. You can associate up to 25 unique Params with each Event type. Some Params are suggested below for certain common Events, but you are not limited to these. You may supply extra Params for suggested Events or custom Params for Custom events. Param names can be up to 24 characters long, may only contain alphanumeric characters and underscores ("_"), and must start with an alphabetic character. Param values can be up to 36 characters long. The "firebase_" prefix is reserved and should not be used.



Public Methods
 MethodDefined 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
Public Constants
 ConstantDefined 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
Constructor Detail
AnalyticsParam()Constructor
public function AnalyticsParam()

Initialize a new instance from this class and add parameters with Key/Value pairs.

Method Detail
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):void

Use 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

Constant Detail
ACHIEVEMENT_IDConstant
public static const ACHIEVEMENT_ID:String = achievement_id

Game achievement ID (String). The parameter expects a string value

ACLIDConstant 
public static const ACLID:String = aclid

CAMPAIGN_DETAILS click ID.

AFFILIATIONConstant 
public static const AFFILIATION:String = affiliation

The store or affiliation from which this transaction occurred.

ALLOW_PERSONALIZED_ADSConstant 
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.

CAMPAIGNConstant 
public static const CAMPAIGN:String = campaign

CAMPAIGN_DETAILS name; used for keyword analysis to identify a specific product promotion or strategic campaign.

CHARACTERConstant 
public static const CHARACTER:String = character

Character used in game (String). The parameter expects a string value

CHECKOUT_OPTIONConstant 
public static const CHECKOUT_OPTION:String = checkout_option

Some option on a step in an ecommerce flow.

CHECKOUT_STEPConstant 
public static const CHECKOUT_STEP:String = checkout_step

The checkout step (1..N).

CONTENTConstant 
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_TYPEConstant 
public static const CONTENT_TYPE:String = content_type

Type of content selected (String). The parameter expects a string value

COUPONConstant 
public static const COUPON:String = coupon

Coupon code for a purchasable item (String). The parameter expects a string value

CP1Constant 
public static const CP1:String = cp1

CAMPAIGN_DETAILS custom parameter.

CREATIVE_NAMEConstant 
public static const CREATIVE_NAME:String = creative_name

The name of a creative used in a promotional spot.

CREATIVE_SLOTConstant 
public static const CREATIVE_SLOT:String = creative_slot

The name of a creative slot.

CURRENCYConstant 
public static const CURRENCY:String = currency

Purchase currency in 3 letter ISO_4217 (http://en.wikipedia.org/wiki/ISO_4217#Active_codes) format (String).

DESTINATIONConstant 
public static const DESTINATION:String = destination

Flight or Travel destination (String).

END_DATEConstant 
public static const END_DATE:String = end_date

The arrival date, check-out date, or rental end date for the item (String). The parameter expects a date formatted as YYYY-MM-DD

FLIGHT_NUMBERConstant 
public static const FLIGHT_NUMBER:String = flight_number

Flight number for travel events (String). The parameter expects a string value

GROUP_IDConstant 
public static const GROUP_ID:String = group_id

Group/clan/guild id (String). The parameter expects a string value

INDEXConstant 
public static const INDEX:String = index

The index of an item in a list.

ITEM_BRANDConstant 
public static const ITEM_BRAND:String = item_brand

Item brand.

ITEM_CATEGORYConstant 
public static const ITEM_CATEGORY:String = item_category

Item category (String). The parameter expects a string value

ITEM_IDConstant 
public static const ITEM_ID:String = item_id

Item ID (String). The parameter expects a string value

ITEM_LISTConstant 
public static const ITEM_LIST:String = item_list

The list in which the item was presented to the user.

ITEM_LOCATION_IDConstant 
public static const ITEM_LOCATION_ID:String = item_location_id

The 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_NAMEConstant 
public static const ITEM_NAME:String = item_name

Item name (String). The parameter expects a string value

ITEM_VARIANTConstant 
public static const ITEM_VARIANT:String = item_variant

Item variant.

LEVELConstant 
public static const LEVEL:String = level

Level in game (Number). The parameter expects a Number value

LEVEL_NAMEConstant 
public static const LEVEL_NAME:String = level_name

The name of a level in a game (String).

LOCATIONConstant 
public static const LOCATION:String = location

Location (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

MEDIUMConstant 
public static const MEDIUM:String = medium

CAMPAIGN_DETAILS medium; used to identify a medium such as email or cost-per-click (cpc).

METHODConstant 
public static const METHOD:String = method

A 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_NIGHTSConstant 
public static const NUMBER_OF_NIGHTS:String = number_of_nights

Number of nights staying at hotel (Number). The parameter expects a Number value

NUMBER_OF_PASSENGERSConstant 
public static const NUMBER_OF_PASSENGERS:String = number_of_passengers

Number of passengers traveling (Number). The parameter expects a Number value

NUMBER_OF_ROOMSConstant 
public static const NUMBER_OF_ROOMS:String = number_of_rooms

Number of rooms for travel events (Number). The parameter expects a Number value

ORIGINConstant 
public static const ORIGIN:String = origin

Flight or Travel origin (String). The parameter expects a string value

PRICEConstant 
public static const PRICE:String = price

Purchase price (Number). Expecting a Number value set

QUANTITYConstant 
public static const QUANTITY:String = quantity

Purchase quantity (Number). The parameter expects a Number value

SCOREConstant 
public static const SCORE:String = score

Score in game (Number). The parameter expects a Number value

SEARCH_TERMConstant 
public static const SEARCH_TERM:String = search_term

The search string/keywords used (String). The parameter expects a string value

SHIPPINGConstant 
public static const SHIPPING:String = shipping

Shipping cost (Number). Expecting a Number value

SOURCEConstant 
public static const SOURCE:String = source

CAMPAIGN_DETAILS source; used to identify a search engine, newsletter, or other source.

START_DATEConstant 
public static const START_DATE:String = start_date

The departure date, check-in date, or rental start date for the item (String). The parameter expects a date formatted as YYYY-MM-DD

SUCCESSConstant 
public static const SUCCESS:String = success

The result of an operation (Number). Specify 1 to indicate success and 0 to indicate failure.

TAXConstant 
public static const TAX:String = tax

Tax amount (Number). Expecting a Number value

TERMConstant 
public static const TERM:String = term

CAMPAIGN_DETAILS term; used with paid search to supply the keywords for ads.

TRANSACTION_IDConstant 
public static const TRANSACTION_ID:String = transaction_id

A single ID for a ecommerce group transaction (String). The parameter expects a string value

TRAVEL_CLASSConstant 
public static const TRAVEL_CLASS:String = travel_class

Travel class (String). The parameter expects a string value

VALUEConstant 
public static const VALUE:String = value

A 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_NAMEConstant 
public static const VIRTUAL_CURRENCY_NAME:String = virtual_currency_name

Name of virtual currency type (String). The parameter expects a string value