Skip to main content

Ads SDK API Overview

About The Ads SDK

This section is only intended to serve as a quick reference on using the Ads SDK. For more information about the SDK itself, click here.

For information about working with Ads in an app, instead go here.

The Ads SDK creates simple Managed Ads Containers, which are controlled by the SDK with minimal intervention from the app.

Creating a Managed Ads Container​

You must first set up the ads SDK in your app. This defines the [OwAd][owad] variable, which is instantiated and linked to a specific DOM element which creates the Managed Ads Container.

Multiple Ad containers

You need to create multiple instances of [OwAd][owad] If you want to show more than one ad in your app. Make sure you pass a different container element for each instance, and that you properly comply with our [acceptable Ads policy][acceptable-ads].

Setting up the Ads SDK​

In order to use the Ads SDK in an Overwolf app, you must first fetch it from https://content.overwolf.com/libs/ads/latest/owads.min.js. Below is a snippet that fetches the SDK, and then sets up an OwAd instance:

Fetch the latest version of the Ads-SDK, and make sure it loaded
<script src="https://content.overwolf.com/libs/ads/latest/owads.min.js" async onerror="onAdsSDKNotLoaded()" onload="onAdsSDKReady()"></script>
<script>
    // Reached if the SDK's script failed to load (took too long, couldn't be found, etc)
    function onAdsSDKNotLoaded() {
        // If this happens, it is up to the app to decide how to proceed.
        console.error("Couldn't load owads.min.js!");
    }

    function onAdsSDKReady() {
        if (!OwAd) {
            // Reached if the SDK's script failed to properly load.
            // If this happens, it is up to the app to decide how to proceed.
            // onAdsSDKNotLoaded();
            return;
        }
        // Reached if the script loaded properly.
        // You can now create however many ad containers you need for this window, granted that they follow the implementation guidelines.
        let adContainer = new OwAd(document.getElementById(/*Insert ad container Id here*/), {/*Mandatory Ad settings*/});
    }

</script>

Snippet implementation notes​

  • The script tag is added with an async attribute so that it is loaded asynchronously and won't interfere with the rest of the page's loading. Be aware that the script may take time to load and be ready. Use the onload and onerror callbacks from the script tag in order to be notified as soon as the load succeeded/failed.

  • When creating a new OwAd, you need to provide it with two parameters: a DOM element, and the required ad settings. In above snippet, the instance of the element is identified by calling document.getElementById(). However, you may use any other way to get the DOM element. You can also use document.querySelector, jQuery, or any other method you wish as long as the provided element is an HTML element available at the DOM.

    Container Identification

    Ad containers that don't have a pre-assigned element ID defined will automatically be assigned one.

Changes to your app’s manifest.json file​

Required permissions​

The Overwolf Advertising library uses Overwolf APIs to improve ad targeting for users. Therefore, you need to add the following permissions to your app’s permissions array:

   "permissions": ["Extensions", "Streaming", "Profile", "GameInfo"]