Unity.Analytics.StandardEvents

The main class of the Unity Analytics Standard Event SDK. The event methods in this class provide "fire and forget" ease of use, allowing you to send a standard event with a single line of code.

If you expect to be sending the same standard event with some amount of frequency, you may want to create an event payload and invoke the Send method when the event occurs.

The main class of the Unity Analytics Standard Event SDK. The event methods in this class provide 'fire and forget' ease of use, allowing you to send a standard event with a single line of code.

If you expect to be sending the same standard event with some amount of frequency, you may want to create an event payload and invoke the Send method when the event occurs.

Actions for all events

Add a callback for all standard events. Callback will be called, passing the outgoing event data dictionary, allowing for inspection and mutation of every Standard Event.

Add a callback for all standard events. Callback will be called, passing the outgoing event data dictionary, allowing for inspection and mutation of every Standard Event.

Gets the Unity Analytics Standard Event SDK version.

The SDK version in semantic versioning format.

Gets or sets a value indicating whether debug mode is enabled. When debug mode is enabled, a debug log is generated for each event sent. If an error occurs when sending an event, an error log is generated regardless of whether debug mode is enabled.

To view the event name and a listing of event data parameters within the debug log messages for each event, set debugMode to true.

Sends a custom event (eventName) with data (eventData)

The result of the analytics event sent The name of the event. Custom event data.

Sends a achievement_step event. Send this event when a requirement or step toward completing a multi-part achievement is complete.

The result of the analytics event sent. The order of the step (required). A unique id for this achievement (required). Dictionary of custom parameters. (optional)

Sends a achievement_unlocked event. Send this event when all requirements to unlock an achievement have been met.

The result of the analytics event sent. A unique id for this achievement (required). Dictionary of custom parameters. (optional)

Sends a ad_complete event. Send this event when an ad is successfully viewed and not skipped.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a ad_complete event. Send this event when an ad is successfully viewed and not skipped.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a ad_offer event. Send this event when the player is offered the opportunity to view an ad.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a ad_offer event. Send this event when the player is offered the opportunity to view an ad.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a ad_skip event. Send this event when the player opts to skip a video ad during video playback.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a ad_skip event. Send this event when the player opts to skip a video ad during video playback.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a ad_start event. Send this event when playback of an ad begins.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a ad_start event. Send this event when playback of an ad begins.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a chat_message_sent event. Send this event when the player sends a chat message in game.

The result of the analytics event sent. Dictionary of custom parameters. (optional)

Sends a event. An event you define yourself.

The result of the analytics event sent. Dictionary of custom parameters. (optional)

Sends a cutscene_skip event. Send this event when the player opts to skip a cutscene or cinematic screen.

The result of the analytics event sent. The name of the cutscene skipped (required). Dictionary of custom parameters. (optional)

Sends a cutscene_start event. Send this event when the player begins to watch a cutscene or cinematic screen.

The result of the analytics event sent. The name of the cutscene being viewed (required). Dictionary of custom parameters. (optional)

Sends a first_interaction event. Send this event with the first voluntary action the user takes after install.

The result of the analytics event sent. The action ID or name. For example, a unique identifier for the button clicked (optional). Dictionary of custom parameters. (optional)

Sends a game_over event. Send this event when gameplay ends (in a game with an identifiable conclusion).

The result of the analytics event sent. The order of this level within the game (optional). The level name (optional). Dictionary of custom parameters. (optional)

Sends a game_over event. Send this event when gameplay ends (in a game with an identifiable conclusion).

The result of the analytics event sent. The level name (optional). Dictionary of custom parameters. (optional)

Sends a game_start event. Send this event when gameplay starts. Usually used only in games with an identifiable conclusion.

The result of the analytics event sent. Dictionary of custom parameters. (optional)

Sends a iap_transaction event. Send this event when the player spends real-world money to make an In-App Purchase.

The result of the analytics event sent. In what context (store, gift, reward) was the item acquired? (required). How much did the item cost? (required). A name or unique identifier for the acquired item (required). The category of the item that was acquired (optional). The name or id of the level where the item was acquired (optional). A unique identifier for the specific transaction that occurred. You can use this to group multiple events into a single transaction (optional). Dictionary of custom parameters. (optional)

