GANSearchAdRequest Class

GANSearchAdRequest Class Reference

Overview

Typically, the client of the SDK will instantiate a GANSearchAdRequest with the appropriate query and then it will use to load ads through the GANSearchAdController (-loadAds:).

Inherits NSObject. Implements <NSCopying>.

Property Summary

NSString * query
 The search query, such as "flowers". More...
 
NSString * priceCurrency
 The price currency (as case-insensitive three-letter ISO currency code) to use for filtering products by price with priceMin or priceMax (optional). More...
 
NSString * priceMin
 The minimum product price (in the currency specified with priceCurrency) for ads to be returned (optional). More...
 
NSString * priceMax
 The maximum product price (in the currency specified with priceCurrency) for ads to be returned (optional). More...
 
NSString * testGeolocation
 For testing purposes, sets the user's location to return location-targeted shopping ads (optional). More...
 

Property Detail

- (NSString*) query
readwritenonatomiccopy

The search query, such as "flowers".

It must be a non empty string. It should not be URL-encoded.

- (NSString*) priceCurrency
readwritenonatomiccopy

The price currency (as case-insensitive three-letter ISO currency code) to use for filtering products by price with priceMin or priceMax (optional).

Only valid for Sponsored Product Ads (SPA). Must be specified if priceMin or priceMax is set. The price filter will not be applied if the provided currency code does not match the currency of the returned ads.

- (NSString*) priceMin
readwritenonatomiccopy

The minimum product price (in the currency specified with priceCurrency) for ads to be returned (optional).

Only valid for Sponsored Product Ads (SPA). priceCurrency must be set if this option is specified. The price filter will not be applied if the provided currency code does not match the currency of the returned ads.

The given price should contain only numeric characters and periods (e.g. "19.95") and must not contain currency symbols (e.g. "$") or commas (",").

These values are not sanitized in the SDK. Invalid values may result in request failures.

- (NSString*) priceMax
readwritenonatomiccopy

The maximum product price (in the currency specified with priceCurrency) for ads to be returned (optional).

Only valid for Sponsored Product Ads (SPA). priceCurrency must be set if this option is specified. The price filter will not be applied if the provided currency code does not match the currency of the returned ads.

The given price should contain only numeric characters and periods (e.g. "19.95") and must not contain currency symbols (e.g. "$") or commas (",").

These values are not sanitized in the SDK. Invalid values may result in request failures.

- (NSString*) testGeolocation
readwritenonatomiccopy

For testing purposes, sets the user's location to return location-targeted shopping ads (optional).

Only valid for AdSense for Shopping (AFSh) ads with adtest on. Provide the two-letter country code, case-insensitive.