Advanced Settings

Begin by completing the instructions in the basic integration article, followed by the instructions to integrate any of the ad formats you plan to display (interstitial ads, rewarded ads, banner ads, native ads). This article contains supplementary information and assumes you have completed basic and ad format integration.

Apple’s App Store Privacy Questionnaire

Apple has published details on their privacy requirements for the App Store. According to Apple’s announcement, app developers must define which data are collected by their apps and any SDKs they have integrated.

To help you answer this questionnaire with respect to your integration of the Vungle SDK, refer to the following table, which maps Vungle's data collection and use to the data types that Apple asks about in its questionnaire.

A couple of disclaimers:

  • This list is only applicable to Apple privacy questionnaire, and it does not address data or privacy questions that may be raised by other parties. Please always refer to our Privacy Policy for more detailed information.
  • This list only describes Vungle's SDK and data collection. This list does not describe a developer’s overall app data collection and use, or that of any other SDK.
Category/Data Collected? Used for tracking? Purpose
Contact info      
Name No

N/A

N/A

Email Address

No

N/A

N/A

Phone Number

No

N/A

N/A

Physical Address

No

N/A

N/A

Other User Contact Info

No

N/A

N/A

Health and Fitness

 

 

 

Health

No

N/A

N/A

Fitness

No

N/A

N/A

Financial Info

 

 

 

Payment Info

No

N/A

N/A

Credit Info

No

N/A

N/A

Other Financial Info

No

N/A

N/A

Location

 

 

 

Precise Location

No

N/A

N/A

Coarse Location

Yes

Yes

Third-party advertising and analytics

Sensitive Info

 

 

 

Sensitive Info

No

N/A

N/A

Contacts

 

 

 

Contacts

No

N/A

N/A

User Content

 

 

 

Emails or Text Messages

No

N/A

N/A

Photos or Videos

No

N/A

N/A

Audio Data

No

N/A

N/A

Gameplay Content

No

N/A

N/A

Customer Support

No

N/A

N/A

Other User Content

No

N/A

N/A

Browsing History

 

 

 

Browsing History

No

N/A

N/A

Search History

 

 

 

Search History

No

N/A

N/A

Identifiers

 

 

 

User ID

No

N/A

N/A

Device ID

Yes

Yes

Third-party advertising and analytics

ATT Status

Yes

N/A

Used for 3rd-party advertiser analytics

Purchases

 

 

 

Purchase History

No

N/A

N/A

Usage Data

 

 

 

Product Interaction

Yes

No

Third-party advertising and analytics

Advertising Data

Yes

Yes

Third-party advertising and analytics

Other Usage Data

No

N/A

N/A

Diagnostics

 

 

 

Crash Data

No

N/A

N/A

Performance Data

Yes

No

Third-party advertising and analytics

Other Diagnostic Data

No

N/A

N/A

Other Data

 

 

 

Other Data Types

No

N/A

N/A

GDPR Recommended Implementation Instructions

As of May 25, 2019, the General Data Protection Regulation (GDPR) will be enforced in the European Union. To comply with GDPR, developers have two options.

  • Option 1 (recommended): Publisher controls the GDPR consent process at the user level, then communicates the user’s choice to Vungle. To do this, developers can collect the user’s consent using their own mechanism, and then use Vungle APIs to update or query the user’s consent status. Refer to the sample code below for details.
  • Option 2: Allow Vungle to handle the requirements. Vungle will display a consent dialog before playing an ad for a European user, and will remember the user’s consent or rejection for subsequent ads.

To use Vungle APIs to update or query the user’s consent status (as recommended in Option 1), use these functions for Vungle SDK v.6.3.2 and higher:

SwiftObjective-C
// GDPR - Opt In
VunglePrivacySettings.setGDPRStatus(true)
      
// GDPR - Opt Out
VunglePrivacySettings.setGDPRStatus(false)

Optionally, you can also set the GDPR message version: this is an arbitrary string that can be used to identify the message with which the user was prompted when making their selection.

SwiftObjective-C
// GDPR - Set Message Version
VunglePrivacySettings.setGDPRMessageVersion("v1.2.3")

CCPA Recommended Implementation Instructions

As of July 1, 2020, California Consumer Privacy Act (CCPA) will be enforced and publishers must update to iOS SDK 6.7.0 or higher to comply with CCPA. In accordance with CCPA, the consent status is opted in by default unless VunglePrivacySettings.setCCPAStatus() has been explicitly called to set it as opted out.

SwiftObjective-C
// CCPA - Opt In
VunglePrivacySettings.setCCPAStatus(true)
      
// CCPA - Opt Out
VunglePrivacySettings.setCCPAStatus(false)

COPPA Implementation

Generally speaking, the Children’s Online Privacy Protection Act (COPPA) regulates the collection, use, and disclosure of personal information for children under the age of 13 by certain websites and online services (including mobile apps). Compliance with COPPA is a legal issue and we suggest you seek the advice of an attorney in determining compliance. Additionally, for more information on COPPA, please refer to the Federal Trade Commission's COPPA FAQ.

Vungle has tools to assist publishers with COPPA compliance. In addition to use of settings on the Monetize Dashboard, Vungle offers features within the Vungle SDK using the COPPA API. This is available for early access with iOS SDK v.6.11.0.

COPPA Compliance at the App Level

Vungle provides tooling in the Monetize Dashboard to indicate COPPA compliance for each app. When defining your app in the Monetize Dashboard, you must indicate to Vungle whether your app is directed toward children under age 13. Depending on your setting, Vungle will globally treat all traffic for the app as subject to COPPA or not. If you indicate that your app is not directed toward children under 13, COPPA settings will not apply at the app level, and can then be indicated at a more granular level (see COPPA Compliance at the Device Level).

COPPA Compliance at the Device Level

Starting with SDK v.6.11 early access, Vungle provides an optional method for you to indicate at the device level whether the user within the given mobile app is under or over the age of 13 by using the SDK COPPA API. The SDK COPPA API is most appropriate in cases of apps that legally can implement an age screen or age gate in accordance with COPPA, rather than treating all users as under 13. If you believe your app as a whole is primarily directed to children under the age of 13 as set forth in COPPA and related guidance, the COPPA Dashboard settings are more appropriate for you.

Recommendations for Using Vungle's COPPA Compliance Tools

Pursuant to the Vungle SDK License and Publisher Terms, it is the publisher’s responsibility to ensure compliance with applicable laws, including COPPA. Vungle is not liable for COPPA violations resulting from incorrect settings communicated via the SDK COPPA API. Consider the following recommendations to help you ensure COPPA compliance.

  • Use the SDK COPPA API for mixed-audience apps. Use the SDK COPPA API if:
    • You have confirmed you are a “mixed-audience app” under COPPA
    • You have implemented an age gate or age screen
    • You have stated that for your app “COPPA settings will NOT apply” in the Publisher Dashboard (otherwise, a COPPA-compliant setting in your Dashboard will override any API settings to the contrary)
  • Use the Dashboard for apps directed towards children under 13: In cases where it is clear that your app is primarily directed to children under the age of 13, use the COPPA settings section in the Publisher Dashboard instead of the SDK COPPA API.
  • Conflicting settings between API and Dashboard: As noted above, you can establish COPPA settings at the app level (but not at the user level) on the Publisher Dashboard, and at the device/user level by using the SDK COPPA API. Under the current release of SDK COPPA API functionality, in the event of a conflict between the settings in Publisher Dashboard and those passed via the SDK COPPA API, the COPPA-compliant setting takes precedence.

    For example, if your app setting on the Publisher Dashboard is COPPA-compliant, and that same app also enables use of the SDK COPPA API and identifies a given user as over 13, Vungle will defer to the Dashboard setting, which states that all the users in this app are protected by COPPA regulations. If, on the other hand, your app setting on the Publisher Dashboard states that your app is not directed toward users under the age of 13, but a call to the SDK COPPA API identifies a given user as under age 13, Vungle will override the dashboard setting and treat that user as being protected by COPPA regulations.

COPPA API

To ensure that the user’s COPPA status can be used on SDK initialization, the SDK COPPA API should be called before calling the init method. To update Vungle about a user’s COPPA status:

  1. Use VunglePrivacySettings.setCOPPAStatus(bool) where BOOL is set to `true` for a user who is under the age of 13 and falls under COPPA regulations; `false` for a user known to be over the age of 13.
  2. Then call [[VungleSDK sharedSDK] startWithAppID: options: error:], as shown:

Usage example:

SwiftObjective-C
// COPPA - Opt In
VunglePrivacySettings.setCOPPAStatus(true)
      
// COPPA - Opt Out
VunglePrivacySettings.setCOPPAStatus(false)

Restrict Use of IDFV

Starting with Vungle SDK v6.4.3, you can prevent passing the IDFV from the device to the SDK.

Sample code:

SwiftObjective-C
// Publish IDFV
VunglePrivacySettings.setPublishIdfv(true)
        
// Restrict Publishing IDFV
VunglePrivacySettings.setPublishIdfv(false)

Creative Tracking

You can find creativeID as a string property available in each ad instance. This value can be used for debugging, or can be shared if issues are identified with specific creatives. In the provided example, the creative ID is used to output details of the loaded interstitial ad when the app is notified of load success.

SwiftObjective-C
func interstitialAdDidLoad(_ interstitial: VungleInterstitial) {
    print("[TestApp log] interstitialAdDidLoad placementId:\(interstitial.placementId) eventId:\(interstitial.eventId) creativeId:\(interstitial.creativeId)")
}

Customize Rewarded Ads

For rewarded ads, you can set some optional parameters before loading and playing the ad.

  • You can set the user ID to identify the user that is interacting with the ad.
  • You can also customize texts used to incentivize the user to finish the ad experience and receive the reward (these texts are shown in an alert that would be presented if the user attempts to close the ad before completion).

Sample code:

SwiftObjective-C
  rewardedAd.setUserId(userId: "YOUR USER ID")
  rewardedAd.setAlertTitleText("Custom Alert Title")
  rewardedAd.setAlertBodyText("Custom Alert Body")
  rewardedAd.setAlertCloseButtonText("Custom Alert Close")
  rewardedAd.setAlertContinueButtonText("Custom Alert Continue")

Questions?

Need further assistance, feel free to reach out to us, we’re here to help!

Was this article helpful?