Firstly, a reminder that we are on reduced support availability over the holidays while our team spends some well-earned time with their families (Dec 24th, 2015 – Jan 4th, 2016).  The servers of course will still be fully monitored, and we’re definitely still available to respond to emergencies.

This being our holiday release, we thought we’d try to finish off the year by focusing on a few more customer requests. There’s something in here for everyone!

Release Highlights

Key features of this release include:

• Profanity Filter API + WebPurify Integration – we’ve had several requests from developers to support profanity filtering in the platform. Although simple enough in concept, profanity filtering gets pretty complicated when you start taking into account multiple languages, custom whitelists and blacklists, identifying vs. replacing profane strings, etc. We’ve addressed this in two parts – we’ve added a new abstract Profanity Filter API to brainCloud, and partnered with the good folks at WebPurify to allow you to easily add profanity filtering to your apps.
• User Export [Beta] – we’ve always said that brainCloud’s data is your data – and we happily provide custom exports when requested. That said, it’s a lot more efficient to provide a way for you to export your user data yourself – which is of course what our new User Export feature is for. So, whether you are looking to do some additional analytics analysis, or maybe import your user e-mails into a mailing list platform – brainCloud now supports exporting the data you need in both .CSV and .JSON formats.
• Idle timeouts – we’ve refactored how the Design Portal handles user timeouts. To start, we’ve extended the timeout to 1 hour (from 20 minutes) – but we’ve also added a dialog to warn you that the session is about to timeout, and to definitely tell you once you have timed out. We’re much happier with the new system. Let us know what you think.

Portal Changes

Changes to the portal:

• WebPurify Integration settings – can be found in Design | Integrations | Manage Integrations. You simply enter the WebPurify API key, and choose what languages to filter on. Note that you can choose to automatically filter the user’s name field. If selected, brainCloud will automatically filter all calls to UpdatePlayerName() – and raise an exception if the name contains profanity. You can get a WebPurify account for as little as $15 / month at www.webpurify.com. Note that for brainCloud billing purposes, calls to WebPurify are counted as an external web service API call.
• Refresh button in Custom Files – we now cache the list of custom files, so we no longer have to access the file system to retrieve the directory.  This cache is updated each time a new file is added or deleted – but should you have reason to think that it’s out-of-date, just hit the [Refresh File List] button on the Design | Custom Config |  Files page.
• Export User Data – available under Reporting.  You can specify some filter criteria for which users to export, as well as select what types of data to include. We support both .CSV and .JSON file formats. Note – there are more data options associated with the JSON format (since it’s more flexible).
• Web Idle Timer – we’ve refactored how the web portal handles user timeouts. We’ve extended them timeouts, added better activity tracking, and improved the communication of when the session has expired. Let us know what you think.

API Changes / Additions

Changes and additions to the API:

• Profanity Filter API – There are 3 key methods for the Profanity Filter API – ProfanityCheck() returns true if foul language is found; ProfanityReplaceText() will actually replace bad words with a substitution character that you provide; and ProfanityIdentifyBadWords() returns a list of the bad words found (mostly useful for debugging). Remember, you need to set up a WebPurify() account to enable these APIs.
• Player State JSON enhancements – we’ve enhanced our Authentication and ReadPlayerState() calls to return additional user data – basically all the info that is displayed in the User Summary page of User Monitoring. So in addition to the slew of data that was already being returned, you now get emailAddress, createdAt, lastLogin, previousLogin, language, timezoneOffset, amountSpent (in cents) and refundCount.  Note that amountSpent refers to the reference price that you specify in the IAP entries, and is not a precise estimate of what a user paid, since it doesn’t take into account currency exchanges, the platform’s take, etc.

Miscellaneous Changes / Fixes

Additional improvements to this release:

• Big performance boost to GetFileList() and GetUpdatedFiles().  We now cache the data instead of reading from the file system each time – so performance is now approximately 3 times faster!
• brainCloud is now available directly from the Unity Asset Store!  (The brainCloud Bombers and brainCloud Space Shooter example games are there too!)  Feel free to drop by and give us a review! 
• All client libraries have been updated with the latest APIs
• Misc defect and performance fixes

Release Highlights

This release marks the debut appearance of a key roadmap item for brainCloud – our DataStream Architecture. Currently in beta, the concept behind DataStream is to enable a meaningful flow of data and events from your apps to value-added tools. And to do this as painlessly as possible – i.e. little to no client code – leveraging the data and server-side interactions that brainCloud already knows about.

DataStream is being implemented with the concept of extensible channels – which will be used to enable a great variety of integrations.

Our first channel is a doozy – Segment.com.  Connecting to Segment instantly gives us over 100 service integrations – including MixPanel, Google Analytics, Heap, Treasure Data and more.  There’s even support for generic webhooks.

