Advertising

The Advertising plugin is specifically designed to manage the application's advertisement features, especially Rewarded Adverts through the PlayFab service, for games built using Construct 3 and Construct 2.


The plugin allows you to manage, track (analytics) and claim items in the PlayFab Economy for players when rewarded through completion in watching advertisements.


The Advertising plugin is compatible with all Construct Master Collection's advertisement plugins, for all platforms including Web, Android and iOS.

PlayFab API v2.png

Introduction

Step 1.png

The Construct Master Collection supports the full and easy integration of the PlayFab service for both Construct 3 and Construct 2.


Please click here to learn more about PlayFab.

Features


Here are some of the features of the PlayFab service:

  • Rewarded Advertisements Integration

  • Economy Integration

  • Advertisement Rewards

  • Player Item Claim

  • Player Statistic Claim

  • Player Currency Claim

  • Advertisement Placements

  • Advertisement Segments

  • Reward Limits

  • Advertisement Reporting

  • Attribution


For more information about all the integrated PlayFab service features, please click here to learn the introductory lessons to PlayFab.


Network Services


Here are some of the platform services that can be linked:

  • PlayFab

  • Google Play

  • Game Center

  • Facebook

  • Facebook Instant Games

  • Steam

  • Xbox Live

  • Instant Games (Android Studio port)

  • Nintendo Switch (3rd party porting services)

  • PS4 (3rd party porting services)

  • Nintendo Switch (3rd party porting services)


Editor Features


Here are some of the features in the Construct editor:

  • All platforms support, including web, mobile and desktop.

  • Construct 3

  • Construct 2

 
 

How to use?

It is easy to use the Advertising plugin, you will only need to follow the steps below.

  1. Set up the PlayFab API plugin, please click to visit the documentation. This includes creating a PlayFab account, studio and title.

  2. Set up the Authentication plugin, please click to visit the documentation.

  3. Finally, you can now use the Advertising object, and include more PlayFab addons for more features.


 
 

Documentation

There is currently nothing to show, we will add more in the future.



Server Configuration



To integrate rewarded advertisements.

  1. Login to your PlayFab account.

  2. Choose a studio and select the title you want to enable adding and/or subtracting virtual currencies.

  3. From the sidebar, select the settings icon.

  4. Then, click the Title Settings option.

  5. From the Title Settings page, select the API features tab.

  6. Under the Enable API Features section, check the following checkboxes.

  • Allow client to add virtual currency

  • Allow client to subtract virtual currency



Related Plugins


  • Mobile IronSource Collection - is a plugin collection that implements IronSource advertisements with ad-network mediation or advert bidding with other ad-networks including Google Admob, Facebook Audience Network, Unity Ads, and 20+ other most popular and competitive ad-networks. The Mobile IronSource Collection is written natively from scratch using both the Android SDK and iOS SDK of each ad-network including ironSource, and developed in mind solely for Construct 3 integration. The Mobile IronSource Collection is designed for optimal advertisement delivery on mobile for Construct 3.

  • Google Admob Collection - is a plugin collection that implements Google Admob advertisements. It is a completed version of the Mobile Advert with complete features, while remaining easy to use.

  • Google Ads (Web H5) - is a plugin that implements HTML5 Games Ads with Google AdSense. Google Ads plugin supports web, mobile web including Google Admob, and desktop web.

 

Actions, Conditions & Expressions

Actions

press to zoom

press to zoom
1/1

The following action groups:

  • General

  • Advert

General

  • Attribute Install - Attribute an install for advertisement.

  • Adid - The adid for this device.

  • Idfa - The IdentifierForAdvertisers for iOS Devices.


  • Get Placements - Request a list of ad placements and a reward for each.

  • App Id - The current application id to use.

  • Tag - Tag to differentitate requests.


  • Get Placement - Request an ad placement and its reward.

  • App Id - The current application id to use.

  • Id - Id Identifier, if present.

  • Name - Name Identifier, if present.

  • Tag - Tag to differentitate requests.



Advert

  • Report Advert - Report an advertisement state.

  • Placement Id - Unique ID of the placement to report for.

  • Reward Id - Unique ID of the reward the player was offered.

  • Activity - Type of activity, may be Opened, Closed, Start or End.

  • Tag - Tag to differentitate requests.


  • Plan Custom Tag - The optional custom tags associated with the next request (e.g. build number, external trace identifiers, etc.).

  • Key - The key of this custom tag.

  • Value - The value of this custom tag.


  • Reward Player - Grant a reward to the player after completely watching an advertisement.

  • Placement Id - Placement unique ID

  • Reward Id - Reward unique ID

  • Tag - Tag to differentitate requests.

Conditions

The following condition groups:

  • General

  • Advert

  • Placement

  • Reward

press to zoom

press to zoom

press to zoom
1/2

General

  • Compare Tag - Compare the tag value of the current request.

  • Comparison - Select the way to compare the tag value.

  • Tag - Enter the value to compare.


  • On Attribute Installed - Trigger fires when attribute installation has completed successfully.


  • On Attribute Install Failed - Trigger fires when attribute installation has failed.



Advert

  • On Rewarded - Trigger fires when the advertisement rewards have been granted to the player.

  • Tag - Enter the tag to differentiate requests.


  • On Advert Reported - Trigger fires when an advertisement state has been reported.

  • Tag - Enter the tag to differentiate requests.


  • On Any Rewarded - Trigger fires when the advertisement rewards have been granted to the player.


  • On Any Advert Reported - Trigger fires when an advertisement state has been reported.


  • On Reward Failed - Trigger fires upon failure to grant the player rewards.

  • Tag - Enter the tag to differentiate requests.


  • On Advert Report Failed - Trigger fires upon failure to report the advertisement state.

  • Tag - Enter the tag to differentiate requests.


  • On Any Reward Failed - Trigger fires upon failure to grant the player rewards.


  • On Any Advert Report Failed - Trigger fires upon failure to report the advertisement state.



