MRAID Playable

Please make sure to check our Advertiser & Creative Content Guidelines before proceeding with MRAID playable upload.
Make sure to consult IAB MRAID Best Practices Document for the most common mistakes, MRAID creative requirements and debugging tips.
To enable MRAID Playables in your account, please contact your Account Manager at Chartboost.
Introduction to MRAID

What is an MRAID playable?

MRAID stands for ‘Mobile Rich Media Ad Interface Definitions’, and is a standard set for mobile rich media ads to be run on mobile apps by the Interactive Advertising Bureau (IAB). An MRAID playable consists of API commands which are designed to adjust the ad according to the mobile operating system and app environments it’s being displayed in. Playable ad is a mini-game as an ad within a game, often also called micro-games. A playable ad is often used to give the user a preview of the game before installing it.

How do I create an MRAID playable ad?

There are many third-party vendors in the market who focus only on creating playable ads. Chartboost supports any playable ads which follow the technical specifications mentioned below. For more information on common practices, consult IAB MRAID Best Practices Document.

How do I get started with serving MRAID playable ad on Chartboost?

Our MRAID playable ad uploader is available on Chartboost dashboard to selected advertisers. If you’re interested in getting access, please reach out to your account manager or to our support team here.
MRAID Requirements
Make sure to consult IAB MRAID Best Practices Document for the most common mistakes, MRAID creative requirements and debugging tips.

How do I get started with serving MRAID playable ad on Chartboost?

Making MRAID playable requires the following compliance:
  • One single bundled standalone html file
  • Maximum size 3MB
  • The mraid library will be available in the playable during ad playback
  • Check mraid.getState() at the start of the playable because it could already be DEFAULT
  • The ready event will be triggered if the state was LOADING at first
  • mraid.open(url) needs to be called when the user clicks on a CTA
  • The close button will be added by our system, therefore there is no use to call mraid.close() within your playable

MRAID supported standards v2.0

Methods Supported Methods Supported Tracked events Supported
close Yes setViewable Yes Ready Yes
open Yes getDefaultPosition Yes error Yes
playVideo Yes setCurrentPosition Yes sizeChange Yes
getVersion Yes setDefaultPosition Yes stateChange Yes
isViewable Yes setOrientationProperties Yes viewableChange Yes
removeEventListener Yes setScreenSize Yes
addEventListener Yes setMaxSize Yes
getCurrentPosition Yes getMaxSize Yes
supports Yes getPlacementType Yes
setSupport Yes getScreenSize Yes
setState Yes getState Yes

MRAID non-supported standards v2.0

MRAID Playables using below methods will not work on the Chartboost network (at this time). Please make sure your Playable does not include any of them.
Methods Supported Methods Supported
useCustomClose No isCustomClose No
expand No resize No
setExpandProperties No setResizeProperties No
getExpandProperties No getResizeProperties No

How to use Chartboost MRAID Playable Uploader
  • Log in into your Chartboost dashboard.
  • In the left panel select “App Settings” followed by “MRAID Playable Upload“.

  • Name your Playable.
  • Upload your MRAID HTML file.
 
    • Resize your MRAID Playable
      • You can preview different resolutions by clicking the Dimension Drop-Down.
      • You can also rotate your playable to Portrait/Landscape mode by clicking the Rotate button.
    • Test your Call To Action button
      • You can test whether your playable redirects to the store correctly by clicking the download or install button.
      • You can confirm the status of your click underneath the test environment. If there is a green tick your click was successful and if there is a loading sign the click has not been registered.
      • If the click in the CTA button was not registered, check if you are using the method mraid.open(url). This method needs to be called when the user clicks on a CTA.
    • Test your Close button
      • Click on the close button which will appear on the top left corner of your playable.
      • You can confirm whether the close button worked underneath the test environment. If there is a green tick your action was successful and if there is a loading sign the close button did not work.
    • You can test your playable as many times as you wish by clicking the Restart button.
    • Click “Upload” to finalize uploading your MRAID playable.
    • Your new playable will be available in the Chartboost dashboard under the “App Settings” -> “Creatives” section. You can now start advertising!.

Playable Review Process
Every playable uploaded into the dashboard needs to first get approved by the Chartboost team. We will test your playable to ensure it works well on different SDK versions and device models. It usually takes 1 business day to have your playable reviewed.
  • When your playable is uploaded it will enter our review queue. At this time your playable will be greyed out in the dashboard when trying to attach it to a campaign.
  • If your playable is working well, it will be approved usually within 1 business day. Once approved, your playable will be selectable in the advertising campaign and ready to launch!
  • If your playable didn’t pass our QA, it will be rejected by us and it will stay in the greyed out state. In that case, you will receive an email from the Chartboost team with details on what went wrong and potential steps to reproduce and fix the issue.
  • Rejected playables will be removed from our system and your dashboard within 30 days from the rejection date.

And that’s it!

Now you are ready to start an advertising campaign with your new playable! Learn more.