Advertising Service

You can use the Advertising Service to display banner ads in your BlackBerry WebWorks applications that run on BlackBerry smartphones.

The Advertising Service uses a central web portal where you can add or remove ad networks. The Advertising Service website allows you to adjust the percentage of ad requests that are sent to each ad network without having to change your application. You can also track ad performance metrics (for example, the reach, CTR, eCPM, and earnings). To get more information on the Advertising Service, visit

The Advertising Service supports various ad types that conform to the MMA guidelines for mobile ads, including expandable ad banners and expandable ad banners with video. Ad networks and ad agencies can also create ads that are designed to integrate with BlackBerry Device Software. For more information about the MMA Mobile Advertising Guidelines, visit


The following diagram shows you the components that make up the Advertising Service:

Architecture diagram showing the components of the Advertising Service.
Ad networks

An ad network receives ad requests from your application through the Advertising Service mediation layer, evaluates the requests, and returns ads through the mediation layer that are suitable for the target audiences of the applications and the BlackBerry devices.


The database contains information about your application, preferences that you specify in the web portal, and statistics about the past performance of ad networks. The mediation layer can use the information in the database to determine the ad networks to send ad requests.

Web portal

The web portal is a website where you can view statistics about the performance of the ads in your application, manage your participation with ad networks, and generate reports. The mediation layer can use the preferences that you specify in the web portal to determine the ad networks to send ad requests.

Server-side API

The server-side API enables the components of the mediation layer to communicate with ad networks, devices, developers using the web portal, and the database. The server-side API receives ad requests from the applications on BlackBerry devices, directs the ad requests to the appropriate ad networks based on the statistics stored in the database, and returns the ads to the devices.

Process flow: Displaying an ad in an application

This diagram shows the elements that are described in the following process flow.

  1. The application sends an asynchronous HTTP ad request to the mediation layer server.

    The ad request contains a unique zone ID that represents the specific ad placement (the zoneId parameter).

  2. The mediation layer server receives the ad request, examines the past performance of the ad network servers and the preferences that were defined for the ad, and sends an HTTP ad request to the appropriate ad network server.
  3. The ad network server receives the HTTP ad request, examines the past performance of ads in the application, identifies the target audience based on the information that is included in the ad request, and returns the appropriate banner ad content to the mediation layer server.
  4. The mediation layer server returns the banner ad to the application.
  5. The application displays the banner ad in the div that was specified in the ad request.

Process flow: Clicking an ad in an application

This diagram shows the elements that are described in the following process flow.

  1. The BlackBerry device user views and clicks the ad.
  2. The application sends an ad request to the mediation layer server.
  3. The mediation layer server sends the request to the ad network partner servers to obtain a destination URL.

    The contents of the destination URL vary depending on the type of action that was defined for the click event. For example, the destination URL contains a website's address once a click event directs a user to that website.

  4. The ad network partner server records the click and sends the destination URL to the mediation layer server.
  5. The mediation layer server sends the destination URL to the application.
  6. The application executes the procedures that are associated with the type of action that is assigned to the click event for that ad (for example, it may open a website).

Displaying an ad in a BlackBerry WebWorks application

To display an ad in your BlackBerry WebWorks application, you must add some JavaScript code to any HTML webpage within your BlackBerry WebWorks application that displays banner ads. The advertising content for your banner ads is automatically sent from a remote ad server.

Availability of engaging and dynamic ads

The Advertising Service supports engaging and dynamic ads from many top brands and services. The Advertising Service can interact with ads that users click to open a website, go to BlackBerry World storefront, or display a video. The Advertising Service supports ads that perform the following actions:

Ad type



Opens a website using the BlackBerry Browser


Opens an RTSP feed that displays a video


Opens the Details screen for an application in the BlackBerry World storefront

The ad network controls the action that occurs after a user clicks an ad, therefore you are not required to implement any type of event behavior.

Access to multiple ad networks from one location

You can use the Advertising Service to access multiple ad networks without having to negotiate agreements with each ad network.

Each ad network sends targeted well-performing ads to your application that are relevant to the viewing audience and that are best suited for a particular ad placement. Ad networks compete with each other for permission to place their ads in your application.

Comprehensive tracking and reporting

The Advertising Service provides a reporting interface where you can view and track data to help you monitor the performance of all your banner ad placements. You can generate reports that contain data about the reach, number of impressions, performance, and earnings of your ads. You can filter that data by ad network or ad placement. You can also view detailed performance metrics, such as statistics about fill rates, eCPMs, and CTRs.

Advertising Service security features

Ads run in a highly secure domain

BlackBerry WebWorks separates the execution of the Advertising Service code from the execution of other BlackBerry application code to make it highly secure. This separation of the code execution means that banner ads cannot interact with other applications that exist on a BlackBerry device, or access any device data.

When the Advertising Service SDK receives an ad request, it creates an IFRAME to isolate the execution of the ad banner code from the application that is integrating it. The use of an IFRAME makes sure that the code for the ad banner runs in its own highly secure domain.

Banner ad size, position and content

You can control the size and position of the ad space of your banner, however an ad network server always delivers the ad content.

BlackBerry device security

BlackBerry device security prevents an advertiser from gaining access to any existing device applications. BlackBerry device data such as the phone ID, phone PIN, or phone number are not accessible. The BlackBerry device and its applications remain highly secure from any interaction with the Advertising Service.

Best practices

The way that you display ads in your application can have an effect on the performance of the ads. When incorporating ads into your app, consider the following guidelines:

  • Place ads on the screens that have the highest amount of traffic for your application. For example, place an ad on a screen that appears when an application opens rather than on a screen that requires multiple clicks to navigate to.
  • Place ads in prominent locations on your screens, such as the top or middle of the screen, depending on the design of your application.
  • Avoid crowding ads with the rest of the content in your application. Ads should be clearly visible so that they are easier to interact with. Consider creating a separate ad screen or dialog box for the ad.
  • Display an ad at a suitable moment. For example, don't display an ad when a game is playing. Display the ad before or after a game. For other types of apps, display an ad when the user moves from one screen to the next, or when the user completes a task in the app.
  • Provide enough time for users to view the ad. Refresh ads every two or three minutes.
  • Keep the ad visible when the user scrolls down the screen in your application.
  • Follow the MMA guidelines to display ads at the appropriate size. For more information, visit the MMA Mobile Advertising Guidelines.

Last modified: 2013-10-02