Placement

  • On Get Placements - Trigger fires when the placements are successfully retrieved from the server.

  • Tag - Enter the tag to differentiate requests.


  • On Any Get Placements - Trigger fires when the placements are successfully retrieved from the server.


  • For Each Placement - Loops through all the received placements from the server.


  • On Get Placements Failed - Trigger fires upon failure to retrieve the placements from the server.

  • Tag - Enter the tag to differentiate requests.


  • On Any Get Placements Failed - Trigger fires upon failure to retrieve the placements from the server.



Reward

  • For Each Item - Loops through all the granted reward items from the server.


  • For Each Currency - Loops through all the granted currencies from the server.


  • For Each Statistic - Loops through all the granted and incremented statistics from the server.

Expressions

press to zoom

press to zoom

press to zoom

press to zoom
1/3

The following expression groups:

  • General

  • Placement

  • Reward

  • Reward (Items)

  • Reward (Currencies)

  • Reward (Statistics)

  • Server

General

  • Tag - The tag to differentiate requests.



Placement

  • PlacementId - Return the placement unique id.

  • Index - The index of the placement to get from the placement list.


  • PlacementCount - Return the number of placements received from the server.


  • PlacementIndex - Return the current placement index of the 'For each placement'.


  • PlacementName - Return the placement name.

  • Index - The index of the placement to get from the placement list.


  • PlacementViewsRemaining - If placement has viewing limits indicates how many views are left. -1 if inapplicable.

  • Index - The index of the placement to get from the placement list.


  • PlacementAssetUrl - Returns the optional URL to a reward asset.

  • Index - The index of the placement to get from the placement list.


  • PlacementViewsReset - If placement has viewing limits, this indicates when they will next reset, in minutes. -1 if inapplicable.

  • Index - The index of the placement to get from the placement list.


  • PlacementRewardDescription - Returns the reward description.

  • Index - The index of the placement to get from the placement list.


  • PlacementRewardId - Returns the reward unique id.

  • Index - The index of the placement to get from the placement list.


  • PlacementRewardName - Returns the reward name.

  • Index - The index of the placement to get from the placement list.


  • Placements - Return the requested placements from the server, in JSON string.



Reward

  • RewardDebugResults - Return the debug results from the grants, in an array in JSON string.


  • RewardPlacementName - Return the name of the placement the reward was for.


  • RewardPlacementId - Return the id of the placement the reward was for.


  • RewardEventId - PlayStream Event ID that was generated by this reward (all subsequent events are associated with this event identifier).


  • RewardViewsReset - If placement has viewing limits, this indicates when they will next reset, in minutes. -1 if inapplicable.


  • RewardViewsRemaining - If placement has viewing limits indicates how many views are left. -1 if inapplicable.


  • Rewards - Return the rewards, all the granted items, currencies and incremented statistics, in JSON string.


  • RewardGrantedItems - Return the granted items, in JSON string.


  • RewardGrantedCurrencies - Return the granted virtual currencies, in JSON string.


  • RewardIncrementedStatistics - Return the granted virtual currencies, in JSON string.



Reward (Items)

  • RewardItemsCount - Return the number of granted items from the reward.


  • RewardItemIndex - Return the current item index of the 'For each item'.


  • RewardItemId - Return the item id of a reward, from an index.

  • Index - The index of the reward to get from the reward items list.


  • RewardItemInstanceId - Return the item instance id of a reward, from an index.

  • Index - The index of the reward to get from the reward items list.


  • RewardItemCatalogId - Return the item catalog id of a reward, from an index.

  • Index - The index of the reward to get from the reward items list.


  • RewardItemDisplayName - Return the item display name of a reward, from an index.

  • Index - The index of the reward to get from the reward items list.



Reward (Currencies)

  • RewardCurrenciesCount - Return the number of granted currencies from the reward.


  • RewardCurrenciesKeys - Return the list of granted currency keys from the reward, separated by a comma (",").


  • RewardCurrencyKey - Return the current currency key of the 'For each currency'.


  • RewardCurrencyValue - Return the current reward's currency value from a specified currency key.

  • Key - The key of the rewarded currency.



Reward (Statistics)

  • RewardStatisticsCount - Return the number of granted and incremented statistics from the reward.


  • RewardStatisticsKeys - Return the list of granted and incremented statistics from the reward, separated by a comma (",").


  • RewardStatisticKey - Return the current statistic key of the 'For each statistic'.


  • RewardStatisticValue - Return the current reward's incremented statistic value from a specified statistic key.

  • Key - The key of the rewarded and incremented statistic.



Server

  • ServerResponse - Return the latest "Server Response" data from the PlayFab server. The server response can also be shown on the Chrome Developer Tools' console, if in "debug mode".

Object   Properties

Plugin Properties

1/0
 
 

Showcase

There is currently nothing to show, we will add more in the future.

 

Game Projects 

Instructions Kit

Construct 3 Project
Construct 3 Project

press to zoom
Construct 2 Project
Construct 2 Project

press to zoom
Construct 3 Project
Construct 3 Project

press to zoom
1/2

Specifications

  • Instructions - The game project contains instructions and steps on how to use the addon and its features.

  • Action, Conditions and Expressions - It covers the implementation of each action, condition and expression.

  • Tips and Tricks - It provides some tips and tricks on the recommended ways of using the addon.

Supporters

Only