AdColonyAppOptions Class Reference

Inherits from AdColonyOptions : NSObject
Declared in AdColonyAppOptions.h

Overview

AdColonyAppOptions objects are used to set configurable aspects of SDK state and behavior, such as a custom user identifier. The common usage scenario is to instantiate and configure one of these objects and then pass it to configureWithAppID:zoneIDs:options:completion:. Set the properties below to configure a pre-defined option. Note that you can also pass arbitrary options using the AdColonyOptions API. Also note that you can also reset the current options object the SDK is using by passing an updated object to setAppOptions:. This class in NOT thread safe.

Properties

  disableLogging

Disables AdColony logging.

@property (nonatomic, assign) BOOL disableLogging

Discussion

AdColony logging is enabled by default. Set this property before calling configureWithAppID:zoneIDs:options:completion: with a corresponding value of YES to disable AdColony logging.

Declared In

AdColonyAppOptions.h

  userID

Sets a custom identifier for the current user.

@property (nonatomic, nullable, strong) NSString *userID

Discussion

Set this property to configure a custom identifier for the current user. Corresponding value must be 128 characters or less.

Declared In

AdColonyAppOptions.h

  adOrientation

Sets the desired ad orientation.

@property (nonatomic, assign) AdColonyOrientation adOrientation

Discussion

Set this property to configure the desired orientation for your ads.

See Also

Declared In

AdColonyAppOptions.h

  testMode

Enables test ads for your application without changing dashboard settings.

@property (nonatomic, assign) BOOL testMode

Discussion

Set this property to YES to enable test ads for your application without changing dashboard settings.

Declared In

AdColonyAppOptions.h

  mediationNetwork

Sets the name of the mediation network you are using AdColony with.

@property (nonatomic, nullable, strong) NSString *mediationNetwork

Discussion

Set this property to configure the name of the mediation network you are using AdColony with. Corresponding value must be 128 characters or less. Note that you should use one of the pre-defined values above if applicable.

Declared In

AdColonyAppOptions.h

  mediationNetworkVersion

Sets the version of the mediation network you are using AdColony with.

@property (nonatomic, nullable, strong) NSString *mediationNetworkVersion

Discussion

Set this property to configure the version of the mediation network you are using AdColony with. Corresponding value must be 128 characters or less.

Declared In

AdColonyAppOptions.h

  plugin

Sets the name of the plugin you are using AdColony with.

@property (nonatomic, nullable, strong) NSString *plugin

Discussion

Set this property to configure the name of the plugin you are using AdColony with. Corresponding value must be 128 characters or less. Note that you should use one of the pre-defined values above if applicable.

Declared In

AdColonyAppOptions.h

  pluginVersion

Sets the version of the plugin version you are using AdColony with.

@property (nonatomic, nullable, strong) NSString *pluginVersion

Discussion

Set this property to configure the version of the plugin you are using AdColony with. Corresponding value must be 128 characters or less.

Declared In

AdColonyAppOptions.h

  gdprRequired

This is to inform the AdColony service if GDPR should be considered for the user based on if they are they EU citizens or from EU territories. Default is FALSE.

@property (nonatomic, assign) BOOL gdprRequired

Discussion

This is for GDPR compliance, see https://www.adcolony.com/gdpr/

Declared In

AdColonyAppOptions.h

  gdprConsentString

Defines end user’s consent for information collected from the user.

@property (nonatomic, nullable, strong) NSString *gdprConsentString

Discussion

The IAB Europe Transparency and Consent framework defines standard APIs and formats for communicating between Consent Management Platforms (CMPs) collecting consents from end users and vendors embedded on a website or in a mobile application. It provides a unified interface for a seamless integration where CMPs and vendors do not have to integrate manually with hundreds of partners. This is for GDPR compliance through IAB, see https://github.com/InteractiveAdvertisingBureau/GDPR-Transparency-and-Consent-Framework/blob/master/v1.1%20Implementation%20Guidelines.md#vendors

Declared In

AdColonyAppOptions.h

– setPrivacyFrameworkOfType:isRequired:

Set privacy framework required key in the app options.

- (AdColonyAppOptions *)setPrivacyFrameworkOfType:(NSString *)type isRequired:(BOOL)required

Parameters

type

one of the constants defined in this class ADC_GDPR, ADC_CCPA, ADC_COPPA.
required

whether or not we need to consider the privacy framework of the specified type for this user.

Return Value

updated app options.

Discussion

Use this API to provide AdColony with whether or not following the specified privacy framework is required for the user.

Declared In

AdColonyAppOptions.h

– setPrivacyConsentString:forType:

Set consent string for privacy framework in the app options.

- (AdColonyAppOptions *)setPrivacyConsentString:(NSString *)consentString forType:(NSString *)type

Parameters

consentString

the user’s consent string of the specified type. For GDPR, this should either be “0” or “1” (representing do not consent, or consent), or the IAB standard consent String. For CCPA, this should either be “0”, or “1” (representing do not sell = true, or do not sell = false), or the IAB standard consent String.
type

one of the constants defined in this class ADC_GDPR, ADC_CCPA.

Return Value

updated app options.

Discussion

Use this API to provide AdColony with the user’s consent string of the specified type if applicable.

Declared In

AdColonyAppOptions.h

– getPrivacyFrameworkRequiredForType:

Get privacy framework required key set in the app options.

- (BOOL)getPrivacyFrameworkRequiredForType:(NSString *)type

Parameters

type

one of the constants defined in this class ADC_GDPR, ADC_CCPA, ADC_COPPA.

Return Value

the value for the consent requirement of the specified type has been set, or NO if it has not.

Discussion

Use this API to retrieve the specified privacy framework required key set in the app options.

Declared In

AdColonyAppOptions.h

– getPrivacyConsentStringForType:

Get privacy framework consent string set in the app options.

- (NSString *)getPrivacyConsentStringForType:(NSString *)type

Parameters

type

one of the constants defined in this class ADC_GDPR, ADC_CCPA.

Return Value

the value for the specified consent string or nil value if it has not been set.

Discussion

Use this API to retrieve the specified privacy consent string set in the app options.

Declared In

AdColonyAppOptions.h