Getting started

‌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.

From October 2020, Ogury released a new API specially refactored to improve the onboarding experience. If you have already integrated the Ogury SDK and want to update your integration with the latest API, you can read the Migration guide. It explains the main points to easily switch from the old API to the new one.‌

Step 1: Register your application

‌If it is not already done:‌

The Asset Key follows the pattern: OGY-XXXXXXXXXXXX, where X is an uppercase letter or digit. In all the following code samples, we will refer to this Asset Key by using the string OGY-XXXXXXXXXXXX.‌

Step 2: Import the Ogury SDK

If it is not already done, import the latest version of the Ogury SDK into your project. To do this, Ogury provides two methods:

  • Automated integration using Ogury's Maven repository (recommended).

  • Manual integration of the Ogury SDK AAR.

Maven repository
Manual integration
Maven repository

Configure your IDE

Open the build.gradle of your application and add the following lines:

repositories {
maven {
url 'https://maven.ogury.co'
}
}
dependencies {
implementation 'co.ogury:ogury-sdk:5.+'
}

To know more about our latest release, you can check our release notes.

Manual integration

Download the Ogury SDK

Configure your IDE

Open the build.gradle of your application and add the following lines, making sure to replace ogury-sdk-X.X.X by the name of the downloaded AAR.

repositories {
flatDir {
dirs 'libs'
}
}
dependencies {
implementation(name: 'ogury-sdk-X.X.X', ext: 'aar')
}

To know more about our latest release, you can check our release notes.

Step 3: Initialize the Ogury SDK

‌After you have registered your app and imported the Ogury SDK, you must call Ogury.start() before you use any Ogury's functionalities.

OguryConfiguration.Builder oguryConfigurationBuilder = new OguryConfiguration.Builder(this, "OGY-XXXXXXXXXXXX");
Ogury.start(oguryConfigurationBuilder.build());

The start method takes an OguryConfiguration object as parameters. The OguryConfiguration is built from its Builder which takes the following parameters:

  • the Application context.

  • the Asset Key of your application. If you do not have one yet, you can refer to the first step to create it.

‌Step 4: 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:

OguryChoiceManager.ask(activity, oguryConsentListener);

The ask method takes the following parameters:

Theask method must be called at each launch of your application to be sure to have an up-to-date consent status.

Integration example

public class MyActivity extends Activity {
@Override protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
OguryConfiguration.Builder oguryConfigurationBuilder = new OguryConfiguration.Builder(this, "OGY-XXXXXXXXXXXX");
Ogury.start(oguryConfigurationBuilder.build());
OguryChoiceManager.ask(this, oguryConsentListener);
}
private final OguryConsentListener oguryConsentListener = new OguryConsentListener() {
@Override public void onComplete(OguryChoiceManager.Answer answer) {
// will serve personalized ads when the user consents
}
@Override public void onError(OguryError error) {
// will serve non-personalized ads
}
};
}

Step 5: 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.

OguryChoiceManager.edit(activity, oguryConsentListener);

The edit method takes the following parameters:

We recommend to expose a button to edit the consent in the application settings.

Step 6: Handle the user consent

‌After you have obtained the user consent, you are able to handle it according to your needs:

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:

OguryChoiceManager.isEditAvailable();

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

onComplete

A consent notice has been displayed to the user or the consent status has been synchronized. This method provides an Answer.

onError

An 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_APPROVAL

The user has approved all vendors and all purposes displayed in the consent notice.

PARTIAL_APPROVAL

The user has approved some vendors and/or some purposes displayed in the consent notice.

REFUSAL

The user has refused all vendors and all purposes displayed in the consent notice.

NO_ANSWER

The 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:

if (error.getErrorCode() == OguryChoiceManagerErrorCode.NO_INTERNET_CONNECTION) {
// ...
}

Here is the list of all error codes in OguryChoiceManagerErrorCode object:

Name

Value

Definition

NO_INTERNET_CONNECTION

0

No Internet connection

The device has no Internet connection. Try again when device is connected to the Internet.

ASSET_KEY_UNKNOWN

1

Asset 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 first step for more information). It may also occur while new configuration are propagating immediately following the creation of the application.

BUNDLE_NOT_MATCHING

2

Bundle 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 first step for more information).

SERVER_NOT_RESPONDING

3

Server not responding

The server has failed to respond because of an internal error. Please try again.

SYSTEM_ERROR

4

System error

The SDK has encountered an internal error. Please try again.

REGION_RESTRICTED

1000

Region restricted

The user is in the restricted region.

TIMEOUT_ERROR

1002

Timeout error

Timeout error happened while waiting for the response. See the error message for more details.

FORM_ERROR

1003

Form error

The error occurs when trying to show Consent notice. See the error message for more details.

PARSING_ERROR

1004

Parsing 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_ERROR

1005

Fair choice error

The error occurs when fetching details about product for Fair Choice. See the error message for more details.

EDIT_DISABLED_USER_HAS_PAID

1006

Edit 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_RESTRICTED

1007

Edit function is disabled because device id is restricted

See the error message for more details.

EDIT_DISABLED_GEORESTRICTED_USER

1008

Edit function is disabled because of the users' geolocation

See the error message for more details.