Collect the user consent
Ogury Choice Manager handles user consent collection and storage for all your vendors, with a simple integration, ensuring compliance with the GDPR regulation. Your users are shown a single consent notice giving them the choice of the data they want to share, if any.
As an IAB Transparency and Consent Framework (TCF) approved solution, Ogury Choice Manager not only meets the letter of the law, but is also aligned with all relevant best practice standards.
Also, Ogury Choice Manager facilitates CCPA compliance by IAB California Consumer Privacy Act (CCPA) framework.
But where other solutions draw the line here, Ogury Choice Manager goes one step further by incorporating vendors that fall outside of IAB jurisdiction, including Facebook and Google. The net result is a definitive, one-stop consent notice that covers most vendors available on the market today.
Requirements
You have a registered application on your Ogury Dashboard. If not, please refer to the Getting started section before the next steps.
Step 1: Initialize the Ogury SDK
You must first initialize the Ogury SDK by calling the
start method:1
OguryConfiguration.Builder oguryConfigurationBuilder = new OguryConfiguration.Builder(this, "OGY-XXXXXXXXXXXX");
2
Ogury.start(oguryConfigurationBuilder.build());
Copied!
The
start method takes an OguryConfiguration object as parameters. The OguryConfiguration is built from its Builder which takes the following parameters:- the Asset Key of your application. If you do not have one yet, you can refer to the Getting started section to create it.
Step 2: Get the user consent
To collect the user consent for the all registered vendors, call the
ask method in the onCreate method of your Activity.This method is designed to ask the server for the current user's last answer. If the server is unable to retrieve an answer or if the user falls in a case where a notice needs to be displayed, this method will trigger the surfacing of the notice. Otherwise the
ask method synchronizes the consent signal and makes it available through the SDK methods.You can call the
ask method as follows:1
OguryChoiceManager.ask(activity, oguryConsentListener);
Copied!
The
ask method takes the following parameters:- the current
Activity.
The
ask method must be called at each launch of your application to be sure to have an up-to-date consent status.Integration example
See in the following example how to get the consent through the Ogury Choice Manager:
1
public class MyActivity extends Activity {
2
​
3
private InterstitialAd interstitialAd = null;
4
​
5
@Override protected void onCreate(Bundle savedInstanceState) {
6
super.onCreate(savedInstanceState);
7
8
OguryConfiguration.Builder oguryConfigurationBuilder = new OguryConfiguration.Builder(this, "OGY-XXXXXXXXXXXX");
9
Ogury.start(oguryConfigurationBuilder.build());
10
11
OguryChoiceManager.ask(this, oguryConsentListener);
12
}
13
14
private final OguryConsentListener oguryConsentListener = new OguryConsentListener() {
15
@Override public void onComplete(OguryChoiceManager.Answer answer) {
16
// will serve personalized ads when the user consents
17
}
18
@Override public void onError(OguryError error) {
19
// will serve non-personalized ads
20
}
21
};
22
23
}
Copied!
Step 3: Allow users to edit their consent
As per the GDPR regulation, publishers need to ensure the users can access and edit their consent choices through their application at any time.
The
edit method behaves the same way as the ask method but enforces the display. If an error occurred, nothing is displayed to the user. In this case, you need to handle the error to inform the user.1
OguryChoiceManager.edit(activity, oguryConsentListener);
Copied!
The
edit method takes the following parameters:- the current
Activity.
We recommend to expose a button to edit the consent in the application settings.
Step 4: Finish your integration
Congratulations! Ogury Choice Manager is now implemented.
However, should you have other vendors' SDKs processing user data, you can learn how to transmit them the consent signal in the Advanced usages section of the Ogury Choice Manager documentation.
Advanced Topics
Check the availability of the edit method
The edit option might not be available and then calling the
edit method will return an error in the following cases:- if the user is not located in the EU, i.e. not in a country where the GDPR applies;
- if the user has already paid to access your app using the Fair Choice feature;
- as a result of a specific configuration on the Ogury Dashboard;
Before displaying the edit button, you should check this option with the following method:
1
OguryChoiceManager.isEditAvailable();
Copied!
Calling this method make sense only once the synchronization triggered by
ask method has completed. Otherwise this method returns true by default.Listener
The Ogury SDK provides the
OguryConsentListener interface to listen to consent signal changes.The
OguryConsentListener exposes the following methods:Methods
Definition
onCompleteA consent notice has been displayed to the user or the consent status has been synchronized. This method provides an
Answer. Learn more about how to handle the user consent if you have other vendors' SDKs processing user data on Ogury Choice Manager documentation.onErrorAn error occurred. In this case, nothing is displayed to the user and the consent status is not synchronized. This method provides an
OguryError that contains the reason of the failure.Answer
In the
onComplete method of the OguryConsentListener interface, you can get the answer of the user through theAnswer object. The Answer has one of the following values:Answer values
Definition
FULL_APPROVALThe user has approved all vendors and all purposes displayed in the consent notice.
PARTIAL_APPROVALThe user has approved some vendors and/or some purposes displayed in the consent notice.
REFUSALThe user has refused all vendors and all purposes displayed in the consent notice.
NO_ANSWERThe user has not responded.
Error handling
If Ogury Choice Manager fails to get the consent signal for any reason during an
ask or an edit, the onError method of the OguryConsentListener is called. This method provides an OguryError object that contains an error code and an error message.To get the error code, you can call the
getErrorCode. You can retrieve a more explicit message by calling the getMessage method.You can find predefined values for each error code in
OguryChoiceManagerErrorCode object. For example, you can check if error occurred because there is no Internet connection by usingNO_INTERNET_CONNECTION error code as following:1
if (error.getErrorCode() == OguryChoiceManagerErrorCode.NO_INTERNET_CONNECTION) {
2
// ...
3
}
Copied!
Here is the list of all error codes in
OguryChoiceManagerErrorCode object:Name
Value
Definition
NO_INTERNET_CONNECTION0No Internet connection
The device has no Internet connection.
Try again once the device is connected to the Internet.
ASSET_KEY_UNKNOWN1Asset Key unknown
The Asset Key passed in the method is unknown. Make sure to copy the exact Asset Key from the Ogury Dashboard (see the Getting started for more information). It may also occur while new configuration are propagating immediately following the creation of the application.
BUNDLE_NOT_MATCHING2Bundle not matching
The bundle registered on the Ogury Dashboard does not match the Android package of the running application.
Check that you have copied the Asset Key corresponding to the current application from the Ogury Dashboard (see the Getting started for more information).
SERVER_NOT_RESPONDING3Server not responding
The server has failed to respond because of an internal error.
Please try again.
SYSTEM_ERROR4System error
The SDK has encountered an internal error.
Please try again.
REGION_RESTRICTED1000Region restricted
The user is in the restricted region.
TIMEOUT_ERROR1002Timeout error
Timeout error happened while waiting for the response. See the error message for more details.
FORM_ERROR1003Form error
The error occurs when trying to show Consent notice. See the error message for more details.
PARSING_ERROR1004Parsing error
The error occurs when parsing data. Probably some field in JSON is missing or is invalid. See the error message for more details.
FAIR_CHOICE_ERROR1005Fair choice error
The error occurs when fetching details about product for Fair Choice. See the error message for more details.
EDIT_DISABLED_USER_HAS_PAID1006Edit disabled because user has paid
Edit consent is disabled because user has paid for Fair Choice. See the error message for more details.
EDIT_DISABLED_DEVICE_ID_RESTRICTED1007Edit function is disabled because device id is restricted
See the error message for more details.
EDIT_DISABLED_GEORESTRICTED_USER1008Edit function is disabled because of the users' geolocation
See the error message for more details.