Sends a item_acquired event. Send this event when the player acquires an item within the game.

The result of the analytics event sent. Set to AcquisitionType.Premium if the item was purchased with real money; otherwise, AcqusitionType.Soft (required). In what context(store, gift, reward, crafting) was the item acquired? (required). The unit quantity of the item that was acquired (required). A name or unique identifier for the acquired item (required). The balance of the acquired item (optional). The category of the item that was acquired (optional). The name or id of the level where the item was acquired (optional). A unique identifier for the specific transaction that occurred. You can use this to group multiple events into a single transaction (optional). Dictionary of custom parameters. (optional)

Sends a item_acquired event. Send this event when the player acquires an item within the game.

The result of the analytics event sent. Set to AcquisitionType.Premium if the item was purchased with real money; otherwise, AcqusitionType.Soft (required). In what context(store, gift, reward, crafting) was the item acquired? (required). The unit quantity of the item that was acquired (required). A name or unique identifier for the acquired item (required). The category of the item that was acquired (optional). The name or id of the level where the item was acquired (optional). A unique identifier for the specific transaction that occurred. You can use this to group multiple events into a single transaction (optional). Dictionary of custom parameters. (optional)

Sends a item_spent event. Send this event when the player spends an item.

The result of the analytics event sent. Set to AcquisitionType.Premium if the item was purchased with real money; otherwise, AcqusitionType.Soft (required). In what context(store, gift, reward, crafting) was the item spent? (required). The unit quantity of the item that was spent (required). A name or unique identifier for the spent item (required). The balance of the spent item (optional). The category of the item that was spent (optional). The name or id of the level where the item was spent (optional). A unique identifier for the specific transaction that occurred. You can use this to group multiple events into a single transaction (optional). Dictionary of custom parameters. (optional)

Sends a item_spent event. Send this event when the player spends an item.

The result of the analytics event sent. Set to AcquisitionType.Premium if the item was purchased with real money; otherwise, AcqusitionType.Soft (required). In what context(store, gift, reward, crafting) was the item spent? (required). The unit quantity of the item that was spent (required). A name or unique identifier for the spent item (required). The category of the item that was spent (optional). The name or id of the level where the item was spent (optional). A unique identifier for the specific transaction that occurred. You can use this to group multiple events into a single transaction (optional). Dictionary of custom parameters. (optional)

Sends a level_complete event. Send this event when the player has successfully completed a level.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_complete event. Send this event when the player has successfully completed a level.

The result of the analytics event sent. The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_complete event. Send this event when the player has successfully completed a level.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_fail event. Send this event when the player fails a level.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_fail event. Send this event when the player fails a level.

The result of the analytics event sent. The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_fail event. Send this event when the player fails a level.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_quit event. Send this event when the player opts to quit from a level before completing it.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_quit event. Send this event when the player opts to quit from a level before completing it.

The result of the analytics event sent. The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_quit event. Send this event when the player opts to quit from a level before completing it.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_skip event. Send this event when the player opts to skip past a level.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_skip event. Send this event when the player opts to skip past a level.

The result of the analytics event sent. The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_skip event. Send this event when the player opts to skip past a level.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_start event. Send this event when the player enters into or begins a level.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_start event. Send this event when the player enters into or begins a level.

The result of the analytics event sent. The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_start event. Send this event when the player enters into or begins a level.

The result of the analytics event sent. The level name. Either level_name or level_index is required (required). The order of this level within the game. Either level_name or level_index is required (required). Dictionary of custom parameters. (optional)

Sends a level_up event. Send this event when the player rank or level increases.

The result of the analytics event sent. The new rank or level name (required). Dictionary of custom parameters. (optional)

Sends a level_up event. Send this event when the player rank or level increases.

The result of the analytics event sent. The new rank or level index (required). Dictionary of custom parameters. (optional)

Sends a level_up event. Send this event when the player rank or level increases.

