AdManager

@interface AdManager : NSObject

+ (AdManager *)sharedManager;

/**
 * Get ad manager version
 * @return ad manager version
 */
- (NSString*)getVersion;

/**
 * Set Google consent settings
 * It has to be set before PAL parameters
 * @param consentSettings consent settings, please refer to the Google PAL documentation
 */
- (void)setConsentSettings:(NSObject *)consentSettings;

/**
 * Set Google PAL parameters
 *
 * @param descriptionURL Google PAL parameter, set nil if not used
 * @param partnerName Google PAL parameter, set nil if not used
 * @param partnerVersion Google PAL parameter, set nil if not used
 * @param omidVersion Google PAL parameter, set nil if not used
 * @param playerType Google PAL parameter, set nil if not used
 * @param playerVersion Google PAL parameter, set nil if not used
 * @param ppid Google PAL parameter, set nil if not used
 * @param videoPlayerHeight Google PAL parameter, set 0 if not used
 * @param videoPlayerWidth Google PAL parameter, set 0 if not used
 * @param willAdAutoPlay Google PAL parameter, set false if not used
 * @param willAdPlayMuted Google PAL parameter, set false if not used
 */
- (void)setPalParameters:(NSString *)descriptionURL
             partnerName:(NSString *)partnerName
          partnerVersion:(NSString *)partnerVersion
             omidVersion:(NSString *)omidVersion
              playerType:(NSString *)playerType
           playerVersion:(NSString *)playerVersion
                    ppid:(NSString *)ppid
       videoPlayerHeight:(NSUInteger)videoPlayerHeight
        videoPlayerWidth:(NSUInteger)videoPlayerWidth
          willAdAutoPlay:(BOOL)willAdAutoPlay
         willAdPlayMuted:(BOOL)willAdPlayMuted;

/**
 * Activate advertising workflow (including analytics and tracking)
 * The method setAdParameter automatically calls this method
 */
- (void)activateAdvertising;

/**
 * This method set a parameter used for the ad insertion
 * Activate the advertising workflow
 * @param name  Parameter name
 * @param value Parameter value
 */
- (void)setAdParameter:(NSString *)name value:(NSString *)value;

/**
 * Set the ad events listener
 * Reset at SmartLib release
 *
 * @param listener Ad events listener
 */
- (void)setAdEventsListener:(nullable id<AdEventsListener>) listener;

@end

Undocumented

  • Undocumented

    Declaration

    Objective-C

    + (AdManager *)sharedManager;
  • Get ad manager version

    Declaration

    Objective-C

    - (nonnull NSString *)getVersion;

    Return Value

    ad manager version

  • Set Google consent settings It has to be set before PAL parameters

    Declaration

    Objective-C

    - (void)setConsentSettings:(nonnull NSObject *)consentSettings;

    Parameters

    consentSettings

    consent settings, please refer to the Google PAL documentation

  • Set Google PAL parameters

    Declaration

    Objective-C

    - (void)setPalParameters:(nonnull NSString *)descriptionURL
                 partnerName:(nonnull NSString *)partnerName
              partnerVersion:(nonnull NSString *)partnerVersion
                 omidVersion:(nonnull NSString *)omidVersion
                  playerType:(nonnull NSString *)playerType
               playerVersion:(nonnull NSString *)playerVersion
                        ppid:(nonnull NSString *)ppid
           videoPlayerHeight:(NSUInteger)videoPlayerHeight
            videoPlayerWidth:(NSUInteger)videoPlayerWidth
              willAdAutoPlay:(BOOL)willAdAutoPlay
             willAdPlayMuted:(BOOL)willAdPlayMuted;

    Parameters

    descriptionURL

    Google PAL parameter, set nil if not used

    partnerName

    Google PAL parameter, set nil if not used

    partnerVersion

    Google PAL parameter, set nil if not used

    omidVersion

    Google PAL parameter, set nil if not used

    playerType

    Google PAL parameter, set nil if not used

    playerVersion

    Google PAL parameter, set nil if not used

    ppid

    Google PAL parameter, set nil if not used

    videoPlayerHeight

    Google PAL parameter, set 0 if not used

    videoPlayerWidth

    Google PAL parameter, set 0 if not used

    willAdAutoPlay

    Google PAL parameter, set false if not used

    willAdPlayMuted

    Google PAL parameter, set false if not used

  • Activate advertising workflow (including analytics and tracking) The method setAdParameter automatically calls this method

    Declaration

    Objective-C

    - (void)activateAdvertising;
  • This method set a parameter used for the ad insertion Activate the advertising workflow

    Declaration

    Objective-C

    - (void)setAdParameter:(nonnull NSString *)name value:(nonnull NSString *)value;

    Parameters

    name

    Parameter name

    value

    Parameter value

  • Set the ad events listener Reset at SmartLib release

    Declaration

    Objective-C

    - (void)setAdEventsListener:(nullable id<AdEventsListener>)listener;

    Parameters

    listener

    Ad events listener