UnityEngine.UnityAnalyticsModule

Unity Analytics provides insight into your game users e.g. DAU, MAU.

Get the Analytics config endpoint.

Get the Analytics dashboard endpoint.

Controls whether the sending of device stats at runtime is enabled.

Controls whether the Analytics service is enabled at runtime.

Get the Analytics event endpoint.

Reports whether Unity is set to initialize Analytics on startup.

Controls whether to limit user tracking at runtime.

Reports whether the player has opted out of data collection.

Custom Events (optional).

Name of custom event. Name cannot include the prefix "unity." - This is a reserved keyword. Additional parameters sent to Unity Analytics at the time the custom event was triggered. Dictionary key cannot include the prefix "unity." - This is a reserved keyword.

Custom Events (optional).

Custom Events (optional).

Use it to enable or disable a custom event.

Use it to enable or disable an event.

Attempts to flush immediately all queued analytics events to the network and filesystem cache if possible (optional).

Use it to check to custom event enable status.

Use it to check to an event enable status.

This API is used for registering a Runtime Analytics event. Note: This API is for internal use only and is likely change in the future. Do not use in user code.

Name of the event. Hourly limit for this event name. Maximum number of items in this event. Vendor key name. Optional event name prefix value. Event version number.

This API is used for registering a Runtime Analytics event. Note: This API is for internal use only and is likely change in the future. Do not use in user code.

Name of the event. Hourly limit for this event name. Maximum number of items in this event. Vendor key name. Optional event name prefix value. Event version number.

Resume Analytics initialization.

This API is used to send a Runtime Analytics event. Note: This API is for internal use only and is likely change in the future. Do not use in user code.

Name of the event. Event version number. Optional event name prefix value. Additional event data.

Use this API to set the event end point URL. Note: This API is for internal use only and is likely change in the future. Do not use in user code.

Name of the event. Event version number. Event end point URL. Optional event name prefix value.

Use this API to set the event priority. Note: This API is for internal use only and is likely change in the future. Do not use in user code.

Name of the event. Event version number. Optional event name prefix value. Event priority.

User Demographics (optional).

Birth year of user. Must be 4-digit year format, only.

User Demographics (optional).

Gender of user can be "Female", "Male", or "Unknown".

User Demographics (optional).

User id.

Tracking Monetization (optional).

The id of the purchased item. The price of the item. Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations. Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts. Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature. Set to true when using UnityIAP.

Tracking Monetization (optional).

The id of the purchased item. The price of the item. Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations. Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts. Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature. Set to true when using UnityIAP.

Tracking Monetization (optional).

The id of the purchased item. The price of the item. Abbreviation of the currency used for the transaction. For example “USD” (United States Dollars). See http:en.wikipedia.orgwikiISO_4217 for a standardized list of currency abbreviations. Receipt data (iOS) receipt ID (android) for in-app purchases to verify purchases with Apple iTunes / Google Play. Use null in the absence of receipts. Android receipt signature. If using native Android use the INAPP_DATA_SIGNATURE string containing the signature of the purchase data that was signed with the private key of the developer. The data signature uses the RSASSA-PKCS1-v1_5 scheme. Pass in null in absence of a signature. Set to true when using UnityIAP.

Analytics event priority.

Use this flag to send events while in the stop state.

Any current or previous events in the memory queue persist immediately to the filesystem.

Any current or previous events in the memory queue persist immediately to the filesystem and dispatcher service makes the events available to send to the server. It adds the events to the bottom of the dispatch queue and makes them available to send to the server.

This priority is similar to the Analytics.AnalyticsEventPriority.HighPriorityEvent, except these events are given a highest priority than other events in the disptach queue. It adds the events to the top of the dispatch queue and makes them available to send to the server.

This priority is similar to the Analytics.AnalyticsEventPriority.HighestPriorityEvent, except these events will be stored in the memory queue and will not persist in the file system. In case of failure to post the event to the server, it will not attempt to send them again.