Trying out DataStream is very simple. To do so:

• Register for a free Segment Developer account, and create a project to use
• Go to the brainCloud portal, and enter the Segment project information in the new Design | Integration section
• Optionally connect another service to Segment – like MixPanel, Google Analytics, etc.

That’s it – once you do this brainCloud will immediately begin sending the following events:

• Identify – contains base information (like profile id, name, e-mail etc) about a user interacting with Segment. Sent before we send any other events associated with that user.
• Login – triggered when a user logs in (via the Authenticate API)
• Register – triggered when a new user account is created (via the Authenticate API)
• RecordedScore – triggered when a user posts a score to a leaderboard
• LevelledUp – triggered when a user gains an experience level
• AwardedAchievement – triggered when a user is awarded an achievement
• AwardedMilestone – triggered when a user is awarded a milestone
• AwardedQuest – triggered when a user is awarded a quest
• WasSentNotification – triggered when a remote push notification was sent to the user
• CompletedOrder – triggered when a user completes an IAP purchase

In addition, your app can send custom events of it’s own (from the client or via Cloud Code).  There is a new DataStream service with three methods to support this:

• CustomTrackEvent – used to track custom user behaviours throughout your app – for example, a puzzle game might record “RoundStarted” with information on what round the user is playing, and what boosts they’ve selected for the round, together with a “RoundCompleted” event that summarizes the results. CustomTrackEvent() takes as parameters the name of the event, and set of custom key+value pairs for attributes.
• CustomScreenEvent – used to record that the user i
• CustomPageEvent – same as the above, but oriented toward web pages

Billing note – in addition to the regular tracking of API calls, each event sent out on a DataStream Channel counts as an additional API count.

We are very excited about the new possibilities that DataStream opens up for brainCloud apps – give it a try and send us feedback!

Additional Highlights

Additional features of this release include:

• Push Notification refactoring– we’ve refactored our push notification support to make it more efficient and reliable. Although none of the existing Client APIs have changed, you’ll notice:
  • Device tokens now expire after a settable period of time. This helps to keep all tokens recent and reliable, and also to ensure you’re not wasting API counts sending notifications to long-gone users.
  • Invalid Device Tokens (flagged by iOS and Android servers) are now automatically removed from profiles
  • Devices will no longer receive notifications from multiple users – if your app allows users to log in and out, it was possible to end up with multiple users with the same hardware device token. This is no longer possible – a token can now be associated with one and only one user.  That said, if you allow users to log out, you will call the new RemoveDeviceToken() call just before the logout, to ensure that the user’s profile no longer refers to the device.
  • There is a new Delete All Tokens menu option in the Design | Notifications | Settings screen, which allows you to clear all tokens of specific type (iOS, Android, etc.).  This is useful for when you switch between Sandbox and Production certificates on iOS, and you want to delete all the old tokens.
• Redemption Code Improvements – we’ve made some changes under the covers to make our implementation more efficient at high volumes of codes. The biggest change is that scan codes are no longer local to a code type, but are now global across all code types for an app id. This saves us a bunch of index space, and in practice better matches the datasets of our customers anyway.
• API Pre- and Post- Hook Improvements – we’ve improved the capabilities of API Pre- and Post- Hooks. As you may or may not know, Pre- and Post- hooks allow you to change the behaviours of brainCloud’s API calls themselves – inserting code to be run before and/or after the API call completes. Pre-hooks can now have the ability to change the parameters being sent into the API call. And Post-hooks can now access the original parameters sent to the API (providing useful context).
• Updated Unreal plug-in – Finally, we’ve made improvements to our Online Subsystem portion of our Unreal 4 libraries.

Portal Changes

Changes to the portal:

• Moved Email Authentication section – we’ve moved the Email Authentication settings from the Advanced Settings page to their own page under Design | Authentication.
• New Integrations section – we’ve added a new Design | Integrations section, which currently contains only the Segment integration from our new DataStream feature
• Revamped Notification Settings – the settings dialogs have been revamped to be clearer, and we’ve added an expiry drop-down.  You can also choose to delete existing iOS or Android device tokens.
• Get Test Redemption Codes – you can now search your datafill for a redemption code to use during testing.  You the Type and State of the code, and brainCloud will display the first one that matches. Available from the Global Monitoring | Redemption Codes screen.
• Reset Universal Authentication passwords – you may now reset the password of Universal Authentication users via the design portal. Simply choose the Set Password option in the new action menu displayed in the Credentials section of the User Monitoring | User Summary page.
• Managing Device Tokens – device tokens are used to push notifications to iOS and Android devices. The device tokens section of the User Summary page has been updated to display when the token was last registered (note – brainCloud only applies the first registration within a 24-hour period), and has a new [Reset Device Tokens] button to delete all the existing tokens for this user.

