Integration

Package Contents

Pre-configured NimbusAdsManager GameObject that returns Nimbus test ads

NimbusAdsManager.prefab

Packages/Ads By Nimbus/Runtime/NimbusManagerPrefabs

Pre-configured NimbusSDKDevExample scriptable object that enables test mode for the NimbusAdsManager GameObject

NimbusSDKDevExample.asset

Packages/Ads By Nimbus/Runtime/Scripts/Nimbus.ScriptableObjects

UnityThread MonoBehavior helper that allows unity coroutines to be called inside of callback events not on the Unity Main

UnityThread.cs

Packages/Ads By Nimbus/Runtime/Scripts

Package Installation

From GIT URL

Most Recent Version:

https://github.com/adsbynimbus/nimbus-unity.git?path=/com.adsbynimbus.nimbus#1.1.1 From the nimbus-unity repository and see Unity's official guide on how to install from local files.

Unity - Manual: Installing from a Git URL

1. Open the Unity Package Manager

2. Click On the + on the top left of the Package Manager

3. Select Add package from git Url

   
4. Paste in the git package path (https://github.com/timehop/nimbus-unity.git?path=/com.adsbynimbus.nimbus) to install the most recent code from the main branch and hit add

   

To specify an official release version Head to the nimbus-unity releases page on Github and pick a version https://github.com/adsbynimbus/nimbus-unity.git?path=/com.adsbynimbus

Local Installation

From the nimbus-unity repository and see Unity's official guide on how to install from local files.

https://docs.unity3d.com/Manual/upm-ui-local.html

1. Head to the nimbus-unity releases page on Github

2. Download the latest nimbus-unity-package.zip release located in the Assets section and unzip

3. Unzip the nimbus-unity-package.zip file and place it within a directory that will not be deleted as Unity will symbolically link to it.

4. Open the Unity Package Manager

5. Click On the + on the top left of the Package Manager

6. Navigate into the unzipped folder and open the package.json file

7. The Ads by Nimbus package will now be located within the Unity Packages Section

Initialization

Within the Ads By Nimbus package, navigate to Packages/Ads By Nimbus/Runtime/NimbusManagerPrefabs and drag and drop the NimbusAdsManager.prefab into your scene. The Nimbus SDK is automatically initialized on Awake.

There should only ever be 1 instance of this GameObject in your scene hierarchy. The NimbusAdsManager is a Singleton set to DoNotDestroy. The NimbusAdsManager will not return ads in Editor mode. Ads will only be returned on Android or iOS builds.

Configuring the NimbusAdManager

All configurations are done through scriptable objects. The NimbusAdsManager.prefab provided already has a predefined scriptable object of type NimbusSDKConfiguration attached to it. The pre-configured scriptable object allows for Nimbus test ads to be returned.

In order to receive production ads a new Publisher Key and Api Key will be given to your team by the Nimbus team when integration and testing has been completed.

Credentials can be updated either by updating the values in the NimbusSDKDevExample scriptable object. Duplicating the NimbusSDKDevExample and relabeling is recommended. E.g. NimbusSDKProductionConfig.asset. Likewise, new NimbusSDKConfiguration assets can be created using the context menu by right clicking in your project view and selecting Create/Nimbus/Create SDK Configuration

Or by using the Nimbus Toolbar.

Do not forget to assign the correct NimbusSDKConfiguration.asset to the NimbusAdsManager GameObject