The result of the analytics event sent. The new rank or level name (required). The new rank or level index (required). Dictionary of custom parameters. (optional)

Sends a post_ad_action event. Send this event with the first action a player takes after an ad is shown, or after an ad is offered but not shown.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a post_ad_action event. Send this event with the first action a player takes after an ad is shown, or after an ad is offered but not shown.

The result of the analytics event sent. Set to true if a reward is offered for this ad (required). The ad or mediation network provider (optional). An ad placement or configuration ID (optional). Dictionary of custom parameters. (optional)

Sends a push_notification_click event. Send this event when the player responds to a push notification.

The result of the analytics event sent. The message name or ID (required). Dictionary of custom parameters. (optional)

Sends a push_notification_enable event. Send this event when the player enables or grants permission for the game to use push notifications.

The result of the analytics event sent. Dictionary of custom parameters. (optional)

Sends a screen_visit event. Send this event when the player opens a menu or visits a screen in the game.

The result of the analytics event sent. The name of the screen or type of screen visited (required). Dictionary of custom parameters. (optional)

Sends a screen_visit event. Send this event when the player opens a menu or visits a screen in the game.

The result of the analytics event sent. The name of the screen or type of screen visited (required). Dictionary of custom parameters. (optional)

Sends a social_share event. Send this event when the player posts a message, gift, or invitation through social media.

The result of the analytics event sent. The mode of sharing, or media type used in the social engagement (required). The network through which the message is shared (required). A unique identifier for the sender (optional). A unique identifier for the recipient (optional). Dictionary of custom parameters. (optional)

Sends a social_share event. Send this event when the player posts a message, gift, or invitation through social media.

The result of the analytics event sent. The mode of sharing, or media type used in the social engagement (required). The network through which the message is shared (required). A unique identifier for the sender (optional). A unique identifier for the recipient (optional). Dictionary of custom parameters. (optional)

Sends a social_share event. Send this event when the player posts a message, gift, or invitation through social media.

The result of the analytics event sent. The mode of sharing, or media type used in the social engagement (required). The network through which the message is shared (required). A unique identifier for the sender (optional). A unique identifier for the recipient (optional). Dictionary of custom parameters. (optional)

Sends a social_share event. Send this event when the player posts a message, gift, or invitation through social media.

The result of the analytics event sent. The mode of sharing, or media type used in the social engagement (required). The network through which the message is shared (required). A unique identifier for the sender (optional). A unique identifier for the recipient (optional). Dictionary of custom parameters. (optional)

Sends a social_share_accept event. Send this event when the player accepts a message, gift, or invitation through social media.

The result of the analytics event sent. The mode of sharing, or media type used in the social engagement (required). The network through which the message is shared (required). A unique identifier for the sender (optional). A unique identifier for the recipient (optional). Dictionary of custom parameters. (optional)

Sends a social_share_accept event. Send this event when the player accepts a message, gift, or invitation through social media.

The result of the analytics event sent. The mode of sharing, or media type used in the social engagement (required). The network through which the message is shared (required). A unique identifier for the sender (optional). A unique identifier for the recipient (optional). Dictionary of custom parameters. (optional)

Sends a social_share_accept event. Send this event when the player accepts a message, gift, or invitation through social media.

The result of the analytics event sent. The mode of sharing, or media type used in the social engagement (required). The network through which the message is shared (required). A unique identifier for the sender (optional). A unique identifier for the recipient (optional). Dictionary of custom parameters. (optional)

Sends a social_share_accept event. Send this event when the player accepts a message, gift, or invitation through social media.

The result of the analytics event sent. The mode of sharing, or media type used in the social engagement (required). The network through which the message is shared (required). A unique identifier for the sender (optional). A unique identifier for the recipient (optional). Dictionary of custom parameters. (optional)

Sends a store_item_click event. Send this event when the player clicks on an item in the store.

The result of the analytics event sent. Set to StoreType.Premium if purchases use real-world money; otherwise, StoreType.Soft (required). A unique identifier for the item (required). The item's name (optional). Dictionary of custom parameters. (optional)