API Changes / Additions

Changes and additions to the API:

• Push Notification Tokens – two methods have been added to allow client apps greater control over the device tokens associated with user accounts.  DeregisterPushNotificationDeviceToken() will delete the associated device token from the user profile (), and DeregisterAllPushNotificationDeviceTokens() will delete all tokens associated with the user… (useful if you app contains a global toggle to disable all notifications to the user – as it will delete all notification tokens for this user, not just the token associated with the current device).
• DataStream Events – as mentioned in the highlights section above, new API calls have been added for custom DataStream events

Miscellaneous Changes / Fixes

Additional improvements to this release:

• Adjusted S2S Explorer so that it returns results in alignment with the API Explorer
• Added GlobalApp proxy to Cloud Code bridge
• Refactored C++ Comms to push common code into a single class
• Fixes to API Hook error handling – more descriptive error messages
• Miscellaneous fixes and performance improvements

   

This post is the first of our new series on best practices to observe before launching your app.

It’s an exciting feeling… Features are complete. Beta feedback incorporated. Final bits of polish applied. You are ready to launch.

Or are you? Are you sure that you have… Tested for every usage scenario? Every race condition? On each of thousands of device variations? Under unpredictable network conditions? Accounted for changing performance characteristics as your user base ramps?

Luckily you are using brainCloud – so you know your servers will handle the loads. But what about your client app? Your dev team is prepared to react and fix issues quickly – but how will you ensure that important updates make it to your users quickly?

Sure – the app stores support automatic software updates – but even so, it can take 3 weeks before the majority of your user base is using the new version of your app. That’s far too long if your app is crashing, corrupting data, and/or generally frustrating your users. In those 3 weeks your app’s ratings will take a huge hit.

This is why it is essential to implement Version Enforcement before you go live.

The good news is that brainCloud makes it easy.

Version Enforcement

brainCloud has built-in support for enforcing minimum client versions.  During authentication, in addition to transmitting information about the user that is logging in, the brainCloud client library sends two key pieces of information:

• platform – the type of device that the user is logging in from
• gameVersion – the version of the client game or app

These parameters aren’t just informational – brainCloud’s Version Enforcement feature allows you to ensure that only users of a specified version and above can log into your application. This forces out-of-date users to upgrade their clients before proceeding.

Version Enforcement is configured via the brainCloud Portal, and works in collaboration with integration code that you add to your app.

Above – the Design | Core App Info | Platforms screen

Note –  you can specify this minimum version on a per-platform basis, allowing you to accommodate staggered release schedules, different app approval processes, etc.

Integrating Version Enforcement

Integrating Version Enforcement into your app is very simple.

Follow these steps:

1. Set the app version in your client app. In most of the brainCloud client libraries, this is done via the BrainCloudClient.Initialize() function. In Unity, you can use the brainCloud Settings dialog.
   
   In either case, the version should be a string of format of “X.X” or “X.X.X” – for example, “1.0.0”.
2. Go to Design | Core App Info | Platforms, and temporarily set the minimum app version to something higher than your current app version.
3. Enhance the Authentication error handling of your app to catch the out-of-date error response – and display an appropriate message to the user. Ideally you should redirect the user to your apps store page so that he/she can trigger the update immediately. The brainCloud portal allows you to datafill the upgrade URL along with the minimum version.
   
   
4. Test to ensure that it works!

That’s it. Once this is in place, you will rest easier knowing that if (when) your users find problems in the field, that you’ll be able to push fixes to them in no time!

Release Highlights

Key features in this release:

• Apple TV Support! We’ve updated our libraries to support the new Apple TV. We can’t wait to see what you build!
• Unreal Blueprint Support! It’s been a long time coming, but we’re pleased to finally announce the availability of our Unreal plug-in, with Blueprint, C++, and [basic] Online Subsystem support.
• Redemption Codes – Planning to distribute individual codes to unlock characters / cards / etc. in your game? brainCloud’s new redemption code system is exactly what you need. More info on the feature and it’s API here.
• Long-running Cloud Code – we’ve added support for long-running Cloud Code scripts, and adapted our Cloud Code billing strategy to better support this use case.  More details below.

Those are the biggies, but there are a bunch of other changes and improvements in this release. Read on.

Portal Changes

Changes to the portal:

