iOS Verizon Ads SDK Standard Edition Documentation  1.1
List of all members
VASAds Class Reference

Contains APIs for interacting with core functionality of the SDK, such as setting location, enabling COPPA and initializing the SDK. More...

#import <VASAds.h>

Inherits NSObject.

VASAds API

The API refers to the portion of this interface that is exposed for the purpose of integrating ad monetization into the application.

VASAdssharedInstance
 A shared instance of the Core SDK.
 
VASSDKInfosdkInfo
 Basic SDK build info.
 
VASLogLevel logLevel
 Global log level.
 
NSStringsiteId
 Site id that was used to initialize the Core SDK through the initializeWithSiteId: method.
 
BOOL initialized
 Indicates that the core was initialized for use. Successfully call the initializeWithSiteId: method to set this value to YES.
 
VASRequestMetadatarequestMetadata
 The default request metadata that is used when no other is provided.
 
BOOL locationEnabled
 Used to enable/disable location services within the VASAds SDK. More...
 
BOOL isAnonymous
 Indicates whether the user's personal data should be collected. More...
 
NSNumberCOPPA
 The COPPA (Children’s Online Privacy Protection Act) setting for ads. More...
 
BOOL shareAdvertiserId
 Indicates whether a creative can access the user‘s advertiser ID. More...
 
BOOL shareApplicationId
 Indicates whether a creative can access the application‘s bundle ID. More...
 
(BOOL- initializeWithSiteId:
 Initialize the Core for use with a specific site ID. More...
 
(void) - setConsentData:fromRestrictedOrigin:
 This method is used to provide user privacy consent data as well as to indicate if the user originates from a privacy restricted zone such as the EU. More...
 

Detailed Description

Contains APIs for interacting with core functionality of the SDK, such as setting location, enabling COPPA and initializing the SDK.

Method Documentation

◆ initializeWithSiteId:()

- (BOOL) initializeWithSiteId: (NSString *)  siteId

Initialize the Core for use with a specific site ID.

This method must be called before using any other components of the API. This method must be called on the main thread.

Parameters
siteIdThe site ID.
Returns
YES if initialized successfully, NO otherwise.

◆ setConsentData:fromRestrictedOrigin:()

- (void) setConsentData: (nullable NSDictionary< NSString *, id > *)  consentData
fromRestrictedOrigin: (BOOL restrictedOrigin 

This method is used to provide user privacy consent data as well as to indicate if the user originates from a privacy restricted zone such as the EU.

Parameters
consentDataDictionary that contains a mapping of a user consent data identifier to the consent data.
restrictedOriginYES indicates the user originates from a region that is governed by privacy regulations. Otherwise specify NO if not, or if the user's origin is unknown.

Property Documentation

◆ COPPA

- (NSNumber*) COPPA
readwriteatomicassign

The COPPA (Children’s Online Privacy Protection Act) setting for ads.

Read/write value that should be set based on user settings, if available. Note that this is effectively a BOOL value that can also be nil when not specified.

Set to @(YES) to indicate to ad buyers that COPPA restrictions need to be enforced for requests from this user. Set to @(NO) to not enforce restrictions. Defaults to nil which means the value will not be sent along with the request leaving it indeterminate for ad buyers.

Note that changing this value will only take effect on future ad requests, not those currently be processed.

◆ isAnonymous

- (BOOL) isAnonymous
readatomicassign

Indicates whether the user's personal data should be collected.

When YES is returned, components must not collect any personal user data. A NO indicates personal data may be collected and passed.

◆ locationEnabled

- (BOOL) locationEnabled
readwriteatomicassign

Used to enable/disable location services within the VASAds SDK.

When set to NO, SDK components must not access the user's location. Location information is only available and used, such as with ad requests, if location permissions are granted for the app and in accordance with the privacy settings such as GDPR requirements. Enabling this will NOT prompt the user for location authorization. Providing location data will help to serve more relevant ads to your users.

Set to NO to explicitly disable sending location information with ad requests. Default is YES except when overridden by the anonymous setting of YES which will prevent location data being sent.

◆ shareAdvertiserId

- (BOOL) shareAdvertiserId
readwriteatomic

Indicates whether a creative can access the user‘s advertiser ID.

Set to YES to enable the advertiser ID being shared, NO to restrict it. Default is NO.

Note that changing this value will only take effect on future ad requests, not those currently be processed.

◆ shareApplicationId

- (BOOL) shareApplicationId
readwriteatomic

Indicates whether a creative can access the application‘s bundle ID.

Set to YES to enable the bundle ID being shared, NO to restrict it. Default is NO.

Note that changing this value will only take effect on future ad requests, not those currently be processed.