Sends a store_opened event. Send this event when the player opens a store in game.

The result of the analytics event sent. Set to StoreType.Premium if purchases use real-world money; otherwise, StoreType.Soft (required). Dictionary of custom parameters. (optional)

Sends a tutorial_complete event. Send this event when the player completes a tutorial.

The result of the analytics event sent. The tutorial name or ID (optional). Dictionary of custom parameters. (optional)

Sends a tutorial_skip event. Send this event when the player opts to skip a tutorial.

The result of the analytics event sent. The tutorial name or ID (optional). Dictionary of custom parameters. (optional)

Sends a tutorial_start event. Send this event when the player starts a tutorial.

The result of the analytics event sent. The tutorial name or ID (optional). Dictionary of custom parameters. (optional)

Sends a tutorial_step event. Send this event when the player completes a step or stage in a multi-part tutorial.

The result of the analytics event sent. The step or stage completed in a multi-part tutorial (required). The tutorial name or ID (optional). Dictionary of custom parameters. (optional)

Sends a user_signup event. Send this event when the player registers or logs in for the first time.

The result of the analytics event sent. The authorization network or login service provider (required). Dictionary of custom parameters. (optional)

Sends a user_signup event. Send this event when the player registers or logs in for the first time.

The result of the analytics event sent. The authorization network or login service provider (required). Dictionary of custom parameters. (optional)

The source through which an item, consumable, or currency was acquired.

No available source, or source unknown. Note: Use a string value if the acquisition source is not one of the elements defined in this enumeration.

Purchased using currency or consumable resources.

Awarded through an achievement or other in-game interaction.

Granted as a promotion of some in-game feature or through cross promotion.

Granted without motive other than good feelings.

Granted as a reward for watching an advertisement.

Granted periodically.

Granted through social engagement.

The type of currency (premium or soft) used to acquire the item. SA: AnalyticsEvent.ItemAcquired

Not directly purchased with real-world money.

Purchased with real-world money.

The list of advertising or mediation network service providers. Use the members of this list when possible to promote consistency in your Analytics data. However, if the advertising network is not included in this list, pass the argument to the Standard Event function as a string. SA: AnalyticsEvent.AdComplete, AnalyticsEvent.AdOffer, AnalyticsEvent.AdSkip, AnalyticsEvent.AdStart, AnalyticsEvent.PostAdAction

No available network, or network unknown. Note: Use a string value to indicate a network not defined in this enumeration.

Aarki network.

AdAction network.

AdapTv network.

Adcash network.

AdColony network.

AdMob network.

AerServ network.

Airpush network.

Altrooz network.

Ampush network.

AppleSearch network.

AppLift network.

AppLovin network.

Appnext network.

AppNexus network.

Appoday network.

Appodeal network.

AppsUnion network.

Avazu network.

BlueStacks network.

Chartboost network.

ClickDealer network.

CPAlead network.

CrossChannel network.

CrossInstall network.

Epom network.

Facebook network.

Fetch network.

Fiksu network.

Flurry network.

Fuse network.

Fyber network.

Glispa network.

Google network.

GrowMobile network.

HeyZap network.

HyperMX network.

Iddiction network.

IndexExchange network.

InMobi network.

Instagram network.

Instal network.

Ipsos network.

IronSource network.

Jirbo network.

Kimia network.

Leadbolt network.

Liftoff network.

Manage network.

Matomy network.

MediaBrix network.

MillenialMedia network.

Minimob network.

MobAir network.

MobileCore network.

Mobobeat network.

Mobusi network.

Mobvista network.

MoPub network.

Motive network.

Msales network.

NativeX network.

OpenX network.

Pandora network.

PropellerAds network.

Revmob network.

RubiconProject network.

SiriusAd network.

Smaato network.

SponsorPay network.

SpotXchange network.

StartApp network.

Tapjoy network.

Taptica network.

Tremor network.

TrialPay network.

Twitter network.

UnityAds network.

Vungle network.

Yeahmobi network.

YuMe network.

