User Manual

Facebook Playable Ad

PlayCanvas supports the Facebook Playable Ad formats and requirements via an official external tool on GitHub.

The tool can create both the single 2MB (uncompressed) HTML file and the 5MB (uncompressed) ZIP formats via the configuration options. Full specifications for Facebook Playable Ads can be found on their help centre.

There are some limitations to be aware of with the tool which can be found in the documentation from GitHub.

Example project

The Cube Jump project is ready to be exported for the Facebook Playable Ad format and the expected HTML output can be found here.

File size tips

As there is a strict file size limit, you will have to plan and budget the usage of assets for the ad.

The minified PlayCanvas Engine code is ~1.2MB uncompressed and due to the need to encode the asset files into Base64 strings, it adds ~30% to the size of each asset file.

This means that for a single HTML format, this leaves ~500KB for assets before they are encoded into Base64 strings. For the ZIP format, this would be about ~3MB for assets before encoding.

Try to keep images as small as possible in dimensions and use tools like TinyPNG to reduce file size even further.

Playable ad checklist:

How to export

Follow the setup steps from the readme in the GitHub repo.

Single HTML

Set the following options in the config.json as shown below. This will produce a single HTML file in the output directory.

    "one_page": {
        "patch_xhr_out": true,
        "inline_game_scripts": true,
        "extern_files": false

ZIP file

Set the following options in the config.json as shown below. This will produce a ZIP file with the asset data and PlayCanvas Engine code as separate files from the index.html.

    "one_page": {
        "patch_xhr_out": true,
        "inline_game_scripts": true,
        "extern_files": true

And run the command:

npm run one-page

Full details of options and commands can be found in the readme section for 'Converting a project into a single HTML file'.

How to test

Follow the steps here to create a Facebook ad and at the time where the files for the ad are uploaded, there is an opportunity to test within the manager.

Please ignore the warning about the source may contain an XMLHttpRequest as the code path has been removed by this tool.

Facebook also allows testing on device via the ad manager but requires you to publish the ad first. This is a strange limitation by Facebook but is required at the moment.