• Improved Timezone support – you can now specify the timezone used for viewing date+time data in the portal.  Note that the timezone will initially default to UTC – but it will remember what you set it to. Use the control in the top-right-hand corner of the portal to change the displayed timezone at any time.
• Redemption Code Screens – you’ll find new screens for the Redemption Code feature under Design | Marketplace, Global Monitoring and User Monitoring.
• Apple TV platform support – you’ll find Apple TV entries in Design | Core App Info | Platforms, as well as iTunes pricing component of Design | Marketplace | Products
• Cloud Code Timeouts – you can now set custom timeouts for your cloud code scripts from the Design | Cloud Code | Edit Scripts screen.
• Updated API Usage page – the Reporting | API Usage page has been updated to support the new cloud code billing formulas

API Changes / Additions

Changes and additions to the API:

• Redemption Code API – added methods for Redeeming codes and retrieving the list of codes that have been redeemed by a user. The key client api methods are RedeemCode() and GetRedeemedCodes().
• Push Notifications to Segments – you can now programmatically (via the Server-to-Server API) send push notifications to all of the members a Segment.
• Authentication Timeouts – a new client method has been added to override the authentication timeout.
• Retrieve Multiple Social Leaderboards – building a game with a Candy Crush-style map? We’ve got a new API call that retrieves the top friend entries from up to 20 leaderboards that you specify. Great for putting profile pics of the lead scores onto your map! Check out GetMultiSocialLeaderboard().

We’ve also made two more important changes to the Client Libraries:

Error Handling Changes

We’ve made some enhancements to how the brainCloud Server and Client libraries work together to communicate error information.  Specifically, we’ve enhanced the parameter for the error callback method to contain not only the textual message associated with the error, but actually the entire json result of the error.

This allows us to return more detailed error information, whose structure may vary on an operation by operation basis.  For example, if authentication fails because the client app’s version is obsolete, the returned error information can include a link to the app in the appstore to use to perform the software upgrade.

If by any chance your client app was parsing the – most apps weren’t, because it wasn’t very useful – you can still get the old data by referencing “statusMessage.statusMessage”.  Or, you can turn this new behaviour off using the BrainCloudClient.SetOldStyleStatusMessageErrorCallback() method.

Unified Rewards Processing

In addition, we’ve unified our rewards processing to invoke a standard Rewards Handler whenever rewards (achievements, xp, milestones and quests) are awarded from one of the many APIs that do so (i.e. authenticate, increment stats, stats event, etc.).  You can now hook into that single handler to splash Achievement Unlocked onto the screen, Quest Completed!, etc…  instead of duplicating that functionality across multiple handlers.

As part of this change, brainCloud no longer automatically triggers the associated local platform Achievement.  This platform-specific code was causing porting issues as we continue to expand the list of devices that we support. By centralizing the error handling it becomes very simple for the client apps to integrate what is in most cases a single line of code to trigger the local achievement.

To register for the new Rewards Callback, call RegisterRewardCallback() in your local library.

[Important note – the standard success and failure callbacks for the API calls still trigger. The rewards callback will trigger afterwards. Usage of the rewards callback is entirely optional.]

Miscellaneous Changes / Fixes:

Additional improvements to this release:

• Fixed match expiry not working in certain situations
• Added missing reason codes to clients
• Improved timeout checking on errors in C++ client
• Improved handling of iTunes subscriptions
• Minor fix to version comparisons during authentication
• Universal authentication no longer accepts blank passwords!
• Removed entity sub-type from Player Monitor | Entities screen
• Improvements to french translations in our portal!
• Added Portal Warning for Microsoft Edge browser – stick with Chrome, Firefox or Safari for now
• Improved the links to API docs in the Explorer
• Miscellaneous documentation improvements

Cloud Code Timeouts

When we first added Cloud Code support, we envisioned folks using it primarily for optimizing their client-server calls, and/or implementing sensitive logic on the server. For that sort of usage, our standard 10-second watchdog timer made sense.

But then we added support for Scheduled Cloud Code jobs – and you guys blew the doors off our Cloud Code usage scenarios! All of a sudden folks could schedule daily, hourly, etc. scripts – and some of these scripts were making hundreds and even thousands of API calls when they run.

It didn’t take long before folks started to hit the 10-second watchdog timer, which kills your script if its still running when the timer expires. The watchdog is there to ensure that our server doesn’t get hit by javascript coding errors (think “infinite loops!”). Needless to say, it’s an important part of ensuring that our servers remain safe and reliable when executing custom scripts.

In the short-term we had to raise that 10-second timeout globally across the system to keep some of our leading clients apps running properly.  We’re pleased to have our long-term solution in place now – which allows developers to set a custom timeout value for their individual scripts.  All new scripts will default to 10-seconds – but you can individually raise the timeout as high as 60 seconds. Note – if required, it’s possible to raise it even higher. Just message our team to have them raise your limit.

Billing Changes

We’ve also tweaked how we count API calls to better reflect these new Cloud Code usage scenarios.

