Unity integration · midroll ads
The WGSDK communicates between your Unity game and the browser. The package ships with ExampleScene.unity and MyGame.cs as references — drop them once you have your own integration working.
Install the WGPlayer Universal Tag
Before anything else, make sure the WGPlayer Universal Tag is in your game's index.html inside 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=" + location.hostname + "&wp=" + location.pathname + "&ws=" + location.search); </script>
Download the SDK and add it to Unity. The package contains example scenes and scripts.
To avoid ReferenceError: window is not defined, go to the Advanced section of project properties and set Use worker to No.
Import the Unity package
The archive contains a Unity package file. Import its contents into your game project.
Drag the WGSDK Prefab into your scene
From the Project panel, drag the WGSDK Prefab to your Hierarchy panel.
Configure WGSDK defaults
Update the WGSDK default values to fit your needs. If you're unsure, the defaults are safe.
In the image above, look at the Wee Goo Ad Manager (script) panel. Two options control behavior: Ad Interval and Show Ad Every N Events.
Ad Interval — when greater than 0, the Ads Manager automatically calls a midroll every N seconds. Useful for slower-paced games (e.g. chess) where setting this to 240 shows an ad every 4 minutes.
Show Ad Every N Events — postpones the ad display. Imagine a game with very short levels where the user restarts every 30 seconds: showing an ad every 30 seconds is awful UX, so this lets you show it once every N restarts (set to 2 to show every other call).
Bind a button to the WGSDK Prefab
Create a button and bind its click event to the WGSDK Prefab. This lets you call the GetAd function from a button click.
Show midroll using a button
Now you can use the WeeGooAdManager to display midroll ads from a button click.
Select the button in the Hierarchy panel and look at the Inspector panel — find the On Click area. Click the lower-right plus (+) sign to add a new action. Drag the WeeGooAdManager object from the Hierarchy panel into the On Click — None (object) field in the Inspector panel.
Click the No function dropdown, hover WeeGooAdManager, and click GetAd. In a real game, this could fire every Nth time a user clicks the next-level button.
The ad will only display in a live environment with a valid WGPlayer AFG implementation. To confirm the component is integrated, check the developer console in your browser.
Show midroll from a script
If you need to call the ad from an existing script, update it as shown below.
If Get Ad Every N Event is set to its default (5), the function PlayerHasDied needs to be called 5 times before an ad displays.
Whether you trigger the ad from a button or a script, the component automatically pauses and resumes the game based on the ad state.
Newer Unity versions
In newer versions of Unity the JavaScript initialization sequence in index.html has changed. Make sure you assign unityInstance to gameInstance:
// ... 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); }); }; // ...