The list of authorization networks for in-game login sessions. Use the members of this list when possible to promote consistency in your Analytics data. However, if the authorization network is not included in this list, pass the argument to the Standard Event function as a string. SA: AnalyticsEvent.UserSignup

No available authorization network, or network unknown. Note: Use a string value to indicate an authorization network not defined in this enumeration.

You use your own authorization system.

Facebook authorization.

Twitter authorization.

Google authorization.

GameCenter authorization.

The list of the in-game screen or interface types. Use the members of this list when possible to promote consistency in your Analytics data. However, if the screen name is not included in this list, pass the argument to the Standard Event function as a string. SA: AnalyticsEvent.ScreenVisit

No defined screen name. Note: Use a string value to indicate a screen name not defined in this enumeration.

The game's main menu screen.

The game's settings screen.

The game's map screen.

The screen shown when the player loses the game.

The screen shown when the player wins the game.

The game's credits screen.

The game's title screen.

The screen shown for IAP promotions.

The screen shown for cross promotions.

The screen shown for feature promotions.

The game's hint screen.

The game's pause screen.

The game's inventory screen.

The game's leaderboard screen.

The game's achievement screen.

The game's lobby screen.

The list of media types or modes used for social engagements. Use the members of this list when possible to promote consistency in your Analytics data. However, if the media type or mode is not included in this list, pass the argument to the Standard Event function as a string. SA: AnalyticsEvent.SocialShare, AnalyticsEvent.SocialShareAccept

No defined engagement media or mode. Note: Use a string value to indicate a mode of social engagement not defined in this enumeration.

A text-based mode of engagement, such as a text or chat message.

An image-based mode of engagement.

A video-based mode of engagement.

A mode of engagement that involves an invitation.

An in-game achievement.

The list of social networks used with social engagements. Use the members of this list when possible to promote consistency in your Analytics data. However, if the social network is not included in this list, pass the argument to the Standard Event function as a string. SA: AnalyticsEvent.SocialShare, AnalyticsEvent.SocialShareAccept

No available social network, or network unknown. Note: Use a string value to indicate social network not defined in this enumeration.

Facebook.

Twitter.

Instagram.

Google Plus.

Pinterest.

WeChat.

The Sina Weibo social network.

The Tencent Weibo social network.

QQ and QZone networks.

Zhihu network.

VKontakte network.

Odnoklassniki network.

The list of in-game store categories. SA: AnalyticsEvent.StoreItemClick, AnalyticsEvent.StoreOpened

Contains items purchasable with in-game currency only.

Contains items purchasable with real-world money.

An event you define yourself.

Send this event when a requirement or step toward completing a multi-part achievement is complete.

The order of the step. Required.

A unique id for this achievement. Required.

Send this event when all requirements to unlock an achievement have been met.

A unique id for this achievement. Required.

Send this event when an ad is successfully viewed and not skipped.

Set to true if a reward is offered for this ad. Required.

The ad or mediation network provider. Optional.

An ad placement or configuration ID. Optional.

Send this event when the player is offered the opportunity to view an ad.

Set to true if a reward is offered for this ad. Required.

The ad or mediation network provider. Optional.

An ad placement or configuration ID. Optional.

Send this event when the player opts to skip a video ad during video playback.

Set to true if a reward is offered for this ad. Required.

The ad or mediation network provider. Optional.

An ad placement or configuration ID. Optional.

Send this event when playback of an ad begins.

Set to true if a reward is offered for this ad. Required.

The ad or mediation network provider. Optional.

An ad placement or configuration ID. Optional.

Send this event with the first action a player takes after an ad is shown, or after an ad is offered but not shown.

Set to true if a reward is offered for this ad. Required.

The ad or mediation network provider. Optional.

An ad placement or configuration ID. Optional.

Send this event when the player sends a chat message in game.

Send this event when the player begins to watch a cutscene or cinematic screen.

The name of the cutscene being viewed. Required.

Send this event when the player opts to skip a cutscene or cinematic screen.

The name of the cutscene skipped. Required.

Send this event when gameplay ends (in a game with an identifiable conclusion).

