SearchAdRequest

public final class SearchAdRequest extends Object

Contains the query and other optional configurations used to request an ad with the SearchAdController.

Nested Class Summary

class

SearchAdRequest.Builder

Builds a SearchAdRequest.

Public Method Summary

String	getHostLanguage() Returns the primary language of the ad.
String	getPriceCurrency() Returns the price currency that will be used when filtering products by price, or an empty string if no price currency was set.
String	getPriceMax() Returns the maximum price (in the currency specified with getPriceCurrency()) for ads to be returned, or an empty string if no maximum price was set.
String	getPriceMin() Returns the minimum price (in the currency specified with getPriceCurrency()) for ads to be returned, or an empty string if no minimum price was set.
String	getQuery() Returns the query entered by the user.
String	getSpaRestricts() Returns filter options for SPA, as a string of `,` separated list of `key:value` pairs, or an empty string if no restrict was set.
String	getTestGeolocation() Returns the user's location set for testing purposes, or an empty location if no test location was set.
SearchAdRequest.Builder	toBuilder() Returns a new builder with the same options set as this SearchAdRequest.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public String getHostLanguage ()

Returns the primary language of the ad.

public String getPriceCurrency ()

Returns the price currency that will be used when filtering products by price, or an empty string if no price currency was set.

public String getPriceMax ()

Returns the maximum price (in the currency specified with getPriceCurrency()) for ads to be returned, or an empty string if no maximum price was set.

public String getPriceMin ()

Returns the minimum price (in the currency specified with getPriceCurrency()) for ads to be returned, or an empty string if no minimum price was set.

public String getQuery ()

Returns the query entered by the user.

public String getSpaRestricts ()

Returns filter options for SPA, as a string of `,` separated list of `key:value` pairs, or an empty string if no restrict was set.

public String getTestGeolocation ()

Returns the user's location set for testing purposes, or an empty location if no test location was set.

public SearchAdRequest.Builder toBuilder ()

Returns a new builder with the same options set as this SearchAdRequest.