unityads

Stencyl Unity Advertising Extension (Openfl)

For Stencyl 3.4 9280 and above

Stencyl extension for “UnityAds” (http://unityads.unity3d.com) for iOS and Android. This extension allows you to easily integrate UnityAds on your Stencyl game / application. (http://www.stencyl.com)

Important!!

This Extension Required the Toolset Extension Manager https://byrobingames.github.io

unityadstoolset

Main Features

Video Support
Rewarded Video Support
Banner Support

GDPR Compliance
UnityAds will automatically present users with an opportunity to opt-out of targeted advertising. See https://unityads.unity3d.com/help/legal/gdpr

It is also possible to set the consent programmatically, use the set consent to YES/NO block. (see documentation and block section)

How to Install

To install this Engine Extension, go to the toolset (byRobin Extension Mananger) in the Extension menu of your game inside Stencyl.
toolsetextensionlocation
Select the Extension from the menu and click on “Download”

If you not have byRobin Extension Mananger installed, install this first.
Go to: https://byrobingames.github.io

Documentation and Block Examples

Step 1: If you don’t have an account, create one on https://operate.dashboard.unity3d.com

Step 2: Create an project and add your platfom (iOS/Andoid)

Step 3: Open Project and get your Game id of the Platform you work with. unityadspoject

Fill your Game id in the Toolset Manager
unityadsgameid

Step 4: Use the initialize UniAds block in when created event of your first (loading)scene.
initializeUnityAds

If your game is not live yet, enable Testads in the Toolset Manager, don’t forget to disable Testads when your uploading your game to the store.
unityadstestmode

Step 5: Open the Platform you work with (iOS or Android) and get your Integration Id of the placements your added.
In this example i use iOS platform:
The Integration Id of Ad Placement Video is video
The Integration Id of Ad Placement Rewarded Video is rewardedVideo,
make sure you have enabled the Rewarded Video.

Step 6: Show Video with placement id.
Show Unityads Video with placement id block,
unityadsshowvideo

Step 7: Show Rewarded Video. Show Unityads Rewarded Video with placement id block,
Create and Alert title and Message that ask the player if he wants to watch the Rewarded Video or not. If Alert title is empty no Alert box will show.
unityadsshowrewarded

Step 8: Can Show Ads Check if ads with placement id can be show , it return true when it can show and false if ads cannot be show.
unityadscanshow

Step 9: Callbacks
unityadscallbacks
Use the callback blocks in an Updated event in an if statement.
– did show
– is completed
– is skipped (Video only, Rewarded cannot be skipped)

Show Banner with PlacementId
unityshowbanner
Show the banner, by defeault at the bottom.

Hide Banner
unityhidebanner
Hide the banner.

Move Banner
unitymovebanner
Move the banner to top or back to bottom.

Banner Callbacks
unitybannercallbacks

Button Example:

Video ad:
unityadsexamplevideobutton

Rewarded ad:
unityadsexamplerewardedbutton

Set Consent
setconsent
This block is optional for UnityAds.
But if you want to set the consent programmatically you can use this block.
YES: Yes, i agree to personalized experience.
NO: No, I do not want personalized experience.
Go to https://unityads.unity3d.com/help/legal/gdpr for more information.

Get Consent
setconsent
Return true(YES) if consent is set to YES and return false(NO) when consent is set to NO.

If you want to check if a user is in Europe, you can use the “User is in Continetn: Europe” boolean block from https://byrobingames.github.io

Version History

2016-03-28 (0.0.1) First release
2016-04-26 (0.0.2) Single touch after dismiss Ad is now working.
2016-04-27 (0.0.3) Create an extra block to check if Ads are available.
2016-05-02 (0.0.4) Show an Alert box before showing Rewarded ad that ask if player want to watch rewarded video or not. (show Video block and show Rewarded are now 2 seperated blocks)
2016-05-04 (0.0.5) Added canShowad block and set Placement id block.
2016-10-02 (0.0.6)
- Updated iOS and Android SDK to 2.0.4
- Removed Set Placement ID block, this is not required in SDK 2.0.4
- Added placementid in Can Show Ads block.
- Verion 0.0.5 of byRobin Extension Manager is needed.
2016-10-06 (0.0.7) – Fix: Android export/publish game
2016-11-18 (0.0.8) – Updated for use with Heyzap Extension 2.7
2017-03-19 (0.0.9) – Updated to use with Heyzap Extension 2.9, Update SDK to iOS: 2.0.8 Android: 2.0.8, Added Android Gradle support for openfl4
2017-05-16(0.1.0) Update SDK to iOS: 2.1.0 Android: 2.1.0, Tested for Stencyl 3.5, Required byRobin Toolset Extension Manager
2018-12-26(0.1.1) Update SDK to iOS: 3.0.0 Android: 3.0.0, Add Banner Support Fix Android Stencyl 3.5
2019-01-05(0.1.2) Added a “set consent block” to set the consent programmatically.
2019-01-07(0.1.3) Added a “get consent block” to get the consent programmatically.
2019-09-29(0.1.4) Update SDK to iOS: 3.2.0 Android: 3.2.0, Android fix issue READ_PHONE_STATE

Submitting a Pull Request

This software is opensource.
If you want to contribute you can make a pull request

Repository: https://github.com/byrobingames/unityads

Need help with a pull request?
https://help.github.com/articles/creating-a-pull-request/

ANY ISSUES?

Add the issue on GitHub
Repository: https://github.com/byrobingames/unityads/issues

Need help with creating a issue?
https://help.github.com/articles/creating-an-issue/

Donate

Privacy Policy

http://unityads.unity3d.com

License

Author: Robin Schaafsma

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.