As you know, the power of cloud code is that combining a collection of API calls together into a single cloud code script performs better than making the calls individually from the client – and also taxes our servers less – so it’s win:win. The new formulas for counting API calls under Cloud Code take this into account, and provide a fair balance of cost to the developer (you) and covering brainCloud server utilization (phew!).

The updated rules are as follows:

• Calling a cloud code script counts as 1 API call (same as today)
• The first three API calls from within an invoked cloud code script are free
• Any remaining calls from within cloud scripts are discounted to 1/2 an API call

If your app makes moderate use of cloud scripts, using them to string together common server requests (e.g. making a combined call to post a score, update player stats, and update a user entity describing the player’s progress) – this pricing update likely doesn’t affect you at all.  This includes the great majority of our customers today.

This new strategy allows our customers the flexibility of running much more ambitious Cloud Code scripts – at a greatly reduced cost per API call invoked.

If you have any questions or concerns, don’t hesitate to contact us through the support messaging system.

Release Highlights

Key features (and a fix) in this release:

• Parent Currency Enhancements – you can now link parent currencies to the IAP Products in child apps. This means that if you’re implementing a meta-currency across all your apps, you can configure products in the child apps that award the parent currency. This completes the currency enhancements to our Shared Accounts feature.
• Parameterized Notification Templates – by popular request, you can now include parameters in your notification templates, and invoke them using the new SendRichPushNotificationsWithParams() method. This is especially useful when you want to keep the definition of the notification text (with associated localizations) separate from the app code that invokes it.
• Authentication Fix:  We’ve made some key changes to how Authentication Timeouts are handled in all of the client libraries. The authentication timeout has been extended from 3 seconds to 15 seconds – and automatic retry has been disabled for Authentication requests. The app can still retry, but that’s at the discretion of the app developer (and assumably the user).

Authentication Fix Background:
We were finding that a small minority of (mostly slower) clients were timing out before receiving the response for Anonymous Authentication calls, especially during new account creation. When this occurred, the automatic retry behaviour of the clients was accidentally causing duplicate accounts to be created. This only applies to Anonymous Authentication calls – the other Authentication methods were not impacted by this behaviour.

We strongly recommend that all developers upgrade to the 2.16 version of the brainCloud Client Libs.

Portal Changes

Changes to the portal:

• Multiple Currencies in Products – While we were already upgrading products, we decided to add an often-requested feature. You may now link multiple virtual currencies to your in-app-purchase products – so if you want to give 5 bonus elixer with every bundle of 1000 coins that a user purchases, you can now easily do so.  We applied some overall polish to the screen as well.
• Push Button Deploy – you can now deploy changes from the development versions of your apps, straight to the production versions, without going through the export -> import process! Quicker and more reliable. Available under Design | Core App Info | Admin Tools.
• Improved Cloud Code Editor – we’ve improved the layout of our Cloud Code Editor. We’ve moved the informational portion of the cloud code script (name, description, test parameters, etc.) onto a separate page – thus maximizing the editor space. And while we were at it, we improved the automatic sizing of the window itself.
• Job Queue – we’ve enhanced the Cloud Code Job Queue screen to show both the date+time that a job was created, as well as when the job is scheduled to run.  The list is sortable by either, of course.
• Reset Device Tokens – you can now clear the device tokens for a user from the User Summary screen. Device tokens are used when sending push notifications to a user.

API Changes / Additions

Changes and additions to the API:

• Paged User Entities – we now have a paged API for User Entities, akin to the paged Global Entities API.  See the APIDOCs for info on GetPage() and GetPageOffset().
• Matchmaking API return results trimmed – turns out that there was a defect in our matchmaking APIs, and we were inadvertantly returning the entire player object.  This has been trimmed back to return the appropriate data as designed.
• Parameterized Notifications – as mentioned in the highlights section, we now support passing dynamic parameters to rich notifications.  See the SendRichPushNotificationsWithParams() call.
• Parent Currencies – the Product APIs have been extended to accomodate parent currencies. To keep things compatible with current code, any parent currencies returned by these methods will be in their own json section, at a level peer to the current node.
• BrainCloudFriend.UpdateSummaryFriendData() method has now been moved to BrainCloudPlayerState.UpdateSummaryFriendData(). The method in the Friend class has been deprecated.
• BrainCloudGamification.ReadGameStatisticsByCategory() now moved to BrainCloudGlobalStatistics.ReadGlobalStatsByCategory()
• BrainCloudGamification.ReadPlayerStatisticsByCategory() now moved to BrainCloudPlayerStatistics.ReadPlayerStatsByCategory()
• BrainCloudMatchMaking methods GetOneWayPlayers() and GetOneWayPlayersWithFilter() have been renamed to FindPlayers() and FindPlayersUsingFilter() as these APIs can be used to find players for OneWay and Async matches.
• Retries and timeouts are now configurable using the BrainCloudClient.SetPacketTimeouts() method. By passing in an array of values you can set both the timeout for each attempt, and consequently the number of attempts. The default is 3 attempts with 10 second intervals between (e.g. {10, 10, 10}).

