Mobile-specific Parameters

Document created by pubmatic-archivist on Mar 27, 2017Last modified by catherine.racette on Sep 11, 2017
Version 7Show Document
  • View in full screen mode

This section includes the following sub-sections:

 

Mobile Application Profile-specific Parameters

If you have provided the following information with the PubMatic Ops Team as a part of the application registration for the respective platform, then you do not have to resend it.
However, if you were unable to provide this information at the time of the application registration with PubMatic Ops, we recommend that you send the following parameters with every ad request. This is recommended for the RTB partners for monetization and brand control.

Note:

  • All the following parameters' values should be URI encoded.
  • The following parameters are supported in both GET and POST requests.

 

                                                     

ParameterMandatory

Description

nameNo

Name of the mobile application. This value should be same as that mentioned on the application (app) store.

storeurl

Yes (for aggregators with in-app traffic)

URL of the app store from where a user can download this application. This URL must match the storeurl that is whitelisted on UI.

aidNo

Mobile application's ID on the exchange. This parameter is applicable only in the case of a mobile application view. In case of iOS App, this is recommended to be correctly passed by the caller.

bundleNo

Application bundle or package name (e.g., com.foo.mygame). This is intended to be a unique ID across multiple exchanges. In case of Android App, this is recommended to be correctly passed by the caller.

catNoApplication primary category as displayed on storeurl page for the respective platform.
apiNo

List of supported API frameworks for this impression. If an API is not explicitly listed, then it is assumed to be not supported.

If an application supports multiple API frameworks, you can send the multiple framework values separated by ::  and URL encoded string.

For example, api=3%3A%3A4%3A%3A5

                 

Value

Description

3

MRAID 1.0

4

ORMMA

5

MRAID 2.0

verNoVersion of the application
paidNoIndicates whether the mobile application is a paid version or not. Possible values are:
  • 0 - Free version
  • 1 - Paid version
appdomainNoIndicates the domain of the mobile application

 

Mobile Application-specific Parameters

 

                            

ParameterMandatoryDescription
udidYes*

A unique device identifier for the given udidtype.

Note: This parameter is mandatory for only Mobile Applications.

udidtype

Yes*

Type of value provided in the udid parameter mentioned above. Possible values are:

Note: This parameter is mandatory for only Mobile Applications.

udidhashYes*

Type of algorithm used for hashing the device identifier provided in the udid parameter mentioned above.

Possible values are:

  • 0 - Unknown
  • 1 - Raw
  • 2 - SHA1
  • 3 - MD5

Note: This parameter is mandatory for only Mobile Applications.

adRefreshRateNo

This parameter is used to specify the time interval (in seconds) after which the ad is refreshed. By default, this time interval is set to 0 second and therefore, the ad does not get refreshed automatically.

Note:

  • The ad refresh time will now be received from the PubMatic ad server. Even if this method is used, the ad refresh time received from the ad server will override this value.
  • This parameter is applicable only for mobile applications which have been integrated with the PubMatic Mobile SDK.

This value should be in the range of 12 to 120 seconds. If this value (x) is:

  • x < 0 - The library will automatically set this value to 12 seconds.
  • x = 0 - The ad will not get refreshed automatically.
  • 1 <= x < 12 - The library will automatically set this value to 12 seconds.
  • 12 >= x <= 120 - The ad will get refreshed after x seconds.
  • x > 120 - The library will automatically set this value to 120 seconds.

 

Mobile-specific Parameters (Web/Application)

 

                                                

Parameter

Mandatory

Description

nettype

No

Type of network used for the data connection. Possible values are:

  • wifi

  • cellular

carrier

No

Name of the carrier or ISP derived from the user's IP address.

js

No

Indicates whether the user's mobile device supports JavaScript or not. Possible values are:

  • 0 - Device does not support JavaScript

  • 1 - Device supports JavaScript

ormma

No

Minimum compliance level. Possible values are 0, 1 and 2.

adOrientation

No

ID of the ad orientation for the given ad request.

deviceOrientation

No

ID of the device orientation. Possible values are:

  • 0 - Portrait orientation

  • 1 - Landscape orientation

loccatNo

Category of the location in which the user is present. For the list of values, refer to the xAd documentation.

For example, loccat=[1,2]
locbrandNo

Category of the location in which the user is present. For the list of values, refer to the xAd documentation.

For example, loccat=[1,2]

Attachments

    Outcomes