defold/extension-firebase-analytics/firebase-analytics
Functions and constants for interacting with Firebase
- GitHub: defold/extension-firebase-analytics — pinned to
3.3.1(released while Defold 1.13.1 was current)- Pick a release from defold/extension-firebase-analytics releases and add its Source code (zip) URL (or a packaged
.zipasset, if the library ships one) togame.projectunder[project]dependencies, then Fetch Libraries in the Defold editor. - Run
bunx @defold-typescript/cli resolveto materialize its types. - Import it under a namespace alias of your choice:
import * as firebase from "firebase"
- Pick a release from defold/extension-firebase-analytics releases and add its Source code (zip) URL (or a packaged
Functions
firebase.analytics.initialize()firebase.analytics.set_callback(callback: function)firebase.analytics.log(event_name: string)firebase.analytics.log_string(event_name: string, param_name: string, param: string)firebase.analytics.log_int(event_name: string, param_name: string, param: number)firebase.analytics.log_number(event_name: string, param_name: string, param: number)firebase.analytics.log_table(event_name: string, parameters: table)firebase.analytics.set_default_event_parameters(parameters: table)firebase.analytics.set_user_id(user_id: string)firebase.analytics.set_user_property(name: string, property: string)firebase.analytics.reset()firebase.analytics.get_id()firebase.analytics.set_enabled(enabled: boolean)
firebase.analytics.initialize()
Initialise analytics
firebase.analytics.set_callback(callback: function)
Sets a callback function for receiving events from the SDK. Call firebase.analytics.set_callback(nil) to remove callback
Parameters
callback:function— Callback function that is executed on any event in the SDK.self:object— The calling script instancemessage_id:number— One of message types:firebase.analytics.MSG_ERRORfirebase.analytics.MSG_INSTANCE_IDmessage:table— A table holding the dataerror?:string— The error message (if an error occurred ornilotherwise)instance_id?:string— For message_id MSG_INSTANCE_ID ornilotherwise.
firebase.analytics.log(event_name: string)
Log an event without parameters.
Parameters
event_name:string— Event name
firebase.analytics.log_string(event_name: string, param_name: string, param: string)
Log an event with one string parameter.
Parameters
event_name:string— Event nameparam_name:string— Parameter nameparam:string— Parameter value
firebase.analytics.log_int(event_name: string, param_name: string, param: number)
Log an event with one integer parameter.
Parameters
event_name:string— Event nameparam_name:string— Parameter nameparam:number— Parameter value
firebase.analytics.log_number(event_name: string, param_name: string, param: number)
Log an event with one float parameter.
Parameters
event_name:string— Event nameparam_name:string— Parameter nameparam:number— Parameter value
firebase.analytics.log_table(event_name: string, parameters: table)
Log an event with table parameters.
Parameters
event_name:string— Event nameparameters:table— Table with parameters (key-value pairs)
firebase.analytics.set_default_event_parameters(parameters: table)
Set default parameters that will be included with future events.
Parameters
parameters:table— Table with default parameters (key-value pairs)
firebase.analytics.set_user_id(user_id: string)
Sets the user ID property.
Parameters
user_id:string— User ID property
firebase.analytics.set_user_property(name: string, property: string)
Set a user property to the given value.
Parameters
name:string— User property nameproperty:string— User property value
firebase.analytics.reset()
Clears all data for this app from the device and resets the app instance id.
firebase.analytics.get_id()
Get the instance ID from the service. Returned in callback with MSG_INSTANCE_ID message_id.
firebase.analytics.set_enabled(enabled: boolean)
Sets whether analytics collection is enabled for this app on this device.
Parameters
enabled:boolean— The value
Constants
firebase.analytics.MSG_ERROR
Event generated when an error occurred.
firebase.analytics.MSG_INSTANCE_ID
Event generated when instance_id ready after firebase.analytics.get_id() call
firebase.analytics.EVENT_ADIMPRESSION
Predefined event
firebase.analytics.EVENT_ADDPAYMENTINFO
Predefined event
firebase.analytics.EVENT_ADDSHIPPINGINFO
Predefined event
firebase.analytics.EVENT_ADDTOCART
Predefined event
firebase.analytics.EVENT_ADDTOWISHLIST
Predefined event
firebase.analytics.EVENT_APPOPEN
Predefined event
firebase.analytics.EVENT_BEGINCHECKOUT
Predefined event
firebase.analytics.EVENT_CAMPAIGNDETAILS
Predefined event
firebase.analytics.EVENT_EARNVIRTUALCURRENCY
Predefined event
firebase.analytics.EVENT_GENERATELEAD
Predefined event
firebase.analytics.EVENT_JOINGROUP
Predefined event
firebase.analytics.EVENT_LEVELEND
Predefined event
firebase.analytics.EVENT_LEVELSTART
Predefined event
firebase.analytics.EVENT_LEVELUP
Predefined event
firebase.analytics.EVENT_LOGIN
Predefined event
firebase.analytics.EVENT_POSTSCORE
Predefined event
firebase.analytics.EVENT_PURCHASE
Predefined event
firebase.analytics.EVENT_REFUND
Predefined event
firebase.analytics.EVENT_REMOVEFROMCART
Predefined event
firebase.analytics.EVENT_SCREENVIEW
Predefined event
firebase.analytics.EVENT_SEARCH
Predefined event
firebase.analytics.EVENT_SELECTCONTENT
Predefined event
firebase.analytics.EVENT_SELECTITEM
Predefined event
firebase.analytics.EVENT_SELECTPROMOTION
Predefined event
firebase.analytics.EVENT_SHARE
Predefined event
firebase.analytics.EVENT_SIGNUP
Predefined event
firebase.analytics.EVENT_SPENDVIRTUALCURRENCY
Predefined event
firebase.analytics.EVENT_TUTORIALBEGIN
Predefined event
firebase.analytics.EVENT_TUTORIALCOMPLETE
Predefined event
firebase.analytics.EVENT_UNLOCKACHIEVEMENT
Predefined event
firebase.analytics.EVENT_VIEWCART
Predefined event
firebase.analytics.EVENT_VIEWITEM
Predefined event
firebase.analytics.EVENT_VIEWITEMLIST
Predefined event
firebase.analytics.EVENT_VIEWPROMOTION
Predefined event
firebase.analytics.EVENT_VIEWSEARCHRESULTS
Predefined event
firebase.analytics.PARAM_ADFORMAT
Predefined parameter
firebase.analytics.PARAM_ADNETWORKCLICKID
Predefined parameter
firebase.analytics.PARAM_ADPLATFORM
Predefined parameter
firebase.analytics.PARAM_ADSOURCE
Predefined parameter
firebase.analytics.PARAM_ADUNITNAME
Predefined parameter
firebase.analytics.PARAM_AFFILIATION
Predefined parameter
firebase.analytics.PARAM_CP1
Predefined parameter
firebase.analytics.PARAM_CAMPAIGN
Predefined parameter
firebase.analytics.PARAM_CAMPAIGNID
Predefined parameter
firebase.analytics.PARAM_CHARACTER
Predefined parameter
firebase.analytics.PARAM_CONTENT
Predefined parameter
firebase.analytics.PARAM_CONTENTTYPE
Predefined parameter
firebase.analytics.PARAM_COUPON
Predefined parameter
firebase.analytics.PARAM_CREATIVEFORMAT
Predefined parameter
firebase.analytics.PARAM_CREATIVENAME
Predefined parameter
firebase.analytics.PARAM_CREATIVESLOT
Predefined parameter
firebase.analytics.PARAM_CURRENCY
Predefined parameter
firebase.analytics.PARAM_DESTINATION
Predefined parameter
firebase.analytics.PARAM_DISCOUNT
Predefined parameter
firebase.analytics.PARAM_ENDDATE
Predefined parameter
firebase.analytics.PARAM_EXTENDSESSION
Predefined parameter
firebase.analytics.PARAM_FLIGHTNUMBER
Predefined parameter
firebase.analytics.PARAM_GROUPID
Predefined parameter
firebase.analytics.PARAM_INDEX
Predefined parameter
firebase.analytics.PARAM_ITEMBRAND
Predefined parameter
firebase.analytics.PARAM_ITEMCATEGORY
Predefined parameter
firebase.analytics.PARAM_ITEMCATEGORY2
Predefined parameter
firebase.analytics.PARAM_ITEMCATEGORY3
Predefined parameter
firebase.analytics.PARAM_ITEMCATEGORY4
Predefined parameter
firebase.analytics.PARAM_ITEMCATEGORY5
Predefined parameter
firebase.analytics.PARAM_ITEMID
Predefined parameter
firebase.analytics.PARAM_ITEMLISTID
Predefined parameter
firebase.analytics.PARAM_ITEMLISTNAME
Predefined parameter
firebase.analytics.PARAM_ITEMNAME
Predefined parameter
firebase.analytics.PARAM_ITEMVARIANT
Predefined parameter
firebase.analytics.PARAM_ITEMS
Predefined parameter
firebase.analytics.PARAM_LEVEL
Predefined parameter
firebase.analytics.PARAM_LEVELNAME
Predefined parameter
firebase.analytics.PARAM_LOCATION
Predefined parameter
firebase.analytics.PARAM_LOCATIONID
Predefined parameter
firebase.analytics.PARAM_MARKETINGTACTIC
Predefined parameter
firebase.analytics.PARAM_MEDIUM
Predefined parameter
firebase.analytics.PARAM_METHOD
Predefined parameter
firebase.analytics.PARAM_NUMBEROFNIGHTS
Predefined parameter
firebase.analytics.PARAM_NUMBEROFPASSENGERS
Predefined parameter
firebase.analytics.PARAM_NUMBEROFROOMS
Predefined parameter
firebase.analytics.PARAM_ORIGIN
Predefined parameter
firebase.analytics.PARAM_PAYMENTTYPE
Predefined parameter
firebase.analytics.PARAM_PRICE
Predefined parameter
firebase.analytics.PARAM_PROMOTIONID
Predefined parameter
firebase.analytics.PARAM_PROMOTIONNAME
Predefined parameter
firebase.analytics.PARAM_QUANTITY
Predefined parameter
firebase.analytics.PARAM_SCORE
Predefined parameter
firebase.analytics.PARAM_SCREENCLASS
Predefined parameter
firebase.analytics.PARAM_SCREENNAME
Predefined parameter
firebase.analytics.PARAM_SEARCHTERM
Predefined parameter
firebase.analytics.PARAM_SHIPPING
Predefined parameter
firebase.analytics.PARAM_SHIPPINGTIER
Predefined parameter
firebase.analytics.PARAM_SOURCE
Predefined parameter
firebase.analytics.PARAM_SOURCEPLATFORM
Predefined parameter
firebase.analytics.PARAM_STARTDATE
Predefined parameter
firebase.analytics.PARAM_SUCCESS
Predefined parameter
firebase.analytics.PARAM_TAX
Predefined parameter
firebase.analytics.PARAM_TERM
Predefined parameter
firebase.analytics.PARAM_TRANSACTIONID
Predefined parameter
firebase.analytics.PARAM_TRAVELCLASS
Predefined parameter
firebase.analytics.PARAM_VALUE
Predefined parameter
firebase.analytics.PARAM_VIRTUALCURRENCYNAME
Predefined parameter
firebase.analytics.PROP_ALLOWADPERSONALIZATIONSIGNALS
Predefined property
firebase.analytics.PROP_SIGNUPMETHOD
Predefined property