PublisherAdRequest

public final class PublisherAdRequest extends Object

A PublisherAdRequest contains targeting information used to fetch an ad from DoubleClick for Publishers. Ad requests are created using PublisherAdRequest.Builder.

Nested Class Summary

class PublisherAdRequest.Builder Builds a PublisherAdRequest

Constant Summary

String DEVICE_ID_EMULATOR The deviceId for emulators to be used with addTestDevice(String).
int ERROR_CODE_INTERNAL_ERROR Something happened internally; for instance, an invalid response was received from the ad server.
int ERROR_CODE_INVALID_REQUEST The ad request was invalid; for instance, the ad unit ID was incorrect.
int ERROR_CODE_NETWORK_ERROR The ad request was unsuccessful due to network connectivity.
int ERROR_CODE_NO_FILL The ad request was successful, but no ad was returned due to lack of ad inventory.
int GENDER_FEMALE Female gender.
int GENDER_MALE Male gender.
int GENDER_UNKNOWN Unknown gender.

Public Method Summary

Date
getBirthday()
Returns the user's birthday targeting information.
String
getContentUrl()
Returns the content url targeting information.
<T extends CustomEvent> Bundle
getCustomEventExtrasBundle(Class<T> adapterClass)
Returns extra parameters to pass to a specific custom event adapter.
Bundle
getCustomTargeting()
Returns the custom targeting parameters.
int
getGender()
Returns the user's gender targeting information.
Set<String>
getKeywords()
Returns targeting information keywords.
Location
getLocation()
Returns the user's location targeting information.
boolean
getManualImpressionsEnabled()
Returns true if manual impression reporting is enabled.
<T extends NetworkExtras> T
getNetworkExtras(Class<T> networkExtrasClass)
Returns extra parameters to pass to a specific ad network adapter.
<T extends MediationAdapter> Bundle
getNetworkExtrasBundle(Class<T> adapterClass)
Returns extra parameters to pass to a specific ad network adapter.
String
getPublisherProvidedId()
Returns the identifier used for frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.
boolean
isTestDevice(Context context)
Returns true if this device will receive test ads.
static void
updateCorrelator()
Changes the correlator that is sent with ad requests, effectively starting a new page view.

Inherited Method Summary

Constants

public static final String DEVICE_ID_EMULATOR

The deviceId for emulators to be used with addTestDevice(String).

Constant Value: "B3EEABB8EE11C2BE770B684D95219ECB"

public static final int ERROR_CODE_INTERNAL_ERROR

Something happened internally; for instance, an invalid response was received from the ad server.

Constant Value: 0

public static final int ERROR_CODE_INVALID_REQUEST

The ad request was invalid; for instance, the ad unit ID was incorrect.

Constant Value: 1

public static final int ERROR_CODE_NETWORK_ERROR

The ad request was unsuccessful due to network connectivity.

Constant Value: 2

public static final int ERROR_CODE_NO_FILL

The ad request was successful, but no ad was returned due to lack of ad inventory.

Constant Value: 3

public static final int GENDER_FEMALE

Female gender.

Constant Value: 2

public static final int GENDER_MALE

Male gender.

Constant Value: 1

public static final int GENDER_UNKNOWN

Unknown gender.

Constant Value: 0

Public Methods

public Date getBirthday ()

Returns the user's birthday targeting information. Returns null if the birthday was not set.

public String getContentUrl ()

Returns the content url targeting information. Returns null if the contentUrl was not set.

public Bundle getCustomEventExtrasBundle (Class<T> adapterClass)

Returns extra parameters to pass to a specific custom event adapter. Returns null if no custom event extras of the provided type were set.

public Bundle getCustomTargeting ()

Returns the custom targeting parameters.

public int getGender ()

Returns the user's gender targeting information. Returns -1 if the gender was not set.

public Set<String> getKeywords ()

Returns targeting information keywords. Returns an empty Set if no keywords were added.

public Location getLocation ()

Returns the user's location targeting information. Returns null if the location was not set.

public boolean getManualImpressionsEnabled ()

Returns true if manual impression reporting is enabled.

public T getNetworkExtras (Class<T> networkExtrasClass)

Returns extra parameters to pass to a specific ad network adapter. Ad network adapters provide a NetworkExtras class. Returns null if no network extras of the provided type were set.

public Bundle getNetworkExtrasBundle (Class<T> adapterClass)

Returns extra parameters to pass to a specific ad network adapter. Returns null if no network extras of the provided type were set.

public String getPublisherProvidedId ()

Returns the identifier used for frequency capping, audience segmentation and targeting, sequential ad rotation, and other audience-based ad delivery controls across devices.

public boolean isTestDevice (Context context)

Returns true if this device will receive test ads.

public static void updateCorrelator ()

Changes the correlator that is sent with ad requests, effectively starting a new page view. The correlator is the same for all the ad requests coming from one page view, and unique across page views. After updating the correlator, ads must be refreshed for the new correlator to take effect.