This document explains important concepts about using the Google Analytics Plugin for Unity.
Before you begin
Before you begin make sure you have completed the following items:
- You should have at least one Google Analytics property and a view (profile) to which to send data from your game.
- If you intend to track Ecommerce transactions then Enable ecommerce in your reports.
- Download googleanalyticsv3.unitypackage from the Google Analytics Plugin for Unity repo and import it into your Unity project (you should be able to do this by double-clicking on the file).
Setup and configuration
Choose a platform for configuration details:
- If your project does not already have a file called AndroidManifest.xml in the <YOUR PROJECT ROOT>/Assets/Plugins/Android/ directory, build the project for Android and then copy the AndroidManifest.xml from the Temp/StagingArea/ directory (it will be under the directory you chose to build in). Paste it into <YOUR PROJECT ROOT>/Assets/Plugins/Android/.
- Add the following permissions to the
AndroidManifest.xml in <YOUR PROJECT ROOT>
/Assets/Plugins/Android/ above the
<uses-permission android:name="android.permission.INTERNET"/> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
- If you want to enable Campaign
Tracking, add the service as follows:
<service android:name="com.google.analytics.tracking.android.CampaignTrackingService" /> <receiver android:name="com.google.analytics.tracking.android.CampaignTrackingReceiver" android:exported="true" > <intent-filter> <action android:name="com.android.vending.INSTALL_REFERRER" /> </intent-filter> </receiver>
Add the following libraries to your Xcode project:
- If you prefer to have the libraries automatically added when building for iOS, copy the file PostProcessBuildPlayer_GA from the iOS Extras directory and put it in the <YOUR PROJECT ROOT>/Assets/Editor directory.
- Download the mod_pbxproj.py script and copy it into the Editor directory. The libraries will now be added automatically during the build.
Configure the GAv3 prefab
The following steps are required to configure the GAv3 prefab:
- Click on the
GAv3.prefabprefab object, which can be found in Assets/Plugins/GoogleAnalyticsV3 in the Project View.
- The Inspector view will display a Script
component attached to the prefab with several properties listed.
Populate these properties with the correct values for your project. This will
populate the object so that it can be used everywhere in your project. For
Android Property ID: UA-XXXXXXX-1
iOS Property ID: UA-XXXXXXX-2
Other Property ID: UA-XXXXXXX-3
App Name: MyGame
Bundle ID: com.example.games
App Version: 1.0
Dispatch Period: 5
Sample Frequency: 100
Debug Mode: VERBOSE
Anonymize IP: false
Dry Run: false
- Drag the populated GAv3 from the Project view up into the Object Hierarchy.
Track an object
After configuring the GAv3 prefab you're ready to start tracking an object using Google Analytics by following these steps:
- Identify a GameObject you wish to track (for example, a Player object) and click it in the Object Hierarchy view. If you do not already have a script attached to the object that you want to track then create a new script using the Add Component button in the Inspector view.
- Create a public variable in the class to hold the GoogleAnalyticsV3
object. For example:
public GoogleAnalyticsV3 googleAnalytics;
- Save the script and return to the Unity window.
- In the Inspector view for the GameObject you wish to track, you will see the script you created and a field to populate called Google Analytics (or the variable name you chose). Drag the GAv3 object from the Object Hierarchy view onto the field.
- You are now ready to start tracking that GameObject. Repeat the process for other objects you wish to track using the same prefab.
- Review the API Reference to learn what kind of hits you can send to Google Analytics.
- Read the Mobile App Implementation Guide to learn how to use Google Analytics to measure user interactions and answer questions about game usage.