https://github.com/appsflyersdk/appsflyer-meta-quest2-unity-sample-app
https://github.com/appsflyersdk/appsflyer-meta-quest2-unity-sample-app
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/appsflyersdk/appsflyer-meta-quest2-unity-sample-app
- Owner: AppsFlyerSDK
- Created: 2023-08-17T15:58:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-14T08:35:49.000Z (about 1 year ago)
- Last Synced: 2025-01-23T17:57:18.608Z (4 months ago)
- Language: C#
- Size: 658 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
title: Meta Quest 2 Unity
parentDoc: 64e60f96a147a4004b5543e2
category: 6446526dddf659006c7ea807
order: 1
hidden: false
slug: meta-quest2-unity
---
> Link to repository
> [GitHub](https://github.com/AppsFlyerSDK/appsflyer-meta-quest2-unity-sample-app)
## AppsFlyer Meta Quest Unity SDK integration
Integrate your Meta Quest Unity app or game with AppsFlyer to measure the performance of campaigns marketing these apps.
Game attribution and user measurement require the game to integrate an AppsFlyer SDK that records first opens, sessions, and in-app events. For example, purchase events.
## Prerequisites
- Unity 2021.3.16f1
- The Oculus SDK: Follow the [Oculus SDK for Unity integration guide](https://developer.oculus.com/documentation/unity/unity-gs-overview/).
- Oculus Quest 2/3 Headset
## AppsflyerModule - Interface
`AppsflyerModule.cs`, included in the scenes folder, contains the required code and logic to connect to AppsFlyer servers and report events.
### AppsflyerModule
This method receives your API key, App ID, the parent MonoBehaviour and a sandbox mode flag (optional, false by default), and initializes the AppsFlyer Module.
**Method signature**
```c#
AppsflyerModule(string devkey, string appid, MonoBehaviour mono, bool isSandbox = false)
```
**Arguments**:
- `string DEV_KEY`: Get from the marketer or [AppsFlyer HQ](https://support.appsflyer.com/hc/en-us/articles/211719806-App-settings-#general-app-settings).
- `string QUEST_APP_ID`: Your Quest Store app ID. For Quest 2/3, this is the number in the store URL. For example: https://www.oculus.com/experiences/quest/XXXXXXXXXXXXXXXX/.
- `MonoBehaviour mono`: The parent MonoBehaviour.
- `bool isSandbox`: Flag that determines whether to activate sandbox mode. False by default. This option is for debugging. With the sandbox mode, AppsFlyer dashboard doesn't show the data.
**Usage**:
```c#
// for regular init
AppsflyerModule afm = new AppsflyerModule(<< DEV_KEY >>, << QUEST_APP_ID >>, this);
// for init in sandbox mode (reports the events to the sandbox endpoint)
AppsflyerModule afm = new AppsflyerModule(<< DEV_KEY >>, << QUEST_APP_ID >>, this, true);
```
### Start
This method sends first open/session requests to AppsFlyer.
**Method signature**
```c#
void Start(bool skipFirst = false)
```
**Arguments**
- `bool skipFirst`: Determines whether or not to skip first open events and send session events. The value is false by default. If true , first open events are skipped and session events are sent. [See example](#skipFirstExample)
**Usage**:
```c#
// without the flag
afm.Start();
// with the flag
bool skipFirst = [SOME_CONDITION];
afm.Start(skipFirst);
```
### Stop
This method stops the SDK from functioning and communicating with AppsFlyer servers. It's used when implementing user opt-in/opt-out.
**Method signature**
```c#
void Stop()
```
**Usage**:
```c#
// Starting the SDK
afm.Start();
// ...
// Stopping the SDK, preventing further communication with AppsFlyer
afm.Stop();
```
### LogEvent
This method receives an event name and JSON object and sends an in-app event to AppsFlyer.
**Method signature**
```c#
void LogEvent(
string event_name,
Dictionary event_parameters,
Dictionary event_custom_parameters = null
)
```
**Arguments**:
- `string event_name`: The name of the event.
- `Dictionary event_parameters`: Dictionary object that contains the [predefined event parameters](https://dev.appsflyer.com/hc/docs/ctv-log-event-event-parameters).
- `Dictionary event_custom_parameters`: [Optional] Dictionary object which contains the any custom event parameters.
**Usage**:
```c#
// set event name
string event_name = "af_purchase";
// set event values
Dictionary event_parameters = new Dictionary();
event_parameters.Add("af_currency", "USD");
event_parameters.Add("af_revenue", 12.12);
// send logEvent request
afm.LogEvent(event_name, event_parameters);
// send logEvent request with custom params
Dictionary event_custom_parameters = new Dictionary();
event_custom_parameters.Add("goodsName", "新人邀约购物日");
afm.LogEvent(event_name, event_parameters, event_custom_parameters);
```
### SetCustomerUserId
This method sets a customer ID that enables you to cross-reference your unique ID with the AppsFlyer unique ID and other device IDs. **Note**: You can only use this method before calling `Start()`.
The customer ID is available in raw data reports and in the postbacks sent via API.
**Method signature**
```c++
void SetCustomerUserId(string cuid)
```
**Arguments**:
- `string cuid`: Custom user id.
**Usage**:
```c++
AppsflyerModule afm = new AppsflyerModule(<< DEV_KEY >>, << QUEST_APP_ID >>, this);
afm.SetCustomerUserId("TestCUID");
afm.Start();
```
### IsInstallOlderThanDate
This method receives a date string and returns true if the game folder creation date is older than the date string. The date string format is: "2023-03-01T23:12:34+00:00".
**Method signature**
```c#
bool IsInstallOlderThanDate(string datestring)
```
**Arguments**:
- `string datestring`: Date string in `yyyy-mm-ddThh:mm:ss+hh:mm` format.
**Usage**:
```c#
// the creation date in this example is "2023-03-23T08:30:00+00:00"
bool newerDate = afm.IsInstallOlderThanDate("2023-06-13T10:00:00+00:00");
bool olderDate = afm.IsInstallOlderThanDate("2023-02-11T10:00:00+00:00");
// will return true
Debug.Log("newerDate:" + (newerDate ? "true" : "false"));
// will return false
Debug.Log("olderDate:" + (olderDate ? "true" : "false"));
// example usage with skipFirst -
// skipping if the install date is NOT older than the given date
bool IsInstallOlderThanDate = afm.IsInstallOlderThanDate("2023-02-11T10:00:00+00:00");
afm.Start(!IsInstallOlderThanDate);
```
### GetAppsFlyerUID
Get the AppsFlyer unique device ID. The SDK generates an AppsFlyer unique device ID upon app installation. When the SDK is started, this ID is recorded as the ID of the first app install.
**Method signature**
```c#
void GetAppsFlyerUID()
```
**Usage**:
```c#
AppsflyerModule afm = new AppsflyerModule(<< DEV_KEY >>, << QUEST_APP_ID >>, this);
afm.Start();
string af_uid = afm.GetAppsFlyerUID();
```
## Running the sample app
1. Open Unity hub and open the project.
2. Use the sample code in `AppsflyerScript.cs` and update it with your DEV_KEY and QUEST_APP_ID.
3. Add the AppsflyerScript to an empty game object (or use the one in the scenes folder).
4. Launch the sample app via the Unity editor and check that your debug log shows the following messages:
5. After 24 hours, the AppsFlyer dashboard updates and shows organic and non-organic installs and in-app events.
## Implementing AppsFlyer in your Meta Quest game
### Setup
1. Add the script from `Assets/AppsflyerModule.cs` to your app.
2. Use the sample code in `Assets/AppsflyerScript.cs` and update it with your `DEV_KEY` and `QUEST_APP_ID`.
3. Initialize the SDK.
```c#
AppsflyerModule afm = new AppsflyerModule(<< DEV_KEY >>, << QUEST_APP_ID >>, this);
```
6. [Start](#start) the AppsFlyer integration.
7. Report [in-app events](#logevent).
## Resetting the attribution
[Delete the PlayerPrefs data in the registry/preferences folder](https://docs.unity3d.com/ScriptReference/PlayerPrefs.html), or use the [PlayerPrefs.DeleteAll()](https://docs.unity3d.com/2020.1/Documentation/ScriptReference/PlayerPrefs.DeleteAll.html) function when testing the attribution in the UnityEditor.
