Unity integration, midroll
WeeGoo Unity implementation guide for Midroll and Reward Ads.
In order to display the midroll / reward ads in Unity games you need to use a class which will facilitate the communication between the Unity game and the browser.
For this purpose we’ve developed such class to make it easier for you to achieve this. The ExampleScene.unity and MyGame.cs files from package are provided only as examples, to get you started and have a refference to a woking example. You should remove them from your project when they are no longer needed.
Before everything else, please make sure that the WGPlayer Universal Tag is present in the index.html file of your game, in the HEAD section.
//WG Universal Tag
<script type="text/javascript" async>!function(e,t){a=e.createElement("script"),m=e.getElementsByTagName("script")[0],a.async=1,a.src=t,m.parentNode.insertBefore(a,m)}(document,"https://universal.wgplayer.com/tag/?lh="+window.location.hostname+"&wp="+window.location.pathname+"&ws="+window.location.search);</script>Download the SDK and add it to Unity, in the package you will find example scenes and scripts.
To avoid the error "ReferenceError: window is not defined" please go to "Advanced" section of project properties and select "No" to "Use worker".
Step 1
In the archive you will find a Unity package file. Please import it’s content into your game project. Refer to the image below to get an overview idea:
Step 2
From the Project panel drag the WGSDK Prefab to your Hierarchy panel
Step 3
Update the WGSDK default values with ones fitting your needs, if you are unsure you can safely leave them to defaults values.
In the image above, please see the “Wee Goo Ad Manager ( script )” panel
There are two options there that will configure the behaviour of the Ads Manager plugin: “Ad Interval” and “Show Ad Every N Events”
The Ad Interval is an option that when greater than 0 will enable the Ads Manager to automatically call the midroll ad every n seconds you completed the field. This would be helpful in a not so dynamic game, let’s say a chess game. You can set Ad Interval to let’s say 240 seconds and an ad will be displayed every 4 minutes.
The “Show Ad Every N Event” is an option that gives you the ability to postpone the ad display. Let’s imagine a game with very short levels where the user restarts the level every 30 seconds and you need to display the midroll when the user looses the level
It would create a very poor user experience to show the ad every 30 seconds, so, with this option, you can choose to actually show the ad just once for every 2 ad calls ( if you add 2 to this field ).
Moving on to the next step to see how you can call the ad from a button interaction, or from any script.
Step 4
Create a button and bind the click event to WGSDK Prefab, this will allow you to call the GetAd function within WGSDK by clicking the button.
Step 5 - show midroll using button
Now you can use the WeeGooAdManager to display Midroll ads as a result of button interaction or script call
Select (click) the button in the Hierarchy panel and take a peek in the Inspector panel. You will see the button details. Notice the “On Click” area. Click the lower right Plus (+) sign to add a new action. From the Hierarchy panel you need to drag the “WeeGooAdManager” object and drop it in the On Click - None ( object) button’s area from the Inspector panel.
Once your panel looks like in the image below, we can go on to the next step
Click on the “No function” drop down, hover the WeeGooAdManager option, follow the new submenu and click on GetAd option.
Take a look at the image below to get an idea, we’re going to use a button to exemplify the functionality of “Get Ad Every N Event” parameter usage and behaviour. In a real game scenario situation this could happen every N times a user clicks the next level button.
Please note that the ad will be displayed only in a live environment, within a valid WGPlayer AFG implementation. For confirmation about the component integration you can take a look in the web developer console tab of your web browser.
Step 5 - show midroll by script call, no button
Now, let’s imagine you need to call an ad from an existing script and you need to update it accordingly. Take a look to the next screen shot:
If the “Get Ad Every N Event” has still the default value ( 5 ) then the function “PlayerHasDied” needs to be called 5 times in order to display the ad.
Regardless you use this component to call an ad from a button or script, it will pause and resume the game according to the current state of the ad. Enjoy!
Final note
In the newer versions of Unity the JavaScript initialization sequence from index.html file has changed. Please make sure you assign the unityInstance to gameInstance variable like below:
//WG Universal Tag
...
var gameInstance; //Define the gameInstance variable here
script.onload = () => {
createUnityInstance(canvas, config, (progress) => {
spinner.style.display = "none";
progressBarEmpty.style.display = "";
progressBarFull.style.width = `${100 * progress}%`;
}).then((unityInstance) => {
gameInstance = unityInstance; //make sure to have this assignment
loadingCover.style.display = "none";
if (canFullscreen) {
if (!hideFullScreenButton) {
fullscreenButton.style.display = "";
}
fullscreenButton.onclick = () => {
unityInstance.SetFullscreen(1);
};
}
}).catch((message) => {
alert(message);
});
};
...
