Testing and troubleshooting

Last updated on July 20, 2018

After you have integrated the OpenX Mobile Android SDK, you should test your implementation.

Important: For troubleshooting and diagnostic purposes, please install an HTTP debugging proxy such as Charles Web Proxy. You may need to provide logs to OpenX.

General testing requirements

Please make sure that you:

Important: If you encounter issues, see a list of possible problems and solutions below. If you still can't resolve your issues, please request resolution assistance through the OpenX Support Community and make sure to include your Charles logs and any SDK error message.

Using Charles Web Proxy

An HTTP debugging proxy, such as Charles Web Proxy, allows you to observe network traffic coming from Android simulators and devices and diagnose issues with your OpenX Mobile Android SDK implementation. You can download and install Charles from https://www.charlesproxy.com/.

Use Charles to verify network requests are passing correctly. For example, to verify that you are sending a valid ad requestCommunication from a web browser or app to an ad server to display an ad., copy the ad request URL from Charles and paste it in your browser and see if you are getting a valid response.

Tip: Consider using a filter such as "openx" to avoid sifting through a lot of unrelated traffic.

This is an example of a bannerThis is an ad that appears on a web page which is typically hyperlinked to an advertiser’s website. Banners can be images (GIF, JPEG, PNG), JavaScript programs or multimedia objects (For example, Java). ad request where OpenX wins the bid:

In a successful implementation, you are likely to see the following items in the Path column:

Troubleshooting

See also examples of common ad exceptions and error log messages below.

Problem

Possible reasons

What to do

Ad not displayed.

 

 

 

 

No fill (most common).

 

 

  • Make sure the location permissions are added to your OpenX Mobile Android SDK's manifest as described in Integrating the SDK with your project.
  • Make sure your app checks and requests runtime permissions appropriately.
  • Enrich with more user data. See Parameters.

 

 

Incorrect delivery domain.

Make sure you are using the OpenX delivery domain provided by OpenX.

Incorrect ad unit ID.

Make sure you are using the ad unit ID provided by OpenX.

Issues with the creativeThe media asset associated with an ad, such as an image or video file..

Check where creative is coming from. You may need to block certain advertisers, for example.

No navigation occurs when user taps on ad, or user sees blank white screen after clicking.

 

  • Creative does not have a click-through link.
  • Another UI element is laying over the ad.
  • Creative redirecting to a server that is not set up properly.

Check your creative and your UI view hierarchy to make sure they are set up as expected.

Ad not displaying correctly, such as a landscape ad appearing for a portrait ad unit.

Line itemThe primary unit of execution for an order, which represents a specific inventory purchase and the required conditions for ad delivery. configuration issue.

On your ad serverA complete digital advertising platform where publishers sell, manage, and deliver their advertising inventory across all digital formats., make sure the line item is trafficking the same orientation as the ad unit.

No geo data or other expected auto-detected data.

  • The location permissions may not be added to the OpenX Mobile Android SDK's manifest.
  • User may not be allowing data to be shared within the app settings.

 

  • Make sure the location permissions are added to your OpenX Mobile Android SDK's manifest as described in Integrating the SDK with your project.
  • Make sure your app checks and requests runtime permissions appropriately.
  • Make sure the user is allowing data to be shared within the app settings.

No user enrichment data.

  • You may not have set all of the user enrichment data that you expected.
  • User may not be allowing data to be shared within the app settings.
  • Make sure you have set all desired user data to be included in ad requests as described in user parameters.
  • Make sure the user is allowing data to be shared within the app settings.

Ad is refreshing or not refreshing unexpectedly.

Refresh is not set as expected, either in the OpenX Mobile Android SDK ad configuration or in your ad server configuration.

Check your refresh setup in the OpenX Mobile Android SDK and your ad server. See configuration parameters.

No impression or no click tracking recorded.

 

Request resolution assistance through the OpenX Support Community.

Ad exception types and examples

Exceptions can inform you of configuration issues or possible issues that need to be resolved by OpenX. The following table summarizes the types of exceptions that may occur and provides examples of common log messages.

Error type

Message example

Reason

What to do

INVALID_REQUEST

"Invalid request: No domain was specified"

"Invalid request: No ad unit ID was specified"

There could be a problem with your configuration.

Check your configuration. Invalid request errors usually inform you of a missing required setting, such as no ad unit ID specified, no creative specified, or no domain specified. If you need help with troubleshooting configuration errors, please visit the OpenX Support Community.

INIT_ERROR

"Internet permission not granted"

"Failed to fetch advertisement ID"

There is a problem with permissions or initialization of system services in the SDK. Check your AndroidManifest.xml and make sure you have followed the instructions in Integration the SDK with your project.
INTERNAL_ERROR

"SDK internal error: Invalid ad response: Invalid VAST Response: less than 100 characters."

There could be a problem with your SDK implementation or with OpenX. For example, the video ad unit may not be returning the right VAST response.

Please request resolution assistance through the OpenX Support Community and make sure to include the error message.

SERVER_ERROR

"Bad server response - [HTTP Response code of %s]"

Indicates a problem that needs to be resolved by OpenX.

Please complete follow the testing guidelines above. If you cannot resolve the issue, please request resolution assistance through the OpenX Support Community and make sure to include the error message.

Below are examples of an adDidFailToLoad and error messages that appear when you use incorrect delivery domain or ad unit ID.

  • If the delivery domain is incorrect:
    SDK internal error: Invalid ad response: (server status code)
  • If the delivery domain is correct, but the ad unit is incorrect:
    SDK internal error: Bad server response - [Adunits field empty in JSON response]

 

Fill out my online form.