GANSearchAdControllerOptions Class

GANSearchAdControllerOptions Class Reference

Overview

Enables clients to customize the ad controller.

Inherits NSObject. Implements <NSCopying>.

Property Summary

BOOL prefetchEnabled
 Controls the behavior of the GANSearchAdController when available ads are running low. More...
 
NSInteger adFetchCount
 The number of ads to retrieve at a time. More...
 
GANSearchAdType adType
 The type of ads to request. More...
 
NSString * channel
 An arbitrary string that can be used to tag groups of requests so they can be recognized in a log file and then analyzed. More...
 
NSString * adSafe
 Specifies the filtering rules that Google should apply to ads matching the search query (optional). More...
 
BOOL adTest
 Sets whether the request for ads is a test (optional). More...
 
BOOL personalizedAds
 Sets whether personalized ads should be delivered for the user. More...
 

Property Detail

- (BOOL) prefetchEnabled
readwritenonatomicassign

Controls the behavior of the GANSearchAdController when available ads are running low.

If true and if the number of available ads (ads that have loaded) is running low, the GANSearchAdController will automatically request additional ads to the server.

Defaults to NO.

- (NSInteger) adFetchCount
readwritenonatomicassign

The number of ads to retrieve at a time.

Defaults to GANDefaultMaxAds .

- (GANSearchAdType) adType
readwritenonatomicassign

The type of ads to request.

See GANSearchAdType for options. Defaults to GANSearchAdTypeText

- (NSString*) channel
readwritenonatomiccopy

An arbitrary string that can be used to tag groups of requests so they can be recognized in a log file and then analyzed.

- (NSString*) adSafe
readwritenonatomiccopy

Specifies the filtering rules that Google should apply to ads matching the search query (optional).

The following are the valid settings for adsafe and the effect each value has on returned ads:

"high" Returns family-safe ads. Does not return non-family-safe or adult sexual content ads.

"medium" Returns family-safe and non-family-safe ads. Does not return adult sexual content ads.

"low" Returns all types of ads.

Defaults to high.

- (BOOL) adTest
readwritenonatomicassign

Sets whether the request for ads is a test (optional).

When adTest is true, Google treats the request as a test and does not count the ad impressions or track the clickthrough results. Set this option when testing, but not in production systems or you will not be paid for ads that you display.

Defaults to NO.

- (BOOL) personalizedAds
readwritenonatomicassign

Sets whether personalized ads should be delivered for the user.

The option will only be sent as part of the request if the value is set. Once the value is set it cannot be unset.

Defaults to unset