ImpressionData /5.7.0

public class ImpressionData implements Serializable

Methods for retrieving impression-level revenue data (ILRD). Refer to our ILRD article for Android for additional implementation instructions.

Public Constants

public static String /ADGROUP_ID /+5.7.0

  • Description: A String field corresponding to the value for the ad group ID of the current creative.

public static String /ADGROUP_NAME /+5.7.0

  • Description: A String field corresponding to the value for the ad group name of the current creative.

public static String /ADGROUP_PRIORITY /+5.7.0

  • Description: A String field corresponding to the value for the ad group priority of the current creative.

public static String /ADGROUP_TYPE /+5.7.0

  • Description: A String field corresponding to the value for the ad group type of the current creative.

public static String /ADUNIT_FORMAT /+5.7.0

  • Description: A String field corresponding to the value for the ad unit format of the current creative.

public static String /ADUNIT_ID /+5.7.0

  • Description: A String field corresponding to the value for the ad unit ID of the current creative.

public static String /ADUNIT_NAME /+5.7.0

  • Description: A String field corresponding to the value for the ad unit name of the current creative.

public static final String /APP_VERSION /+5.12.0

  • Description: A String field corresponding to the value of the app version.

public static String /COUNTRY /+5.7.0

  • Description: A String field corresponding to the value for the country of the current user’s device.

public static String /CURRENCY /+5.7.0

  • Description: A String field corresponding to the value for the currency.

public static String /IMPRESSION_ID /+5.7.0

  • Description: A String field corresponding to the value for the impression ID of the current creative.

public static String /NETWORK_NAME /+5.7.0

  • Description: A String field corresponding to the value for the ad network name of the current creative.

public static String /NETWORK_PLACEMENT_ID /+5.7.0

  • Description: A String field corresponding to the value for the ad network placement ID of the current creative.

public static String /PRECISION /+5.7.0

  • Description: A String field corresponding to the value for the precision level of the data.

public static String /PUBLISHER_REVENUE /+5.7.0

  • Description: A String field corresponding to the value for the likey payout of an impression.

Public Methods

public String /getAdGroupId() /+5.7.0

  • Description: Returns the ad group ID associated with the current creative.

  • Parameters: None.

public String /getAdGroupName() /+5.7.0

  • Description: Returns the ad group name associated with the current creative.

  • Parameters: None.

public Integer /getAdGroupPriority() /+5.7.0

  • Description: Returns the ad group priority associated with the current creative.

  • Parameters: None.

public String /getAdGroupType() /+5.7.0

  • Description: Returns the ad group type associated with the current creative.

  • Parameters: None.

public String /getAdUnitFormat() /+5.7.0

  • Description: Returns the ad unit format associated with the current creative.

  • Parameters: None.

public String /getAdUnitId() /5.7.0

  • Description: Returns the ad unit ID associated with the current creative.

  • Parameters: None.

public String /getAdUnitName() /+5.7.0

  • Description: Returns the ad unit name associated with the current creative.

  • Parameters: None.

public tring /getAppVersion() /+5.12.0

  • Description: Returns the version of the app.

  • Parameters: None.

public String /getCountry() /+5.7.0

  • Description: Returns the country name associated with the current user’s device location.

  • Parameters: None.

public String /getCurrency() /+5.7.0

  • Description: Returns the currency. Always USD.

  • Parameters: None.

public String /getImpressionId() /+5.7.0

  • Description: Returns the impression ID associated with the current creative.

  • Parameters: None.

public JSONObject /getJsonRepresentation() /+5.7.0

  • Description: Returns the JSON representation of impression-level revenue data otherwise available via the individual getters found in this class.

  • Parameters: None.

public String /getNetworkName() /+5.7.0

  • Description: Returns the ad network name if the creative is served by a supported ad network.

  • Parameters: None.

public String /getNetworkPlacementId() /+5.7.0

  • Description: Returns the ad network placement/zone/unit ID if the creative is served by a supported ad network.

  • Parameters: None.

public String /getPrecision() /+5.7.0

  • Description: Returns the precision level of the data. See explanation given for getPublisherRevenue() for possible values.

  • Parameters: None.

public Double /getPublisherRevenue() /+5.7.0

  • Description: Returns MoPub’s best understanding for the likely payout of an impression. This is determined in one of four ways:

    • the resulting price of a real-time auction (in this case, precision = ‘exact’)
    • the price obtained by MoPub’s Auto CPM product (in this case, precision = ‘estimated’)
    • the price assigned to the line item by the publisher (in this case, precision = ‘publisher_defined’)
    • when we do not have permission to share the impression data (in this case, precision = ‘undisclosed’)
  • Parameters: None.

Last updated July 10, 2020

TWITTER, MOPUB, and the Bird logo are trademarks of Twitter, Inc. or its affiliates. All third party logos and trademarks included are the property of their respective owners.

© 2020 MoPub (a division of Twitter, Inc.)