Any current or previous events in the memory queue persist immediately to the filesystem. It adds the events to the bottom of the dispatch queue and makes them available to send to the server.

This priority lets you send events in the stop state, and makes any current or previous events in the memory queue persist immediately to the filesystem. It adds the events to the bottom of the dispatch queue and makes them available to send to the server.

Events will be stored in the memory queue, and will not persist in the file system.

In case of failure to post the event to the server, it will not attempt to send them again.

This priority queues events in-memory.

This priority is similar to the Analytics.AnalyticsEventPriority.NormalPriorityEvent, except these events will be stored in the memory queue and will not persist in the file system. In case of failure to post the event to the server, it will not attempt to send them again.

This priority queues events in-memory and writes them to the filesystem immediately.

Events with this flag are given higher priority compared to others while dispatching to the server.

Analytics API result.

Analytics API result: Analytics is disabled.

Analytics API result: Invalid argument value.

Analytics API result: Analytics not initialized.

Analytics API result: Success.

Analytics API result: Argument size limit.

Analytics API result: Too many parameters.

Analytics API result: Too many requests.

Analytics API result: This platform doesn't support Analytics.

Provides access to the Analytics session information for the current game instance.

Reports the current custom device ID.

Reports the current custom user ID.

The current user identity token that the Analytics server returns based on AnalyticsSessionInfo.userId.

Dispatched when AnalyticsSessionInfo.identityToken is updated by the server.

The number of sessions played since the app was installed.

The time elapsed, in milliseconds, since the beginning of the current game session.

Reports whether the current session is the first session since the player installed the game or application.

A random, unique GUID identifying the current game or app session.

The current state of the session.

Dispatched when the Analytics session state changes.

A random GUID uniquely identifying sessions played on the same instance of your game or app.

Defines the delegate signature to handle AnalyticsSettings.IdentityTokenChanged events.

Dispatched when the Analytics session state changes.

Current session state. Current session id. Length of the current session in milliseconds. True, if the sessionId has changed; otherwise false.

Session tracking states.

Session tracking has paused.

Session tracking has resumed.

Session tracking has started.

Session tracking has stopped.

User Demographics: Gender of a user.

User Demographics: Female Gender of a user.

User Demographics: Male Gender of a user.

User Demographics: Unknown Gender of a user.

Provides access to your remote settings.

Dispatched before the RemoteSettings object makes the network request for the latest settings.

Dispatched when the network request made by the RemoteSettings object to fetch the remote configuration file is complete.

Forces the game to download the newest settings from the server and update its values.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Gets the number of keys in the remote settings configuration.

Gets a dictionary corresponding to the remote setting identified by key, if it exists.

The key identifying the setting. An instance of Dictionary<string, object> containing the corresponding remote value or values.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Gets an array containing all the keys in the remote settings configuration.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Gets the object corresponding to the remote setting identified by key, if it exists.

The key identifying the setting. An instance of the object with fields assigned the corresponding remote values.

Gets the object corresponding to the remote setting identified by key, if it exists.

The key identifying the setting. The type of object represented in RemoteSettings. An instance of the object with fields assigned the corresponding remote values.

Gets the object corresponding to the remote setting identified by key, if it exists.

The object that should be for default values. The key identifying the setting. An instance of the object with fields assigned the corresponding remote values.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Gets the value corresponding to remote setting identified by key, if it exists.

The key identifying the setting. The default value to use if the setting identified by the key parameter cannot be found or is unavailable. The current value of the setting identified by key, or the default value.

Reports whether the specified key exists in the remote settings configuration.

The key identifying the setting. True, if the key exists.

Dispatched when a remote settings configuration is fetched and successfully parsed from the server or from local cache.

Defines the delegate signature for handling RemoteSettings.Updated events.

Reports whether or not the settings available from the RemoteSettings object were received from the Analytics Service during the current session.

True, if the remote settings file was received from the Analytics Service in the current session. False, if the remote settings file was received during an earlier session and cached.

The UnityAnalytics module implements APIs required to use Unity Analytics.