Xandr - iOS
Search…
AD FORMATS
OGURY CHOICE MANAGER
Advanced Topics
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 a solution approved by the IAB Transparency and Consent Framework (TCF), 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.
Alternatively, if you already have a consent manager you can transmit the consent through the third-party consent manager integration.
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: Setup Choice Manager SDK
In order to use Ogury Choice Manager you have to setup the SDK first. This method must be called before any other method. We recommend to call setup in
AppDelgeate class, function didFinishLaunchingWithOptions before starting any UIViewController. You can call the setup method as follows:
Swift
Objective-C
1
let config = OguryChoiceManagerConfig.default()
2
OguryChoiceManager.shared().setup(withAssetKey: "ASSET_KEY", andConfig: config)
Copied!
1
OguryChoiceManagerConfig *config = [OguryChoiceManagerConfig defaultConfig];
2
[[OguryChoiceManager sharedManager] setupWithAssetKey:@"ASSET_KEY" andConfig:config];
Copied!
The
setup method takes the following parameters:- a SDK Config object
OguryChoiceManagerConfigneeded to pass versions of frameworks that should be used in SDK. If you don't setconfig.tcfVersionthen TCF version 2 will be used.
Step 2: 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
Objective-C
1
OguryChoiceManager.shared().ask(with: viewController) { (error, response) in
2
3
}
Copied!
1
[[OguryChoiceManager sharedManager] askWithViewController:viewController andCompletionBlock:^(NSError *error, OguryChoiceManagerAnswer answer) {
2
​
3
}];
Copied!
The
ask method takes the following parameters:- the current
ViewController - a
completionBlockto listen to changes of the consent signal. This completion block provides two parameters :
Parameters
Definition
responseA 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.
errorAn error occurred. In this case, nothing is displayed to the user and the consent status is not synchronized. Learn more about consent error handling.
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
You must initialize Ogury Ads in the completion block of the
ask method to have the user consent for the first ad impression. Note that the Ogury SDK will only serve non-personalized ads, lowering your expected revenue, if (i) you don't initialize the Ogury Ads in these completion block, or if (ii) an error occurs.
Once the Ogury Ads are correctly initialized, the user consent is automatically synchronized across all Ogury products.
Swift
Objective-C
1
import UIKit
2
import AppNexusSDK
3
import OguryChoiceManager
4
import OguryAds
5
​
6
class ViewController: UIViewController {
7
8
func viewDidLoad() {
9
//Setup SDK
10
let config = OguryChoiceManagerConfig.default()
11
OguryChoiceManager.shared().setup(withAssetKey: "ASSET_KEY", andConfig: config)
12
// get user consent
13
OguryChoiceManager.shared().ask(with: self) { (error, response) in
14
// start the Ogury SDK
15
OguryAds.shared().setup(withAssetKey: "ASSET_KEY")
16
17
ANGDPRSettings.setConsentString(OguryChoiceManager.shared().tcfV2.getIABConsentString());
18
​
19
}
20
}
21
}
Copied!
1
#import <UIKit/UIKit.h>
2
#import <AppNexusSDK/AppNexusSDK-umbrella.h>
3
#import <OguryAds/OguryAds.h>
4
#import <OguryChoiceManager/OguryChoiceManager.h>
5
​
6
@interface ViewController : UIViewController
7
@end
8
​
9
@implementation ViewController
10
​
11
- (void)viewDidLoad {
12
[super viewDidLoad];
13
// setup SDK
14
OguryChoiceManagerConfig *config = [OguryChoiceManagerConfig defaultConfig];
15
[[OguryChoiceManager sharedManager] setupWithAssetKey:@"ASSET_KEY" andConfig:config];
16
// get user consent
17
[[OguryChoiceManager sharedManager] askWithViewController:self andCompletionBlock:^(NSError *error, OguryChoiceManagerAnswer answer) {
18
[[OguryAds shared] setupWithAssetKey:@"ASSET_KEY"];
19
20
[ANGDPRSettings setConsentString:[[[OguryChoiceManager sharedManager] tcfV2] getIABConsentString]];
21
22
}];
23
}
24
​
25
@end
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 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
Objective-C
1
OguryChoiceManager.shared().edit(with: viewController) { (error, response) in
2
​
3
}
Copied!
1
[[OguryChoiceManager sharedManager] editWithViewController:viewController andCompletionBlock:^(NSError *error, OguryChoiceManagerAnswer answer) {
2
​
3
}];
Copied!
The
edit method takes the following parameters:- the current
ViewController - a
completionBlockto listen to changes of the consent signal. This completion block provides two parameters :
Parameters
Definition
responseA 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.
errorAn error occurred. In this case, nothing is displayed to the user and the consent status is not synchronized. Learn more about consent error handling.
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. You can now go back to the getting started section and finish your integration.
Advanced Topics
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_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 completion block provides an error parameter. This parameter contains the cause of the failure.‌To get this cause, you can call the following method:
1
error.code
Copied!
The error can be one of the following:
Code
Value
Definition
OGYConsentErrorNoInternetConnection0
The device has no internet connection. Try again when the device is connected to Internet.
OGYConsentErrorTypeNoSuchAssetKey1
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.
OGYConsentErrorTypeBundleNotMatching2
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).
OGYConsentErrorTypeServerError3
The server has failed to respond because of an internal error. Please try again.
OGYConsentErrorTypeInternalSDKError4
An internal SDK error has occurred. Please try again.
OGYConsentErrorTypeRegionRestricted1000
The device is in a region not allowed to show the consent.
OGYConsentErrorTypeSdkAskNotCalled1001
The
ask method has not been called.OGYConsentErrorTypeSdkTimeOut1002
The request has time out.
Please try again.
OGYConsentErrorTypeFormError1003
Form side error has occurred. Please try again.
OGYConsentErrorTypeParsingError1004
Data parsing error has occurred. Please try again.
OGYConsentErrorTypeFairChoiceFetchProduct1005
Error occurred trying to fetch Fair Choice Product from Store.
OGYConsentErrorTypeEditDisabledUserHasPaid1006
OGYConsentErrorTypeIOSUserRestricted1007
iOS user restricted from consent
OGYConsentErrorTypeUserGeoRestricted1008
The current user is geo-restricted from consent.
Last modified 1yr ago