https://github.com/webengage/webengage-unity-android
WebEngage Unity Package for Android apps built with Unity
https://github.com/webengage/webengage-unity-android
Last synced: 11 months ago
JSON representation
WebEngage Unity Package for Android apps built with Unity
- Host: GitHub
- URL: https://github.com/webengage/webengage-unity-android
- Owner: WebEngage
- Created: 2019-04-12T16:34:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-08-26T10:08:42.000Z (almost 4 years ago)
- Last Synced: 2025-03-04T14:49:12.742Z (over 1 year ago)
- Language: C#
- Homepage:
- Size: 2.31 MB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WebEngage Unity Android
WebEngage Unity Android plugin for Unity Android apps. This unitypackage is only for Android and would not work on any other platform.
## Installation
1. Download the [WebEngageUnityAndroid.unitypackage](https://github.com/WebEngage/webengage-unity-android/raw/master/WebEngageUnityAndroid.unitypackage).
2. Import the downloaded unitypackage into your Unity project through `Assets` > `Import Package` > `Custom Package...`.
3. Replace the AAR file at `Assets/Plugins/Android/webengage-android-unity-X.X.X.aar` with the latest [webengage-android-unity.aar](https://github.com/WebEngage/webengage-unity-android/raw/master/Assets/Plugins/Android/webengage-android-unity-3.16.0.aar).
## Update
1. Replace the AAR file at `Assets/Plugins/Android/webengage-android-unity-X.X.X.aar` with the latest [webengage-android-unity.aar](https://github.com/WebEngage/webengage-unity-android/raw/master/Assets/Plugins/Android/webengage-android-unity-3.16.0.aar).
## Initialization
1. Add the following meta-data tags in `Assets/Plugins/Android/AndroidManifest.xml` file of your Unity project.
```xml
...
```
If `AndroidManifest.xml` file does not exist in `Assets/Plugins/Android/` directory of your Unity project, then you can create a new `AndroidManifest.xml` file and copy the below content in it.
```xml
```
**Note:** Replace YOUR-WEBENGAGE-LICENSE-CODE with your own WebEngage license code.
2. Initialize the WebEngage SDK at start of your application.
```csharp
using WebEngageBridge;
...
public class YourScript : MonoBehaviour
{
private void Awake()
{
WebEngage.Engage();
...
}
...
}
```
## Attribution Tracking
In order to track 'App Installed' events and install-referrer URLs, follow the steps below.
1. Make sure that you are using webengage-android-unity.aar version 3.16.0 or above.
2. Download the latest version of [Android Install Referrer library (aar)](https://mvnrepository.com/artifact/com.android.installreferrer/installreferrer).
3. Add the aar file to your Unity project at the location `/Assets/Plugins/Android/installreferrer-X.X.X.aar`.
## Tracking Users
1. Login and Logout
```csharp
using WebEngageBridge;
...
public class YourScript : MonoBehaviour
{
...
// User login
WebEngage.Login("userId");
// User logout
WebEngage.Logout();
}
```
2. Set system user attributes as shown below.
```csharp
using WebEngageBridge;
...
public class YourScript : MonoBehaviour
{
// Set user first name
WebEngage.SetFirstName("John");
// Set user last name
WebEngage.SetLastName("Doe");
// Set user email
WebEngage.SetEmail("john.doe@email.com");
// Set user hashed email
WebEngage.SetHashedEmail("144e0424883546e07dcd727057fd3b62");
// Set user phone number
WebEngage.SetPhoneNumber("+551155256325");
// Set user hashed phone number
WebEngage.SetHashedPhoneNumber("e0ec043b3f9e198ec09041687e4d4e8d");
// Set user gender, allowed values are ['male', 'female', 'other']
WebEngage.SetGender("male");
// Set user birth-date, supported format: 'yyyy-mm-dd'
WebEngage.SetBirthDate("1994-04-29");
// Set user company
WebEngage.SetCompany("Google");
// Set opt-in status, channels: ['push', 'in_app', 'email', 'sms']
WebEngage.SetOptIn("push", true);
// Set user location
double latitude = 19.0822;
double longitude = 72.8417;
WebEngage.SetLocation(latitude, longitude);
}
```
3. Set custom user attributes as shown below.
```csharp
using WebEngageBridge;
...
// Set custom user attributes
WebEngage.SetUserAttribute("age", 25);
WebEngage.SetUserAttribute("premium", true);
// Set multiple custom user attributes
Dictionary customAttributes = new Dictionary();
customAttributes.Add("Twitter Email", "john.twitter@mail.com");
customAttributes.Add("Subscribed", true);
WebEngage.SetUserAttributes(customAttributes);
```
4. Delete custom user attributes as shown below.
```csharp
using WebEngageBridge;
...
WebEngage.DeleteUserAttribute("age");
```
## Tracking Events
Track custom events as shown below.
```csharp
using WebEngageBridge;
...
// Track simple event
WebEngage.TrackEvent("Product - Page Viewed");
// Track event with attributes
Dictionary orderPlacedAttributes = new Dictionary();
orderPlacedAttributes.Add("Amount", 808.48);
orderPlacedAttributes.Add("Product 1 SKU Code", "UHUH799");
orderPlacedAttributes.Add("Product 1 Name", "Armani Jeans");
orderPlacedAttributes.Add("Product 1 Price", 300.49);
orderPlacedAttributes.Add("Product 1 Size", "L");
orderPlacedAttributes.Add("Product 2 SKU Code", "FBHG746");
orderPlacedAttributes.Add("Product 2 Name", "Hugo Boss Jacket");
orderPlacedAttributes.Add("Product 2 Price", 507.99);
orderPlacedAttributes.Add("Product 2 Size", "L");
orderPlacedAttributes.Add("Delivery Date", System.DateTime.ParseExact("2017-10-21 09:27:37.100", "yyyy-MM-dd HH:mm:ss.fff", null));
orderPlacedAttributes.Add("Delivery City", "San Francisco");
orderPlacedAttributes.Add("Delivery ZIP", "94121");
orderPlacedAttributes.Add("Coupon Applied", "BOGO17");
WebEngage.TrackEvent("Order Placed", orderPlacedAttributes);
// Track complex event
Dictionary product1 = new Dictionary();
product1.Add("SKU Code", "UHUH799");
product1.Add("Product Name", "Armani Jeans");
product1.Add("Price", 300.49);
Dictionary detailsProduct1 = new Dictionary();
detailsProduct1.Add("Size", "L");
product1.Add("Details", detailsProduct1);
Dictionary product2 = new Dictionary();
product2.Add("SKU Code", "FBHG746");
product2.Add("Product Name", "Hugo Boss Jacket");
product2.Add("Price", 507.99);
Dictionary detailsProduct2 = new Dictionary();
detailsProduct2.Add("Size", "L");
product2.Add("Details", detailsProduct2);
Dictionary deliveryAddress = new Dictionary();
deliveryAddress.Add("City", "San Francisco");
deliveryAddress.Add("ZIP", "94121");
Dictionary orderPlacedAttributes = new Dictionary();
List products = new List();
products.Add(product1);
products.Add(product2);
List coupons = new List();
coupons.Add("BOGO17");
orderPlacedAttributes.Add("Products", products);
orderPlacedAttributes.Add("Delivery Address", deliveryAddress);
orderPlacedAttributes.Add("Coupons Applied", coupons);
WebEngage.TrackEvent("Order Placed", orderPlacedAttributes);
```
## Push Notifications
#### 1. Using FCM Unity Plugin
1. Import FCM Unity plugin as instructed [here](https://firebase.google.com/docs/cloud-messaging/unity/client) into your Unity project.
2. If you have replaced the `Assets/Plugins/Android/AndroidManifest.xml` then make sure to add back your WebEngage license-code and debug-mode meta-data tags in the `AndroidManifest.xml` file.
3. In your script where you have registered callbacks for `OnTokenReceived` and `OnMessageReceived`, add the following code snippets.
```csharp
using WebEngageBridge;
...
Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWith(task => {
var dependencyStatus = task.Result;
if (dependencyStatus == Firebase.DependencyStatus.Available)
{
Firebase.Messaging.FirebaseMessaging.TokenReceived += OnTokenReceived;
Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;
}
else
{
...
}
});
public void OnTokenReceived(object sender, Firebase.Messaging.TokenReceivedEventArgs token)
{
...
WebEngage.SetPushToken(token.Token);
}
public void OnMessageReceived(object sender, Firebase.Messaging.MessageReceivedEventArgs e)
{
Dictionary data = new Dictionary(e.Message.Data);
if (data.ContainsKey("source") && "webengage".Equals(data["source"]))
{
WebEngage.SendPushData(data);
}
...
}
```
Push notifications will work as expected when app is in foreground.
**Note**: Drawback of this approach is that push notifications will not be shown when app is in background. However those push notifications are cached and will be shown on next app launch. If you wish to prevent this drawback, then follow the Overriding FCM Unity Plugin approach given below.
#### 2. Overriding FCM Unity Plugin
1. Import FCM Unity plugin as instructed [here](https://firebase.google.com/docs/cloud-messaging/unity/client) into your Unity project.
2. If you have replaced the `Assets/Plugins/Android/AndroidManifest.xml` then make sure to add back your WebEngage license-code and debug-mode meta-data tags in the `AndroidManifest.xml` file.
3. Download and add the [webengage-android-fcm.aar](https://github.com/WebEngage/webengage-unity-android/raw/master/webengage-android-fcm-0.0.1.aar) file in `Assets/Plugins/Android/` directory of your Unity project.
4. Add the following service tag in your `Assets/Plugins/Android/AndroidManifest.xml` file as shown below.
```xml
...
```
5. Update the FCM registration token on app start as shown below.
```csharp
using WebEngageBridge;
...
WebEngage.UpdateFcmToken();
```
## In-app Notifications
No additional steps are required for in-app notifications.
### Tracking Screens
```csharp
using WebEngageBridge;
...
// Set screen name
WebEngage.ScreenNavigated("Purchase Screen");
// Update current screen data
Dictionary currentData = new Dictionary();
currentData.Add("productId", "~hs7674");
currentData.Add("price", 1200);
WebEngage.SetScreenData(currentData);
// Set screen name with data
Dictionary data = new Dictionary();
data.Add("productId", "~hs7674");
data.Add("price", 1200);
WebEngage.ScreenNavigated("Purchase Screen", data);
```