➤ AdRequest
PMBannerAdView.BannerAdViewDelegate
PMBannerAdView.BannerAdViewDelegate.
ActivityListenerPMBannerAdView.BannerAdViewDelegate.
FeatureSupportHandlerPMBannerAdView.BannerAdViewDelegate.
InternalBrowserListenerPMBannerAdView.BannerAdViewDelegate.
RequestListenerPMBannerAdView.BannerAdViewDelegate.
RichMediaListenerPMInterstitialAd.InterstitialAdListener
PMInterstitialAd.InterstitialAdListener.
ActivityListenerPMInterstitialAd.InterstitialAdListener.
FeatureSupportHandlerPMInterstitialAd.InterstitialAdListener.
InternalBrowserListenerPMInterstitialAd.InterstitialAdListener.
RequestListenerPMInterstitialAd.InterstitialAdListener.
RichMediaListenerPMNativeAd.NativeRequestListener
PMPrefetchManager.PMPrefetchListener
-
Class AdRequest
- Field Summary
- Constructor Summary
- Method Summary
- Methods inherited from class java.lang.Object
- Field Detail
- Constructor Detail
-
Method Detail
- getFormatter
- getAdServerURL
- initializeDefaultParams
- checkMandatoryParams
- setUpUrlParams
- setupPostData
- setUrlParams
- addUrlParam
- putPostData
- getContext
- setContext
- setCustomParams
- setAndroidAidEnabled
- isAndroidAidEnabled
- getAdSize
- setAdSize
- getUserAgent
- setUserAgent
- getUrlParams
- getRequestUrl
- getPostData
- getCustomParams
- setLocation
- getLocation
- getChannel
-
Class AdRequest
com.pubmatic.sdk.common
Class AdRequest
java.lang.Object
com.pubmatic.sdk.common.AdRequest
Direct Known Subclasses:
public abstract class AdRequest
extends java.lang.Object
Field Summary
| Modifier and Type | Field and Description |
|---|---|
protected boolean | Indicates whether the Advertising ID is sent in the request. |
protected com.pubmatic.sdk.common.CommonConstants.CHANNEL | mChannel |
protected android.content.Context | mContext |
protected java.util.Map<java.lang.String, java.util.List<java.lang.String>> | Lets publisher define custom Ad request parameters via Map. |
protected android.location.Location | mLocation |
protected PMAdSize | mPMAdSize |
protected java.lang.StringBuffer | mPostData |
protected com.pubmatic.sdk.common.RRFormatter | mRRFormatter |
protected java.util.Map<java.lang.String, java.lang.String> | Request URL params. |
protected java.lang.String | mUserAgent |
Constructor Summary
| Modifier | Constructor and Description |
|---|---|
protected |
|
Method Summary
| Modifier and Type | Method and Description |
|---|---|
protected void | addUrlParam(java.lang.String key, java.lang.String value) |
abstract boolean | checkMandatoryParams() |
protected abstract java.lang.String | Returns the base/hostname URL. |
PMAdSize | getAdSize() Returns the ad size set from setAdSize() |
com.pubmatic.sdk.common.CommonConstants.CHANNEL | getChannel() |
android.content.Context | getContext() |
java.util.Map<java.lang.String, java.util.List<java.lang.String>> | getCustomParams() |
abstract com.pubmatic.sdk.common.RRFormatter | getFormatter() |
android.location.Location | Returns the user's location. |
java.lang.String | getPostData() |
java.lang.String | getRequestUrl() |
java.util.Map<java.lang.String, java.lang.String> | getUrlParams() |
java.lang.String | getUserAgent() |
protected abstract void | initializeDefaultParams() |
boolean | isAndroidAidEnabled() |
protected void | putPostData(java.lang.String key, java.lang.String value) |
void | Sets the banner ad size in the ad request to the provided size. |
void |
Controls whether the Advertisement ID is sent in the request. |
void | setContext(android.content.Context mContext) |
void |
Adds custom key-value parameters in the Ad request. |
void |
Set the user's location. |
protected void | setupPostData() |
protected void | setUpUrlParams() |
protected void | setUrlParams(java.util.Map<java.lang.String,java.lang.String> urlParams) |
void | setUserAgent(java.lang.String userAgent) |
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Field Detail
mContext
protected android.content.Context mContext
mPostData
protected java.lang.StringBuffer mPostData
mLocation
protected android.location.Location mLocation
mPMAdSize
protected PMAdSize mPMAdSize
mUserAgent
protected java.lang.String mUserAgent
mChannel
protected com.pubmatic.sdk.common.CommonConstants.CHANNEL mChannel
mUrlParams
protected java.util.Map<java.lang.String,java.lang.String> mUrlParams
Request URL parameters.
mCustomParams
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> mCustomParams
Lets publishers define custom Ad request parameters via Map.
isAndroidAidEnabled
protected boolean isAndroidAidEnabled
Indicates whether Advertising ID or Android ID is sent in the request. Possible values are:
Parameters:
True - (default) sends Advertising ID in the request.
False - sends Android ID in the request.
mRRFormatter
protected com.pubmatic.sdk.common.RRFormatter mRRFormatter
Constructor Detail
AdRequest
protected AdRequest(com.pubmatic.sdk.common.CommonConstants.CHANNEL channel)
Method Detail
getFormatter
public abstract com.pubmatic.sdk.common.RRFormatter getFormatter()
getAdServerURL
protected abstract java.lang.String getAdServerURL()
The base/hostname URL.
initializeDefaultParams
protected abstract void initializeDefaultParams()
checkMandatoryParams
public abstract boolean checkMandatoryParams()
setUpUrlParams
protected void setUpUrlParams()
setupPostData
protected void setupPostData()>
setUrlParams
protected void setUrlParams(java.util.Map<java.lang.String,java.lang.String> urlParams)
addUrlParam
protected void addUrlParam(java.lang.String key, java.lang.String value)
putPostData
protected void putPostData(java.lang.String key, java.lang.String value)
getContext
public android.content.Context getContext()
setContext
public void setContext(android.content.Context mContext)
setCustomParams
public void setCustomParams(java.lang.String key, java.lang.String value)
Adds custom key-value parameters in the Ad request.
Parameters:
key - a string that defines the custom key name.
value - a string that defines the custom key value.
setAndroidAidEnabled
public void setAndroidAidEnabled(boolean isAndroidAidEnabled)
Controls whether the Advertisement ID is sent in the request.
isAndroidAidEnabled - a Boolean value. TRUE (default) sends the Advertising ID in the ad request. FALSE sends the vendor ID in the ad request.
isAndroidAidEnabled
public boolean isAndroidAidEnabled()
Returns:
TRUE by default.
getAdSize
public PMAdSize getAdSize()
Returns the ad size set using setAdSize().
Returns:
The size of a banner ad.
setAdSize
public void setAdSize(PMAdSize adSize)
Sets the banner ad size in the ad request with the provided size.
getUserAgent
public java.lang.String getUserAgent()
setUserAgent
public void setUserAgent(java.lang.String userAgent)
getUrlParams
public java.util.Map<java.lang.String,java.lang.String> getUrlParams()
getRequestUrl
public final java.lang.String getRequestUrl()
getPostData
public java.lang.String getPostData()
getCustomParams
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getCustomParams()
setLocation
public void setLocation(android.location.Location location)
Sets the user's location.
Parameters:
location - User's location.
getLocation
public android.location.Location getLocation()
Returns:
User's location.
getChannel
public com.pubmatic.sdk.common.CommonConstants.CHANNEL getChannel()