Privacy
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's data and privacy.
These flags support compliance with the General Data Protection Regulation (GDPR), US privacy laws (CPRA, CCPA, 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 Signaling
HyprMX supports multiple industry standards and methods for signaling user privacy preferences. These signals determine how the SDK processes personal data and delivers ads in compliance with privacy regulations.
Transparency and Consent Framework v2
HyprMX SDK supports the IAB Europe Transparency and Consent Framework (TCF) v2. This enables publishers in GDPR-applicable regions to provide a TCF v2 consent string that the SDK will use to determine whether personal data can be processed for advertising.
The SDK will automatically read the TCF v2 consent string if it is stored using the standard IAB keys in NSUserDefaults on iOS. No extra integration code is required if your CMP stores the string using these keys.
IABTCF_gdprApplies
1 : GDPR applies in current context
0 : GDPR does not apply in current context
Unset: undetermined
IABTCF_TCString
Base64-encoded consent string as defined in IAB Tech Lab – Consent string and vendor list formats v2
Consent Flag
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 operating under opt-out consent rules, 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 operating under opt-out consent rules, 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 Global Privacy Platform (GPP) 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.
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 operating under opt-out consent rules
, set a user’s consent status as below in the setter:
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 operating under opt-out consent rules, set a user’s consent status as below in the setter:
If you do not know the user’s consent status set it as unknown in the setter:
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 Global Privacy Platform (GPP) 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.
IABGPP_HDR_GppString
Full consent string in its encoded form
IABGPP_GppSID
Section ID(s) considered to be in force. Multiple IDs are separated by an underscore.
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.
If the user doesn't require a child-directed treatment, set the ageRestrictedUser parameter to false.
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.
Last updated
