OneSignal Unity SDK

⚠️ Migration Advisory for current OneSignal customers

Our new user-centric APIs and v5.x.x SDKs offer an improved user and data management experience. However, they may not be at 1:1 feature parity with our previous versions yet.

If you are migrating an existing app, we suggest using iOS and Android’s Phased Rollout capabilities to ensure that there are no unexpected issues or edge cases. Here is the documentation for each:

iOS Phased Rollout

Google Play Staged Rollouts

If you run into any challenges or have concerns, please contact our support team at support@onesignal.com

A free email, sms, push notification and in app messaging solution for mobile applications built through Unity.

OneSignal provides a fully array of omni-channel messaging solutions across:

Push Notifications (mobile & web)
In App Messages
SMS
Email

And via many additional platforms. Check them all out!

Requirements
Push Notification Credentials
Installation
- Unity Asset Store
- Unity Package Manager
Platform Configuration
- iOS
- Android
Usage
- Initialization
API
Change Log
Support

Requirements

A OneSignal Account if you do not already have one
Your OneSignal App ID which you can find under Settings > Keys & IDs
Unity 2021.3 or newer
Android Builds: Target API Level 33 or higher
iOS Builds: CocoaPods 1.11.3 or newer
In order to test push notifications you will need
- An Android 5 or newer device or emulator with "Google Play Store (Services)" installed
- An iOS 11 or newer device (iPhone, iPad, or iPod Touch)

Push Notification Credentials

You must generate the appropriate credentials for the platform(s) you are releasing on:

iOS - Generate an iOS Push Certificate
Android - Generate a Google Firebase Server API Key
Amazon Fire - Generate an Amazon API Key

Installation

There are two methods of installation available for the OneSignal Unity SDK:

Upgrading from 2.x.x to 3.x.x?
Please check out our v2 to v3 migration guide.

Upgrading from 3.x.x to 5.x.x?
Please check out our v3 to v5 migration guide.

Unity Asset Store (click to expand)

Add the OneSignal Unity SDK as an available asset to your account by clicking Add to My Assets from our listing on the Unity Asset Store.
Find the package waiting for you to download by clicking Open in Unity from that same page. This will open the Unity Editor and its Package Manager window.
On the SDK's listing in the Editor click the Download button. When it finishes click Import.
A prompt to import all of the files of the OneSignal Unity SDK will appear. Click Import to continue and compile the scripts into your project.
Navigate to Window > OneSignal SDK Setup (or follow the popup if upgrading) in the Unity Editor which will bring up a window with some final steps which need to be completed in order to finalize the installation. The most important of these steps is Import OneSignal packages.

Depending on your project configuration and if you are upgrading from a previous version, some of these steps may already be marked as "completed"
After importing the packages Unity will notify you that a new registry has been added and the OneSignal SDK Setup window will have refreshed with a few additional steps. Following these will finalize your installation of the OneSignal Unity SDK.

Unity Package Manager (click to expand)

From within the Unity Editor navigate to Edit > Project Settings and then to the Package Manager settings tab.

Create a New Scoped Registry by entering

Name        npmjs
URL         https://registry.npmjs.org
Scope(s)    com.onesignal

and click Save.

Open the Window > Package Manager and switch to My Registries via the Packages: dropdown menu. You will see all of the OneSignal Unity SDK packages available on which you can then click Install for the platforms you would like to include. Dependencies will be added automatically.
Once the packages have finished importing you will find a new menu under Window > OneSignal SDK Setup. Open it and you will find some final steps which need to be completed in order to finalize the installation.

Depending on your project configuration and if you are upgrading from a previous version, some of these steps may already be marked as "completed"

Platform Configuration

iOS

After building in Unity and exporting the XCode project follow these steps:

To open your project ensure that you use the .xcworkspace file and not the .xcodeproj to open the project.
Click on the Unity-iPhone project and its similarly named target and select the Signing & Capabilities tab.
From here check Automatically manage signing, on the prompt click Enable Automatic, and select your Team.
Scroll down to App Groups and click on the refresh button.

NOTE: You may have to press this a few times as it will ask you for each signing type.
Repeat the same steps above but for the OneSignalNotificationServiceExtension target this time.
App Groups should now be provisioned for you going forward for your iOS bundle id, even on clean builds.
Make sure all Targets have Enable Bitcode set to No in Build Settings.

Android

From the Unity Editor, navigate to Edit > Project Settings > Player and click the Android settings tab.
Expand Publishing Settings and enable:
- Custom Main Gradle Template
- Custom Gradle Properties Template
Navigate to Assets > External Dependency Manager > Android Resolver > Force Resolve and resolve your Android dependencies.

Most of the Android setup was already handled during installation!

The only thing remaining is to setup your own notification icons. You can do this be replacing the example icons located at Assets/Plugins/Android/OneSignalConfig.androidlib/src/main/res with your own. There is a complete guide for this in the plugin's README. See our Customize Notification Icons page for additional details.

Usage

You can find a complete implementation in our included example MonoBehaviour. Additionally we have included a sample scene which you can run to test out the SDK.

Initialization

Prefab

Located in the com.onesignal.unity.core package we've include a simple prefab which initializes OneSignal. You can easily find it using the Asset search bar to find OneSignalController.prefab and making sure to select All or In Packages for your search option. Drag the prefab into your very first scene, fill in the App Id, and you are immediately ready to go!

Code

To get started add the following code in an appropriate place such as the Start method of a MonoBehaviour early in your application's lifecycle.

// Replace 'YOUR_ONESIGNAL_APP_ID' with your OneSignal App ID from app.onesignal.com
OneSignal.Initialize("YOUR_ONESIGNAL_APP_ID");

You are now ready to start sending and receiving notifications and in-app messages. For additional information please see our complete OneSignal Unity SDK docs.

API

See OneSignal's OneSignal SDK Reference page for a list of all available methods.

Change Log

See this repository's releases for a complete change log of every released version.

Support

Please visit this repository's Github issue tracker for feature requests and bug reports related specifically to the SDK.

For account issues and support please contact OneSignal support from the OneSignal dashboard.

License

Modified MIT License

OneSignal/OneSignal-Unity-SDK