YMAVideoAdsRequest Class Reference

Inherits from NSObject
Conforms to NSCopying
NSMutableCopying
Declared in YMAVideoAdsRequest.h

Overview

This class contains the parameters of the request to get specific ad blocks.

  1. Methods
    1. – initWithBlockID:blocksInfo:pageRef:targetRef:
  2. Properties
    1. blockID
    2. blocksInfo
    3. pageRef
    4. targetRef
    5. playerSize
    6. externalUserID
    7. publisherID
    8. publisherName
    9. contentID
    10. contentName
    11. genreID
    12. genreIDs
    13. genreNames
    14. tags
    15. bitrate
    16. charset
    17. extendedParameters

Methods

– initWithBlockID:blocksInfo:pageRef:targetRef:

Initializes an object of the YMAVideoAdsRequest class with mandatory request parameters.

- (id)initWithBlockID:(NSString *)blockID
           blocksInfo:(YMABlocksInfo *)blocksInfo
              pageRef:(NSString *)pageRef
            targetRef:(NSString *)targetRef

Parameters

blockID

The block ID received from YMABlock.

blocksInfo

An object of the YMABlocksInfo class.

pageRef

The page-ref parameter provided by the partner.

targetRef

The target-ref parameter provided by the partner.

Return Value

An object of the YMAVideoAdsRequest class with mandatory request parameters.

Properties

blockID

The block ID received from YMABlock for loading ads.

@property (nonatomic, copy, readonly) NSString *blockID

blocksInfo

An object of the YMABlocksInfo class.

@property (nonatomic, strong, readonly) YMABlocksInfo *blocksInfo

pageRef

The page-ref parameter provided by the partner.

@property (nonatomic, copy, readonly) NSString *pageRef

targetRef

The target-ref parameter provided by the partner.

@property (nonatomic, copy, readonly) NSString *targetRef

playerSize

The size of the player to be used for displaying video content.

@property (nonatomic, copy, readonly) NSValue *playerSize

externalUserID

External user ID in the ad space coordinates.

@property (nonatomic, copy, readonly) NSString *externalUserID

publisherID

ID of the content copyright holder.

@property (nonatomic, copy, readonly) NSString *publisherID

publisherName

Name of the content copyright holder.

@property (nonatomic, copy, readonly) NSString *publisherName

contentID

Content ID obtained from the ad space.

@property (nonatomic, copy, readonly) NSString *contentID

contentName

Name of the content.

@property (nonatomic, copy, readonly) NSString *contentName

genreID

Genre ID.

@property (nonatomic, copy, readonly) NSString *genreID

Discussion

Note: This property has been deprecated. Use the new property: genreIDs.

genreIDs

An array of genre IDs.

@property (nonatomic, copy, readonly) NSArray *genreIDs

genreNames

An array of genre names.

@property (nonatomic, copy, readonly) NSArray *genreNames

tags

An array of tags.

@property (nonatomic, copy, readonly) NSArray *tags

bitrate

Bitrate for the encoded video in kbps.

@property (nonatomic, assign, readonly) NSInteger bitrate

charset

Encoding options.

@property (nonatomic, copy, readonly) NSString *charset

Discussion

Acceptable options:

  • kYMAVideoAdsCharsetUTF8
  • kYMAVideoAdsCharsetCP1251 -kYMAVideoAdsCharsetKOI8R
  • kYMAVideoAdsCharsetKOI8U

By default, it uses the UTF-8 encoding that is defined by the kYMAVideoAdsChasetUTF8 constant.

extendedParameters

Additional parameters.

@property (nonatomic, copy, readonly) NSString *extendedParameters

Generated by appledoc 2.2.1 (build 1334).