Misc. Changes / Fixes

Additional improvements in this release:

• New Client Library – a Linux i386 library is now available
• Miscellaneous fixes and performance improvements.

Release Highlights

Highlights of this release include:

• Shared Accounts – highly requested feature – brainCloud now allows you to share user accounts across applications. This is achieved by creating a master profile (associated with a separate App ID), which is associated with individual child profiles for each app. This is extremely powerful for companies looking to link the players across a collection of games together, or to model sub-accounts under a single Home account for a household. [i.e. think set-top box].
  For more information, see our Shared Accounts page in the API Docs.

• Facebook Notifications – we’ve always had them, but you couldn’t properly enable/disable them. Now you can turn them on/off in the Design | Notifications | Settings page on the portal. And note of course, that your app will need to ask for the appropriate Facebook permissions for them to work.
• Billing changes (Boo!) – we’ve now added support for monitoring and billing for excess file transfer usage. All Standard Plan apps get 10GB per month of free downloads. After that, it’s $0.10 USD per GB. And note, we’re only charging for the S3 file downloads – not for any of the data otherwise associated with API — that’s all covered by the API counts.

Portal Changes

Changes to the portal:

• Shared Accounts – configure parent-child app relationships under Design | Authentication | Shared Accounts.
• Parent Currencies – a child app can include parent currencies in rewards for XP level-ups, Milestones, Quests and Statistics Events. All configurable under Design | Gamification.  Parent Currencies are also visible on the Design | Marketplace | Virtual Currencies page.  Note that you cannot yet award parent currencies for IAP Product Purchases [that will come next release].
• Leaderboards – we’ve added a few additional “Are you sure?” checks to the process of resetting / deleting leaderboards, especially for live apps.
• Improved Error Reporting – we’ve improved our logging system to show errors from more sources, including Server-to-Server calls and Scheduled Cloud Code.  We’ve also added a new error category, “Sys Warnings”.  Check it out in Global Monitoring | Recent Logs.
• Profile Relations – profiles with parent or child profiles will see them listed at the bottom of the User Monitoring | User Summary page, in a section called Relations.  We’ve also moved the [Login as User] button to the top of the page for convenience.

API Changes / Additions

Changes and additions to the APIs:

• Shared Accounts– related API enhancements:
  • Authenticate() and GetPlayerState() methods now return the id of the parent profile (if there is one), as well as any parent currency balances
  • New Identity methods for switching to/from parent and child accounts – SwitchToChildProfile(), SwitchToSingletonChildProfile(), SwitchToParentProfile() and GetChildProfiles().
  • Enhancements to currency methods to support Parent Currencies – AwardParentCurrency(), ConsumeParentCurrency(), GetParentCurrency() and ResetParentCurrency()
  • New RunParentScript() call to run a parent’s Cloud Code script (in the context of the parent profile)
• EnableLogging now implemented for Windows Comms library
• Objective-C library – better handling of optional parameters
• Java library – callback mechanism has been refined to better match the other libraries. Also, you can now receive separate error callbacks for individual API calls.

Misc. Changes / Fixes

Additional improvements in this release:

• Upgrade Push Notifications service – we’ve upgraded our underlying Push Notification libraries for greater reliability
• Updated game examples – we’ve taken a pass through our examples to ensure that they’re using our latest and greatest libraries
• Match expiry – plugged some holes in our completion of matches on Expiry timeouts
• Improved handling of database connections under load
• Miscellaneous performance improvements – mostly improvements under-the-hood to our logging subsystems
• Miscellaneous documentation improvements

Release Highlights

Highlights of this release include:

• New Client Libs* – new Linux C++ Client, Visual Studio 2008 and Visual Studio 2010.
• New Unity Example – we’ve built a UNET version of brainCloud Bombers
• Performance optimizations – ongoing optimizations to tune performance and scalability

* All other clients updated with the latest APIs, of course.

Portal Changes

Changes to the portal:

• Linux is now a selectable platform – see Design | Core App Info | Platforms
• Disable Event-checking – If you aren’t using events, you can disable checking for them in each message by unchecking the option in Design | Core App Info | Compatibility Settings
• Flexible User Deletion – ability to Delete all Test Users, and All but Test Users.  In portal under Design | Core App Info | Admin Tools
• File transfer usage – now being reported in API Usage section of Reporting

API Changes / Additions

Changes and additions to the APIs:

