Third-party consent manager

Ogury requires an explicit consent from the user to use their personal data. In addition to our Ogury Choice Manager, we can collect the consent automatically from third-party consent manager (see case A for more details). Additionally we provide APIs to transmit the consent from third-party consent manager to the Ogury SDK in case it is not compatible with the automatic way (see case B and case C for more details).

Requirements

You have a registered application on your Ogury dashboard. If not, you can refer to the Getting started.

To use automatic TCFV2 string retrieval (case A), make sure you have the Ogury SDK version 5.0.7 or latest on Android and the version 1.3.4 or latest on iOS.

Case A: Your CMP is compatible with the IAB GDPR Consent Framework

The Ogury SDK (from versions 5.0.7 on Android and 1.3.4 on iOS) will automatically synchronize the user's consent before each ad request.

The user's consent is read from the Shared preferences(Android)/User defaults(iOS) as specified in IAB GDPR Consent Framework and synchronized every time to user changes its choices. Your CMP must be initialized before doing any ad request in order for the consent to be retrieved.

Compatible third-party consent managers:

If you are using an Ogury SDK version prior to 5.0.7 on Android or 1.3.4 on iOS, you must update your Ogury SDKs or use the method in case B.

Case B: Your CMP generates TCFv2 consent string

If your consent notice is registered in the IAB CMP list and produces IAB-specified consent string, you can pass the consent programmatically to Ogury SDK.

Step 1: Import Unity Ogury SDK

Follow the instructions from step 2 to step 5 of our Unity documentation to integrate the Unity Ogury SDK.

To know more about the latest release of the Ogury SDK, you can check the release notes.

Step 2: Pass consent to Ogury

To pass consent status to Ogury, call the following method after the consent has been collected:

OguryChoiceManagerExternal.TcfV2.SetConsent(iabString, new int[0]);

The SetConsent method takes the following parameters:

The IAB-specified Consent String must be a valid and be generated by a whitelisted CMP. Otherwise the call to the SetConsent method will be ignored.

If, at any point, user consent is changed, call this method again with updated values.

Integration example

Ogury.Start("ANDROID_ASSET_KEY", "IOS_ASSET_KEY");
OguryChoiceManagerExternal.TcfV2.setConsent(iabString, new int[0]);

Case C: Your CMP is not supported by any of the above cases.

As of November 13, 2023, this functionality is deprecated, and Ogury no longer provides support for this consent type. Please use a Consent Management Platform (CMP) that is compatible with TCFv2 to manage and generate user consents.

This feature is submitted to a whitelist. Please contact your account manager before starting using this method.

We provide an alternative programmatic way to provide a true/false user's consent to the Ogury SDK in case of any of the previous methods did not work.

Before using this method, to be compliant with last GDPR requirements, you must include a link to Ogury's Privacy Policy in your own privacy policy.

Step 1: Import Unity Ogury SDK

Follow the instructions from step 2 to step 5 of our Unity documentation to integrate the Unity Ogury SDK.

To know more about the latest release of the Ogury SDK, you can check the release notes.

Step 2: Pass consent to Ogury

To pass consent status to Ogury, call the following method after the consent has been collected:

OguryChoiceManagerExternal.SetConsent(booleanConsent, consentManagerName);

The setConsent method take the following parameter:

  • a boolean indicating whether the user has consented or not.

  • the name of the consent manager provider collecting the consent. The value must formatted in snake case

    • If you are using a third-party solution, enter the name of this solution in SCREAMING_SNAKE_CASE (all capital letters, space replaced by an underscore).

    • If you are using an in-house solution, use "CUSTOM".

If, at any point, user consent is changed, call this method again with updated values.

Finish your integration

You can go back to the Getting started to finish your integration.

Last updated