The order of this level within the game. Optional.

The level name. Optional.

Send this event when gameplay starts. Usually used only in games with an identifiable conclusion.

Send this event when the player spends real-world money to make an In-App Purchase.

In what context (store, gift, reward) was the item acquired? Required.

How much did the item cost? Required.

A name or unique identifier for the acquired item. Required.

The category of the item that was acquired. Optional.

The name or id of the level where the item was acquired. Optional.

A unique identifier for the specific transaction that occurred. You can use this to group multiple events into a single transaction. Optional.

Send this event when the player acquires an item within the game.

Set to AcquisitionType.Premium if the item was purchased with real money; otherwise, AcqusitionType.Soft. Required.

In what context(store, gift, reward, crafting) was the item acquired? Required.

The unit quantity of the item that was acquired Required.

A name or unique identifier for the acquired item. Required.

The balance of the acquired item. Optional.

The category of the item that was acquired. Optional.

The name or id of the level where the item was acquired. Optional.

A unique identifier for the specific transaction that occurred. You can use this to group multiple events into a single transaction. Optional.

Send this event when the player spends an item.

Set to AcquisitionType.Premium if the item was purchased with real money; otherwise, AcqusitionType.Soft. Required.

In what context(store, gift, reward, crafting) was the item spent? Required.

The unit quantity of the item that was spent Required.

A name or unique identifier for the spent item. Required.

The balance of the spent item. Optional.

The category of the item that was spent. Optional.

The name or id of the level where the item was spent. Optional.

A unique identifier for the specific transaction that occurred. You can use this to group multiple events into a single transaction. Optional.

Send this event when the player has successfully completed a level.

The level name. Either level_name or level_index is required.

The order of this level within the game. Either level_name or level_index is required.

Send this event when the player fails a level.

The level name. Either level_name or level_index is required.

The order of this level within the game. Either level_name or level_index is required.

Send this event when the player opts to quit from a level before completing it.

The level name. Either level_name or level_index is required.

The order of this level within the game. Either level_name or level_index is required.

Send this event when the player opts to skip past a level.

The level name. Either level_name or level_index is required.

The order of this level within the game. Either level_name or level_index is required.

Send this event when the player enters into or begins a level.

The level name. Either level_name or level_index is required.

The order of this level within the game. Either level_name or level_index is required.

Send this event when the player rank or level increases.

The new rank or level name. Required.

The new rank or level index. Required.

Send this event with the first voluntary action the user takes after install.

The action ID or name. For example, a unique identifier for the button clicked. Optional.

Send this event when the player responds to a push notification.

The message name or ID. Required.

Send this event when the player enables or grants permission for the game to use push notifications.

Send this event when the player opens a menu or visits a screen in the game.

The name of the screen or type of screen visited. Required.

Send this event when the player posts a message, gift, or invitation through social media.

The mode of sharing, or media type used in the social engagement. Required.

The network through which the message is shared. Required.

A unique identifier for the sender. Optional.

A unique identifier for the recipient. Optional.

Send this event when the player accepts a message, gift, or invitation through social media.

The mode of sharing, or media type used in the social engagement. Required.

The network through which the message is shared. Required.

A unique identifier for the sender. Optional.

A unique identifier for the recipient. Optional.

Send this event when the player clicks on an item in the store.

Set to StoreType.Premium if purchases use real-world money; otherwise, StoreType.Soft. Required.

A unique identifier for the item. Required.

The item's name. Optional.

Send this event when the player opens a store in game.

Set to StoreType.Premium if purchases use real-world money; otherwise, StoreType.Soft. Required.

Send this event when the player completes a tutorial.

The tutorial name or ID. Required.

Send this event when the player opts to skip a tutorial.

The tutorial name or ID. Required.

Send this event when the player starts a tutorial.

The tutorial name or ID. Required.

Send this event when the player completes a step or stage in a multi-part tutorial.

The step or stage completed in a multi-part tutorial. Required.

The tutorial name or ID. Required.

Send this event when the player registers or logs in for the first time.

The authorization network or login service provider. Required.