Collect the user consent

As of November 13, 2023, Ogury Choice Manager is deprecated, meaning it will no longer be supported or updated.

Consequently, no new consent notices will be delivered through Ogury Choice Manager's APIs. Therefore, it is strongly advised against using Ogury Choice Manager in new versions of applications. In case you have migrated to a new Consent Management Platform (CMP), ensure that Ogury and its partners are included as vendors.

For earlier versions of applications still using Ogury Choice Manager, the API will maintain its functionality, continuing to return consent for users who have previously responded to a consent notice. This will remain in effect until their consent expires.

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.

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 and initialized the Ogury SDK. If not, please refer to the getting started section before the next steps.

Step 1: Get the user consent

To collect the user consent for the all registered vendors, call the ask method in the viewDidLoad of your ViewController.

This method displays a consent notice allowing the user to choose with which vendors and purposes they agree to share data. This notice is only displayed when there is no existing consent status for this user. Otherwise the ask method synchronizes the consent signal and makes it available through the SDK methods.

You can call the ask method as follows:

Swift

OguryChoiceManager.shared().ask(with: viewController) { (error, response) in        
    
}

Objective-C

[[OguryChoiceManager sharedManager] askWithViewController:viewController andCompletionBlock:^(NSError *error, OguryChoiceManagerAnswer answer) {

 }];

The ask method takes the following parameters:

• the current ViewController

• a completionBlock to listen to changes of the consent signal. See Completion handler for more details.

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

The Ogury Choice Manager and the Ogury ad formats are synchronized. So you can start loading the ads while requesting user consent. You do not need to wait for the user response. Indeed, the ad will be loaded once the user's consent is obtained. Just pay attention to call ask method before loading ads.

Integration example

Swift

import UIKit
import OgurySdk
import OguryChoiceManager

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        
        // Setup the Ogury SDK
        let configuration = OguryConfigurationBuilder(assetKey: "ASSET_KEY").build()
        
        Ogury.start(with: configuration)
        
        // Get user consent
        OguryChoiceManager.shared().ask(with: self) { (error, response) in
            
        }
    }
}

Objective-C

#import <OgurySdk/OgurySdk.h>
#import <OguryChoiceManager/OguryChoiceManager.h>

@interface ViewController : UIViewController

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    
    // Setup SDK
    OguryConfigurationBuilder *configurationBuilder = [[OguryConfigurationBuilder alloc] initWithAssetKey:@"ASSET_KEY"];
    
    [[Ogury startWithConfiguration:[configurationBuilder build]];
    
    // Get user consent
    [[OguryChoiceManager sharedManager] askWithViewController:self andCompletionBlock:^(NSError *error, OguryChoiceManagerAnswer answer) {
        
    }];
}

@end

Step 2: 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 forces the display of the consent notice and let users update their choices. If an error occurred, nothing is displayed to the user. In this case, you need to handle the error to inform the user.

Swift

OguryChoiceManager.shared().edit(with: viewController) { (error, response) in        

}

Objective-C

[[OguryChoiceManager sharedManager] editWithViewController:viewController andCompletionBlock:^(NSError *error, OguryChoiceManagerAnswer answer) {

 }];

The edit method takes the following parameters:

• the current ViewController

• a completionBlock to listen to changes of the consent signal. See Completion handler for more details.

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

Step 3: Finish your integration

Congratulations! Ogury Choice Manager is now implemented.

The user consent is automatically synchronized across all Ogury products, so you don't need to transmit it to them. You can now go back to the Getting started section to implement ad formats and finish your integration.

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;

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

Swift

OguryChoiceManager.sharedManager.editAvailable()

Objective-C

[[OguryChoiceManager sharedManager] editAvailable];

Calling this method make sense only once the synchronization triggered by ask method has completed. Otherwise this method returns true by default.

Completion handler

This completion block provides two parameters :

Parameters	Definition
response	A consent notice has been displayed to the user or the consent status has been synchronized. You can handle the status of the consent to use it with vendors' SDKs. Learn more about user consent handling.
error	An error occurred. In this case, nothing is displayed to the user and the consent status is not synchronized. Learn more about consent error handling.

Possible user answer‌

In the reponse parameter of completion block, you can get the answer of the user through an Answer 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 completion block provides an error parameter. This parameter contains the cause of the failure.‌

To get this cause, you can call the following method:

error.code

The error can be one of the following:

Code	Value	Definition
OGYConsentErrorNoInternetConnection	0	The device has no internet connection. Try again when the device is connected to Internet.
OGYConsentErrorTypeNoSuchAssetKey	1	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 section for more information). It may also occur while new configurations are propagating immediately following the creation of the application.
OGYConsentErrorTypeBundleNotMatching	2	The bundle registered on the Ogury Dashboard does not match the iOS bundle 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 section for more information).
OGYConsentErrorTypeServerError	3	The server has failed to respond because of an internal error. Please try again.
OGYConsentErrorTypeInternalSDKError	4	An internal SDK error has occurred. Please try again.
OGYConsentErrorTypeRegionRestricted	1000	The device is in a region not allowed to show the consent.
OGYConsentErrorTypeSdkAskNotCalled	1001	The ask method has not been called.
OGYConsentErrorTypeSdkTimeOut	1002	The request has time out. Please try again.
OGYConsentErrorTypeFormError	1003	Form side error has occurred. Please try again.
OGYConsentErrorTypeParsingError	1004	Data parsing error has occurred. Please try again.
OGYConsentErrorTypeEditDisabledUserHasPaid	1006	The edit option is disabled because the user has paid.
OGYConsentErrorTypeIOSUserRestricted	1007	iOS user restricted from consent
OGYConsentErrorTypeUserGeoRestricted	1008	The current user is geo-restricted from consent.
OGYConsentErrorTypeSetupNotCalled	1009	The setup method has not been called.