PWAdsRequest Class Reference

Inherits from NSObject
Declared in PWAdsRequest.h

Overview

Class with ad request parameters.

  zoneID

The id string of the zone of publisher site.

@property (nonatomic, strong) NSString *zoneID

Discussion

The id string of the zone of publisher site.

Declared In

PWAdsRequest.h

  location

Geolocation for targeted ads.

@property (nonatomic, copy) CLLocation *location

Discussion

Geolocation for targeted ads.

Declared In

PWAdsRequest.h

  keywords

List of keywords to that describe a request.

@property (nonatomic, copy) NSArray *keywords

Discussion

List of keywords to that describe a request.

Declared In

PWAdsRequest.h

  numberOfAds

Number of ads requested. Only supported for requesting native ads.

@property (nonatomic, assign) NSInteger numberOfAds

Discussion

Number of ads requested. Only supported for requesting native ads.

Declared In

PWAdsRequest.h

  testMode

Whether request is for test ads. Default is NO.

@property (nonatomic, assign) BOOL testMode

Discussion

Whether request is for test ads. Default is NO.

Declared In

PWAdsRequest.h

  customData

Custom Data object for Rewarded Video ads request.

@property (nonatomic, copy) NSMutableDictionary *customData

Discussion

Custom Data object for Rewarded Video ads request.

Declared In

PWAdsRequest.h

  userID

User ID for Rewarded Video ads request.

@property (nonatomic, copy) NSString *userID

Discussion

User ID for Rewarded Video ads request.

Declared In

PWAdsRequest.h

– initWithZoneID:

Designated initializer for PWAdsRequest.

- (instancetype)initWithZoneID:(NSString *)zoneID

Parameters

zoneID

The id string of the zone of publisher site

Discussion

Designated initializer for PWAdsRequest.

Declared In

PWAdsRequest.h

+ requestWithZoneID:

Initializes and return a PWAdsRequest instance with given zoneID.

+ (PWAdsRequest *)requestWithZoneID:(NSString *)zoneID

Parameters

zoneID

The id string of the zone of publisher site.

Discussion

Initializes and return a PWAdsRequest instance with given zoneID.

Declared In

PWAdsRequest.h

  isTestMode

Whether request ads in test mode. Deprecated use testMode.

@property (nonatomic, readwrite, setter=setTestMode:) BOOL isTestMode

Discussion

Whether request ads in test mode. Deprecated use testMode.

Declared In

PWAdsRequest.h

  locationPrecision

An NSUInteger that sets the location precision information of the PWAdsRequest.

@property (nonatomic, assign) NSUInteger locationPrecision

Discussion

An NSUInteger that sets the location precision information of the PWAdsRequest.

Declared In

PWAdsRequest.h

+ requestWithAdZone:

Creates the PWAdsRequest object with the specified zone ID.

+ (PWAdsRequest *)requestWithAdZone:(NSString *)zone

Parameters

zone

The zone ID for which you want to request ads.

Discussion

Creates the PWAdsRequest object with the specified zone ID.

Declared In

PWAdsRequest.h

+ requestWithAdZone:andCustomParameters:

Creates the PWAdsRequest object with the specified zone ID and any custom parameters.

+ (PWAdsRequest *)requestWithAdZone:(NSString *)zone andCustomParameters:(NSDictionary *)theParams

Parameters

zone

The zone ID for which you want to request ads.
theParams

An NSDictionary with key / value pairs of custom parameters.

Discussion

Creates the PWAdsRequest object with the specified zone ID and any custom parameters.

Declared In

PWAdsRequest.h

– updateLocation:

Updates the PWAdsRequest object with the user’s location information.

- (void)updateLocation:(CLLocation *)location

Parameters

location

The user’s current location.

Discussion

Updates the PWAdsRequest object with the user’s location information.

Declared In

PWAdsRequest.h

– customParameterForKey:

Returns the custom parameter that is set in the PWAdsRequest object for the given key.

- (id)customParameterForKey:(NSString *)key

Parameters

key

The key for which you want to see the value.

Discussion

Returns the custom parameter that is set in the PWAdsRequest object for the given key.

Declared In

PWAdsRequest.h

– setCustomParameter:forKey:

Sets the custom parameter in the PWAdsRequest object for the given key.

- (id)setCustomParameter:(id)value forKey:(NSString *)key

Parameters

value

The value for which you want to set the key.
key

The key for which you want to set the value.

Discussion

Sets the custom parameter in the PWAdsRequest object for the given key.

Declared In

PWAdsRequest.h

– removeCustomParameterForKey:

Removes the custom parameter in the PWAdsRequest object for the given key.

- (id)removeCustomParameterForKey:(NSString *)key

Parameters

key

The key for which you want to remove the value.

Discussion

Removes the custom parameter in the PWAdsRequest object for the given key.

Declared In

PWAdsRequest.h