Download the latest sdk version from our server:
ADDED
- The information about the player's device is sent to Game of Whales server.
FIXED
- Minor fixes.
ADDED
onConnectedcallback was added.
ADDED
- Supporting of "A/B Testing" was added.
ADDED
- GDPR support: the non-personal mode was added.
ADDED
onInitializedcallback was added. It should be used to get information that the SDK has been initialized.Purchasemethod was added to register purchases without verification.
- Minor fixes.
ADDED
- The supporting of future (anti-churn) special offers were added.
- The possibility of getting a profile's properties was added.
FIXED
- The issue with getting server time on 32-bit devices was fixed.
FIXED
- The handling of errors was improved.
- The selection of advertising (cross-promotion) images depending on the orientation of the device was fixed.
- The repeating of cross-promotion ads after some minutes was fixed.
ADDED
- The supporting of cross promotion ads was added.
ADDED
GetServerTimemethod was added to get GOW server time.- Server time is used in special offers to check the time for the activation.
ADDED
redeemableparameter was added toSpecialOfferclass.
ADDED
- Custom data is supported for special offers.
- The information about a device's locale is sent to Game of Whales.
ADDED
- getLeftTime method for special offers.
MODIFIED
-
Push notification about special offer comes at the same time with the special offer (new parameter offer was added):
void onPushDelivered(SpecialOffer offer, String campID, String title, String message); -
setPushNotificationsEnablemethod was added to allow user to turn off the push notifications. -
Added static methods instead of shared methods.
FIXED
- pushReacted sending with empty camp.
MODIFIED
- renamed "Reachability" class to "GWReachability".
FIXED
- bug with pushDelivered and pushReacted events for push campaigns.
FIXED
- bug with
OnPushDeliveredcallback for empty push notification campaign. - bug with redeemable once special offer: they could be used many times.
Add GameOfWhales.framework to Linked Frameworks and Libraries XCODE section of your project.
Load GameOfWhalesBundle.bundle file to your project.
Than add it to Build Phase -> Copy Bundle Resources.
Add GWGameKey parameter to info.plist and specify your game key.
Subscribe to onInitialized if you want to get information that the SDK has been initialized.
func onInitialized()
}
}Subscribe to onConnected. onConnected is called after the GOW server response with dataReceived: true. If there was no response from the GOW server, there was an error during the request to the server or the game is offline, dataReceived is false.
onConnectedcallback is supported since 2.0.32 version of SDK.
func onConnected(_ dataReceived: Bool)
{
}Call initialize method when you launch your app.
import GameOfWhales
...
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool
{
...
Bool debugLog = false;
GW.initialize( launchOptions, false);GDPR NOTE: By default, the SDK uses advertisement ID (IDFA) as a user ID to send events to Game of Whales server. In order to work in a non-personal mode when a random value will be used as a user ID, the SDK should be initialized as follows:
let nonPersonal = true;
let debugLog = true;
GW.initialize(withGameKey: "YOU_GAME_KEY", launchOptions, debugLog, nonPersonal);Purchases with verification on GOW server side
Check that iOS Bundle Identifier (for iOS app) has been filled on Game Settings page before you will make a purchase.
Register a purchase with purchaseTransaction method.
func paymentQueue(_ queue: SKPaymentQueue, updatedTransactions transactions: [SKPaymentTransaction]) {
for t in transactions
if t.transactionState == SKPaymentTransactionState.purchased
GW.purchaseTransaction(t, product: product!);Purchase without verification on GOW server side
The method is available since v.2.0.24 SDK version.
In order to send information about purchases without verification on Game of Whales side, call purchase method. For example:
let productID = "product_10";
let currency = "USD";
let price = 1.99;
GW.purchase(productID, currency, price * 100);Pay attention that all purchases received through
purchasemethod (including refunds, restores, cheater's purchases) will increase the stats. So in order to have correct stats, a game developer should verify purchases on the game side and send the data only about legal purchases to Game of Whales system.
Before any product can be used in a special offer it has to be bought by someone after SDK has been implemented into the game. Please make sure your game has at least one purchase of the product that is going to be used in the special offer. If you want to create a special offer for in game resource, please, make sure your game has at least one converting event with the appropriate resource.
If you want to use special offers, you need to implement some methods of GWDelegate protocol and call add method.
class ViewController: UIViewController, GWDelegate
...
override func viewWillAppear(_ animated: Bool) {
GWManager.add(self)
}
override func viewDidDisappear(_ animated: Bool) {
//remove self from delegates
GWManager.remove(self)Add the following methods:
func onPurchaseVerified(_ transactionID: String, state: String)
{
}
func specialOfferDisappeared(_ specialOffer: GWSpecialOffer)
{
}
func specialOfferAppeared(_ specialOffer: GWSpecialOffer)
{
}
func futureSpecialOfferAppeared(_ specialOffer: GWSpecialOffer)
{
}
func onPushDelivered(_ offer:GWSpecialOffer?, camp: String, title:String, message:String)
{
}The verify state can be:
- GW_VERIFY_STATE_LEGAL - a purchase is normal.
- GW_VERIFY_STATE_ILLEGAL - a purchase is a cheater's.
- GW_VERIFY_STATE_UNDEFINED - GOW server couldn't define the state of a purchase.
In order to receive a special offer call the following method:
let offer = GW.getSpecialOffer(productIdentifier);
if (offer != nil)
{ ...A special offer can influence a product's price:
if (offer?.hasPriceFactor())!
{
price = Int(Float(price) * (offer?.priceFactor)!);
}A special offer can also influence count (count of coins, for example) which a player receive by purchase:
if (offer?.hasCountFactor())!
{
coins = Int(Float(coins) * (offer?.countFactor)!);
}It's possible to pass custom data to special offers. In order to get the data in game's side, use customValues parameter of SpecialOffer class.
let str = offer.customValues.valueForKey("your_string") as? NSTring
let number = offer.customValues.valueForKey("your_number") as? NSNumber
let boolean = offer.customValues.valueForKey("your_bool") as? NSNumberEnable the Push Notifications option in the Xcode.
In order to send notifications from GOW server it is necessary to pass the token information to the server.
//FIREBASE
let token = FIRInstanceID.instanceID().token();
GW.registerDeviceToken(with: token!, provider:GW_PROVIDER_FCM);
//APN
func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
GW.registerDeviceToken(with: deviceToken, provider: GW_PROVIDER_APN)To get information about a player's reaction on notifications add the following methods to AppDelegate:
func application(_ application: UIApplication,
didReceiveRemoteNotification userInfo: [AnyHashable : Any],
fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void)
{
GWManager.receivedRemoteNotification(userInfo, with: application, fetchCompletionHandler: completionHandler);
}In order to send the information to Game of Whales regarding a player's reaction on a notification (to increase push campaign's Reacted field) of an already started app call the following method:
func onPushDelivered(_ offer:GWSpecialOffer?, camp: String, title:String, message:String) {
//Show message and call:
GW.reactedRemoteNotification(withCampaign: camp);In order to enable or disable push notifications, use the following method:
GW.setPushNotificationsEnable(false);In order to check notifications implementation send a test notification.
You can send additional data about your players by using the profile method. profile method should be called if key parameters of your app or a player have changed.
If you send more than 3000 properties, Game of Whales will sort all properties alphabetically and will save only the first 3000.
If the length of a string-type property is more than 64 characters, Game of Whales will save only the first 64 characters.
For example:
GW.profile(["coins":1000, "class":"wizard", "gender":true, "locatiom":"A"]);If you are going to use AI offers functionality you need to send to Game of Whales information about players' game activity by using сonverting method. сonverting method should be called to show what exactly the player spent and what he got instead of spent resources. Read more...
For example: Someone bought one bike_1 for 1000 coins and 50 gas. You should call the following method to reflect this operation in Game of Whales:
GW.converting(["coins":-1000, "gas":-50, "bike_1":1], place: "bank")Another sample: someone bought a main pack for $5. It was in-app purchase with mainPack SKU. The pack included 100 coins and 1 bike. In order to send the data that the player got 100 coins and 1 bike after the purchase of mainPack to Game of Whales, the following сonverting method should be called:
GW.converting(["bike": 1, "coin": 100, "mainPack": -1], place: "shop")There are 2 additional methods that can be used instead of converting method:
consume - to show that a player spends a certain amount of one resource for the purchase of a quantity of another resource.
For example:
GW.consumeCurrency("coins", number:1000, sink:"gas", amount:50, place:"shop")It means that someone spent 1000 "coins" for 50 "gas" in "shop".
acquire - to show that a player acquires a certain amount of one resource and spends a quantity of another resource. The method can be used for in-app and in game items. It's important to call acquire method after InAppPurchased.
GW.acquireCurrency("coins", amount:1000, source:sku, number:1, place:"bank")It means that someone has acquired 1000 "coins" for 1 "sku" in "bank".
consume and acquire methods can be called when one resource is changed to another resource. In more complicated cases (for example, when one resource is spent for several types of resources) converting method should be called.
It's supported since version 2.0.20 of SDK for iOS.
To handle the ads set in Game of Whales, you need to do some actions:
Subscribe to the following events to get the information about the current state of the ads by using GWDelegate (the same as you do it on Step 6):
func onAdLoaded()
{
}
func onAdLoadFailed()
{
}
func onAdClosed()
{
}Start to load the ads at any place of your code (for example, during the launch of the game):
GW.loadAd()Add the following code to the part of your game where you want to show the ads:
if (GW.isAdLoaded())
GW.showAd()
else
GW.loadAd()You can get some profile's properties defined on Game of Whales side via the SDK.
For example, you can get the profile's property group by using the following code:
let properties = GW.getProperties()
if (properties["group"] != nil)
{
let group = properties.objectForKey("group")
}You can also receive the profile's group by using the special method:
let group = GW.getUserGroup()It's supported since version 2.0.29 of SDK for iOS.
In order to start working with experiments, it's needed to add some methods:
In order to confirm that the experiment payload settings have been applied and the player should take part in the experiment, it's needed to return true:
func canStart(_ experiment: GWExperiment) -> Bool {
//Read experiment.payload, apply changes for experiment and return True if changes were applied
return true;
}In order to check if there is an experiment at the start of the application, subscribe to onConnected callback (see Step 3). If the experiment exists, canStart will be called before onConnected.
When the experiment is finished, OnExperimentEnded method will be called. You are able to remove all experiment changes or keep them for further work regardless of the experiment:
func onExperimentEnded(_ experiment: GWExperiment) {
//Disable experiment changes or keep them
}
# Objective-C
### Step 3
Subscribe to ```onInitialized``` if you want to get information that the SDK has been initialized.
```objective-c
- (void)onInitialized
{
}Subscribe to onConnected. onConnected is called after the GOW server response with dataReceived: true. If there was no response from the GOW server, there was an error during the request to the server or the game is offline, dataReceived is false.
onConnectedcallback is supported since 2.0.32 version of SDK.
- (void)onConnected:(BOOL) dataReceived
{
}Call initialize method when you launch your app.
#import <GameOfWhales/GameOfWhales.h>
...
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
...
BOOL debugLog = false;
[GW initialize:launchOptions :debugLog];GDPR NOTE: By default, the SDK uses advertisement ID (IDFA) as a user ID to send events to Game of Whales server. In order to work in a non-personal mode when a random value will be used as a user ID, the SDK should be initialized as follows:
BOOL nonPersonal = TRUE;
BOOL debugLog = TRUE;
[GW Initialize:launchOptions :debugLog :nonPersonal];Purchase with verification on GOW server side
Check that iOS Bundle Identifier (for iOS app) has been filled on Game Settings page before you will make a purchase.
Register a purchase with purchaseTransaction method.
- (void)paymentQueue:(SKPaymentQueue *)queue updatedTransactions:(NSArray *)transactions {
for(SKPaymentTransaction * t in transactions)
if (t.transactionState == SKPaymentTransactionStatePurchased)
[GW PurchaseTransaction:t product:product];
}Purchase without verification on GOW server side
The method is available since v.2.0.24 SDK version.
In order to send information about purchases without verification on Game of Whales side, call Purchase method. For example:
NSString *product = @"product_10";
NSString *currency = @"USD";
double price = 1.99;
[GW Purchase:product :currency :price];Pay attention that all purchases received through
Purchasemethod (including refunds, restores, cheater's purchases) will increase the stats. So in order to have correct stats, a game developer should verify purchases on the game side and send the data only about legal purchases to Game of Whales system.
Before any product can be used in a special offer it has to be bought by someone after SDK has been implemented into the game. Please make sure your game has at least one purchase of the product that is going to be used in the special offer. If you want to create a special offer for in game resource, please, make sure your game has at least one converting event with the appropriate resource.
If you want to use special offers, you need to implement some methods of GWDelegate protocol and call addDelegate method.
@interface ViewController : UIViewController<GWDelegate>
...
- (void)viewDidLoad {
[super viewDidLoad];
[GW AddDelegate:self];
}
- (void)viewDidDisappear:(BOOL)animated
{
[GW RemoveDelegate:self];
}
Add the following methods:
- (void)specialOfferAppeared:(nonnull GWSpecialOffer *)specialOffer
{
}
- (void)specialOfferDisappeared:(nonnull GWSpecialOffer *)specialOffer
{
}
- (void)futureSpecialOfferAppeared:(nonnull GWSpecialOffer *)specialOffer
{
}
- (void)onPushDelivered:(nullable GWSpecialOffer*) offer camp:(nonnull NSString *)camp title:(nonnull NSString*)title message:(nonnull NSString*)message
{
}
- (void)onPurchaseVerified:(nonnull NSString*)transactionID state:(nonnull NSString*)state
{
}The verify state can be:
- GW_VERIFY_STATE_LEGAL - a purchase is normal.
- GW_VERIFY_STATE_ILLEGAL - a purchase is a cheater's.
- GW_VERIFY_STATE_UNDEFINED - GOW server couldn't define the state of a purchase.
In order to receive a special offer call the following method:
GWSpecialOffer* so = [GW GetSpecialOffer:productIdentifer];
if (so != nil)
{
...
}
A special offer can influence a product's price:
if ([so hasPriceFactor])
{
price *= so.priceFactor;
}A special offer can also influence count (count of coins, for example) which a player receive by purchase:
if ([so hasCountFactor])
{
coins *= so.countFactor;
}It's possible to pass custom data to special offers. In order to get the data in game's side, use customValues parameter of SpecialOffer class.
NSString * str = [specialOffer.customValues objectForKey:@"your_str"];
NSNumber * number = [specialOffer.customValues objectForKey:@"your_int"];
NSNumber * boolean = [specialOffer.customValues objectForKey:@"your_bool"];Enable the Push Notifications option in the Xcode.
In order to send notifications from GOW server it is necessary to pass the token information to the server.
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
//FIREBASE
[GW RegisterDeviceTokenWithString:[[FIRInstanceID instanceID] token] provider:GW_PROVIDER_FCM];
//APN
[GW RegisterDeviceTokenWithData:deviceToken provider:GW_PROVIDER_APN];
}To get information about a player's reaction on notifications add the following methods to AppDelegate:
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo
fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler
{
[GW ReceivedRemoteNotification:userInfo withApplication:application fetchCompletionHandler:completionHandler];
}In order to send the information to Game of Whales regarding a player's reaction on a notification (to increase push campaign's Reacted field) of an already started app call the following method:
- (void)onPushDelivered:(nullable GWSpecialOffer*) offer camp:(nonnull NSString *)camp title:(nonnull NSString*)title message:(nonnull NSString*)message
{
//Show the notification to a player and then call the following method
[GW ReactedRemoteNotificationWithCampaign:camp];
}In order to enable or disable push notifications, use the following method:
[GW SetPushNotificationsEnable:false];In order to check notifications implementation send a test notification.
You can send additional data about your players by using the Profile method. Profile method should be called if key parameters of your app or a player have changed.
If you send more than 3000 properties, Game of Whales will sort all properties alphabetically and will save only the first 3000.
If the length of a string-type property is more than 64 characters, Game of Whales will save only the first 64 characters.
For example:
NSMutableDictionary *changes = [NSMutableDictionary dictionary];
changes[@"coins"] = @1000;
changes[@"class"] = @"wizard";
changes[@"gender"] = @TRUE;
changes[@"location"] = @"A";
[GW Profile:changes];If you are going to use AI offers functionality you need to send to Game of Whales information about players' game activity by using Converting method. Converting method should be called to show what exactly the player spent and what he got instead of spent resources. Read more...
For example:
Someone bought one bike_1 for 1000 coins and 50 gas. You should call the following method to reflect this operation in Game of Whales:
NSMutableDictionary *resources = [NSMutableDictionary dictionary];
resources[@"coins"] = @-1000;
resources[@"gas"] = @-50;
resources[@"bike_1"] = 1;
[GW Converting:resources place:@"bank"]Another sample: someone bought a main pack for $5. It was in-app purchase with mainPack SKU. The pack included 100 coins and 1 bike. In order to send the data that the player got 100 coins and 1 bike after the purchase of mainPack to Game of Whales, the following Converting method should be called:
NSMutableDictionary *resources = [NSMutableDictionary dictionary];
resources[@"coin"] = 100;
resources[@"bike"] = 1;
resources[@"mainPack"] = @-1;
[GW Converting:resources place:@"shop"]There are 2 additional methods that can be used instead of Converting method:
Consume - to show that a player spends a certain amount of one resource for the purchase of a quantity of another resource.
For example:
[GW ConsumeCurrency:@"coins" number:@1000 sink:@"gas" amount:@50 place:@"shop"];It means that someone spent 1000 "coins" for 50 "gas" in "shop".
Acquire - to show that a player acquires a certain amount of one resource and spends a quantity of another resource. The method can be used for in-app and in game items. It's important to call Acquire method after InAppPurchased.
For example:
[GW AcquireCurrency:@"coins: amount:@1000 source:sku number:@1 place:@"bank];It means that someone has acquired 1000 "coins" for 1 "sku" in "bank".
Consume and Acquire methods can be called when one resource is changed to another resource. In more complicated cases (for example, when one resource is spent for several types of resources) Converting method should be called.
It's supported since version 2.0.20 of SDK for iOS.
To handle the ads set in Game of Whales, you need to do some actions:
Subscribe to the following events to get the information about the current state of the ads by using GWDelegate (the same as you do it on Step 6):
- (void)onAdLoaded
{
}
- (void)onAdLoadFailed
{
}
- (void)onAdClosed
{
}Start to load the ads at any place of your code (for example, during the launch of the game):
[GW LoadAd];Add the following code to the part of your game where you want to show the ads:
if ([GW IsAdLoaded])
[GW ShowAd];
else
[GW LoadAd];You can get some profile's properties defined on Game of Whales side via the SDK.
For example, you can get the profile's property group by using the following code:
NSMutableDictionary * properties = [GW getProperties];
if (properties[@"group"])
{
NSString* group = properties[@"group"];
}You can also receive the profile's group by using the special method:
NSString * group = [GW GetUserGroup];It's supported since version 2.0.29 of SDK for iOS.
In order to start working with experiments, it's needed to add some methods:
In order to confirm that the experiment payload settings have been applied and the player should take part in the experiment, it's needed to return true:
- (BOOL) CanStartExperiment:(nonnull GWExperiment*) experiment
{
//Read experiment.payload, apply changes for experiment and return True if changes were applied
return true;
}In order to check if there is an experiment at the start of the application, subscribe to onConnected callback (see Step 3). If the experiment exists, CanStartExperiment will be called before onConnected.
When the experiment is finished, OnExperimentEnded method will be called. You are able to remove all experiment changes or keep them for further work regardless of the experiment:
- (void) OnExperimentEnded:(nonnull GWExperiment*) experiment
{
//Disable experiment changes or keep them
}You can find an example of using the SDK here.
Run your app. The information about it began to be collected and displayed on the dashboard. In a few days, you will get data for analyzing.
This article includes the documentation for Game of Whales iOS Native SDK. You can find information about other SDKs in documentation about Game of Whales.
To fix the error
NSErrorFailingURLStringKey The resource could not be loaded because the App Transport Security policy
requires the use of a secure connection.
make the following settings in info.plist:
