iOS HyprMX SDK
SDK Documentation
  • Getting Started
    • iOS Setup Guide
    • Privacy
    • Apple App Privacy Details
    • Migrate to Version 6.4+
  • Ad Formats
    • Rewarded Ads
    • Interstitial Ads
    • Banner/MREC Ads
  • 3rd Party Mediation
    • 3rd Party Mediation
      • AdMob Mediation
      • AppLovin MAX
      • Chartboost Mediation
      • Digital Turbine FairBid
      • Unity LevelPlay
      • X3M XMediator
  • Downloads/Change Log
    • Downloads
    • Change Log
      • iOS SDK Change Log
      • iOS AdMob Adapter Change Log
      • iOS MAX Adapter Change Log
Powered by GitBook
On this page
  • Consent Flag
  • Global Privacy Platform (GPP)
  • Age-restricted User Flag
  1. Getting Started

Privacy

PreviousiOS Setup GuideNextApple App Privacy Details

Last updated 5 months ago

Publishers are responsible for maintaining compliance with applicable privacy laws and regulations. The HyprMX SDK provides a number of flags publishers can use to pass the appropriate value to HyprMX to protect and maintain user data and privacy.

These flags support compliance with the General Data Protection Regulation (GDPR), US privacy laws (CPRA, CPA, VCDPA, etc.), Children's Online Privacy Protection Act (COPPA), and other regional privacy laws. However, consent and privacy requirements may extend beyond these circumstances and should be applied accordingly.

Consent Flag

HyprMX provides an API with a consentStatus parameter with the below values for jurisdictions that require passing consent that takes a ConsentStatus value depending on the user consent collected by your app. This flag will be used to indicate a user’s opt-in or opt-out consent for the collection and use of personal data under applicable laws and jurisdictions (GDPR, CPRA, etc.).

If a user provided consent in jurisdictions that require opt-in consent or did not opt out of collection or usage of personal data in jurisdictions that require opt-out consent, set a user’s consent status as below in the setter:

HyprMX.setConsentStatus(CONSENT_GIVEN)
[HyprMX setConsentStatus:CONSENT_GIVEN];

If a user did not provide consent in jurisdictions that require opt-in consent or opted out of collection or usage of personal data in jurisdictions that require opt-out consent, set a user’s consent status as below in the setter:

HyprMX.setConsentStatus(CONSENT_DECLINED)
[HyprMX setConsentStatus:CONSENT_DECLINED];

If you do not know the user’s consent status set it as unknown in the setter:

HyprMX.setConsentStatus(CONSENT_STATUS_UNKNOWN)
[HyprMX setConsentStatus:CONSENT_STATUS_UNKNOWN];

Global Privacy Platform (GPP)

HyprMX’s current version of GPP support is not meant to replace the Consent Flag. Publishers are responsible for setting the appropriate Consent Flag based on privacy laws and regulations users are subject to in all requests.

GPP is supported in HyprMX SDK 6.2+.

HyprMX SDK currently only supports the EU TCF v2 and US National strings within GPP.

The is a protocol developed by the IAB Tech Lab to standardize the communication of user consent and preference signaling throughout the digital supply chain.

HyprMX SDK supports GPP parameters so that GPP data can be used during transactions when applicable. To set GPP parameters in HyprMX SDK, store the GPP data within NSUserDefaults. HyprMX SDK will read the values in NSUserDefaults which are then passed to the ad call.

Age-restricted User Flag

To adhere to the strictest laws and policies, HyprMX treats users under 16 as children. HyprMX’s Age-restricted User flag assists publishers with child-directed treatment of users to support compliance with applicable regional laws and regulations such as COPPA, GDPR, and Apple App Store policies. The publisher is responsible for determining when to flag the end user as an age-restricted user and adhering to applicable laws and policies that require child-directed treatment.

If the user requires a child-directed treatment, set the ageRestrictedUser parameter to true.

HyprMX.setAgeRestrictedUser(true)
[HyprMX setAgeRestrictedUser:YES];

If the user doesn't require a child-directed treatment, set the ageRestrictedUser parameter to false.

HyprMX.setAgeRestrictedUser(false)
[HyprMX setAgeRestrictedUser:NO];

For added protection, if your app is primarily directed at children, indicate to your HyprMX Account Manager so the app can be designated as a child-directed app in the backend. Additionally, you may use the ageRestrictedUser flag to prevent access to IDFA for end-users flagged as children.

If your app is directed at a mixed audience, including children, use the ageRestrictedUser flag to appropriately flag any user who is considered a child under applicable jurisdiction as age-restricted user to prevent access to IDFA for end-users flagged as children.

Global Privacy Platform (GPP)