• We’re reworking our Events system a bit:
  • GetEvents() method added to support directly polling for new events
  • Authenticate() and GetPlayerState() continue to return incoming and sent events.

Misc. Changes / Fixes

Additional improvements in this release:

• Apple push notification certificates without passwords now work (before a password was *required*).
• Improved error logs – script failures being more consistently logged now, and with more information
• Improved matchmaking – we’ve improved the randomness of our matchmaking routines

Release Highlights

Highlights of this release include:

• New-and-Improved Objective-C Client – we’ve rebuilt our Objective-C client to support all our latest APIs.
• Twitter Authentication Support – your users can now use Twitter to log into your app. How social!
• API Calls from Cloud Code are now free!* As per our original intent, API calls from cloud code scripts are now free*. This incentivises you to write simple scripts to aggregate multiple calls – reducing round-trips to our servers, which reduces our costs – and in turn reduces yours!

* Minor adjustments to the Cloud Code billing strategy were introduced in 2.17 to accommodate long-running Cloud Code scripts.

Portal Changes

Changes to the portal:

• Developers can now set their brainCloud App Secret directly (see Design | Core App Info | Application IDs)
• Developers can now view and edit the Indexed ID property of their Global Entities in the portal (see Monitoring | Global Monitoring | Global Entities).  This field is useful for creating quick lookup keys for your entities.
• The Recently Added Users page has been optimized (see Monitoring | User Monitoring)
• API calls from within Cloud Code scripts are now displayed separately on the Reporting | API Usage page of the portal

API Changes / Additions

Changes and additions to the APIs:

• New Twitter Identity APIs – AuthenticateTwitter(), AttachTwitterIdentity(), DetachTwitterIdentity() and MergeTwitterIdentity().

Misc. Changes / Fixes

Additional improvements in this release:

• Updated Javascript Client – added missing Identity APIs, misc fixes, etc.
• Performance optimizations:
  • Improved Multiplayer Matchmaking performance
  • Improved Leaderboard performance
• Documentation Improvements:
  • Java/Javascript Gamification methods
  • Improved Multiplayer documentation
  • Improved Push Notification documentation
  • Improved Facebook IAP documentation
• Misc. fixes and optimizations
  • Fixes to push notifications subsystems to improve reliability
  • Fixes to deletion of users – some credentials (e-mail + universal) were not always being deleted
  • Improvements / fixes to leaderboard processing at high player counts

Release 2.12.0 has gone public! There are some tasty goodies in this one – please read below for the highlights!

Release Highlights

Highlights of this release include:

• Scheduled Cloud Code – you can now schedule cloud code scripts to run at a specific time. This tool is very powerful and gives you the ability to defer task execution as benefits your game/app.  See this page for more information on how to use this great new feature.
• Paged Global Entity Fetches – it is now possible to retrieve more than 100 Global Entities. We’ve created a new paging system that allows you to navigate a larger set of Global Entities. The paging APIs use a sophisticated query syntax which gives you search and ordering flexibility. The query syntax is described here and the API itself can be found here.
• Support for “Lower Is Better” Leaderboards – You can now create Leaderboards where the best score kept will be the lowest score the user has posted.
• S3 File Listing – we’ve created a new API that makes it even easier to fetch the list of files uploaded to S3.

Portal Changes

• Global Monitoring | Job Queue – this is where you’ll find details about scheduled cloud script jobs. We also keep a history of jobs that have run in the past which is useful when diagnosing issues with your scripts.
• Design | Quests – now include Unlock Criteria, and Rewards which can use any combination of user level/XP, player statistics or global statistics. Rewards can also pay out currency and/or achievements.
• Misc Fixes

API Changes / Additions

New APIs

• Schedule Cloud Code – To schedule cloud code you can use one of these APIs.
  • BrainCloudScript.ScheduleRunScriptUTC() for an absolute date.
  • BrainCloudScript.ScheduleRunScriptMinutes() for scheduling x minutes from now.
• Global Entity Paged Fetches – To fetch global entities by Page
  • BrainCloudGlobalEntity.GetPage() – Call this for the first fetch, specifying the fetch query
  • BrainCloudGlobalEntity.GetPageOffset() – Call this for subsequent fetches passing in the returned context variable
• BrainCloudFriend.FindPlayerByName() – This API allows you to search for a player by their player name (settable using “BrainCloudPlayerState.UpdatePlayerName)
• Attach/Detach Google Identity – To allow you to attach and detach Google identities.
  • BrainCloudIdentity.AttachGoogleIdentity()
  • BrainCloudIdentity.MergeGoogleIdentity()
  • BrainCloudIdentity.DetachGoogleIdentity()
• BrainCloudS3Handling.GetFileList() – To retrieve the full list of S3 files stored on brainCloud

Modified APIs

• BrainCloudSocialLeaderboard – Calls to TriggerSocialLeaderboardTournamentReward now require the use of a leaderboardId to identify the leaderboard.

Misc. Changes / Fixes

Addressed in this release:

• Unity library IsAuthenticated – Session time outs will now cause this flag to be set to false.
• Post score to dynamic leaderboard – APIs now take in the hour/minute to allow setting the rotation time.

We’ve got a bunch of fixes and tweaks for you this week, plus a game to play with your family on the holiday week-end!

Release Highlights

Highlights of this release include:

• brainCloud Bombers – we’re pleased to announce the availability of our new example game, brainCloud Bombers! Bombers is intended to show how well brainCloud works with other multiplayer tech, like Exit Games Photon. The source for the game is available here, and we’ve written several posts that talk about how the game was built and what features it uses. Check it out!
• Leaderboard changes – we’ve made some changes to the way that leaderboard versioning / retention works. We used to version leaderboards based on a fixed start date + rotation period – which seemed pretty logical, but caused problems if you wanted to adjust the ration period/date+time, and *didn’t* want to lose all your old leaderboards – d’oh! So we’ve changed that. Now if you adjust your leaderboard settings, they affect the leaderboard behaviour going forward, but do *not* affect the old leaderboard data at all. We’ve also fixed some inconsistencies in our display of leaderboard date+time settings. Finally, to top it all off, we’ve added new APIs to request data from old leaderboards. 

Portal Changes

Minor changes to the portal:

• Design | Leaderboards – fixed the leaderboard rotation date/time display to focus on when the next leaderboard rotation occurs, and to clarify UTC vs. local time settings. We’ve also changed how the “Retained Leaderboards” setting works. It used to include the “current” leaderboard in the count – so you’d have to set it to “2” to retain “1” leaderboard in addition to the current one.  This was confusing, so we fixed it. Don’t worry – we’re retaining your previous setting – so if you had it set to “2” before, it will now show “1” – but the two are equivalent.
• Global Monitoring | Leaderboards – leaderboard entries now show the exact date+time of the entry.
• Design | Multiplayer | Offline Match-Making – the Match Expiry Timeout is now configurable on a per-game basis
• Global Monitoring – the tabs have been reordered slightly.
• Authentication | External Identities – minor changes to the screen

API Changes / Additions

Minor additions and behavioural changes to the APIs:

• (New) Historical Leaderboard calls– we’ve added the ability to retrieve old leaderboards results.
  • To retrieve a list of older versions of the leaderboard, call GetGlobalLeaderboardVersions().
  • To retrieve the entries for a specific version, call GetGlobalLeaderboardPageByVersion().
• (New) Looking up friends– we’re adding support for looking up friends. More methods will be added next release.
  • GetFriendProfileInfoFromExternalId() to look up other users based on their external id (returns the friend’s summary data).
• (Change) User Entity Version exception handling
  • All variations of Update and Delete for user entities now throw an exception if the provided version is incorrect.  [Used to simply return a null object]
• (Change) Cloud Code changes
  • Added the missing ServiceProxy for accessing Global Properties from cloud code
  • Script return format has been updated to include separate status + data, to better align with the Client API.
  • The old behaviour is preserved if [x] Use Legacy Script Result Format is checked under Compatibility Settings in Design | Core App Info | Advanced Settings. The old behaviour will be preserved by default for existing apps (though it is highly recommended that developers migrate to the new format when convenient).

Misc. Changes / Fixes

Addressed in this release:

• Change to XP level processing – you can now configure rewards for Experience Level 1, and assuming the level’s XP requirement is set to 0 points, the player will automatically receive the rewards upon creation. This is very useful for setting initial virtual currency balances.
• Global Stats Synchronization – fixed issue with Global Stats not being synchronized across app servers (and in the portal) in some circumstances
• brainCloud now requires encrypted (HTTPs) connections for all new apps moving forward (this was optional before).
• C++ and C# Client Libs – now retrieve heartbeat configuration settings from the server, and dynamically determine if a heartbeat needs to be sent. This should result in fewer API calls to keep your app sessions alive.
• Unity Toolbar – An Enable logging option has been added
• The old GetGlobalLeaderboard() API call has been deprecated (and removed from the API explorer and the documentation). It will still work for now, but you should use one of the newer methods, like GetGlobalLeaderboardPage() instead.
• API Explorer – Gamification.UpdateRewards() method was missing – has been added Javascript client lib – Improved handling of optional parameters.
• brainCloud Support Chat has been added to the API docs site – just click on the Chat button for help!
• Database optimization – Improved sharding of Global Entities
• Attributes – Fixed an issue where attempting to remove user attributes would fail.
• Miscellaneous fixes and performance improvements