API usages

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.

Under TCF v2.0, not only can the user give or withhold consent, but they can also exercise their ‘right to object’ to data being processed on the basis of legitimate interests. It also enables greater transparency for the user, through more detailed and more easily understandable descriptions of the purposes of data processing.‌

Check the status for processing of personal data under legitimate interests for specific vendor

User can exercise their right to object for processing of their personal data under legitimate interests for each vendor in partner list.‌

You can check whether the user has declined the usage of personal data under legitimate interests for a particular vendor by calling the following method:

OguryChoiceManager.TcfV2.IsLiVendorMet(vendorId);

The IsLiVendorMet method takes following parameter:‌

• a vendorId integer, uniquely identifying each vendor. As an example, the vendor id is 277 for Ogury. You can find the list of all vendor identifiers in the Ogury Choice Manager vendor list.‌

Note that you can identify yourself as a vendor if you need specific consent for some use cases involving personal data. In this case, you first need to add yourself as a vendor in the consent notice, and then use the vendor id 0 in the IsLiVendorMet method.‌

Check the status for processing of personal data under legitimate interests for specific purpose

Similarly to vendors, user can object to processing of their personal data under legitimate interests for each IAB purposes. You can check and pass this signal to your vendors and your own processes accordingly.‌‌

You can check whether the user exercised their right to object for processing of their personal data under legitimate interests for a given purpose by calling the following method:

OguryChoiceManager.TcfV2.IsLiPurposeMet(purposeId);

The IsLiPurposeMet method takes following parameter:‌

• a purposeId integer, uniquely identifying each purpose. Purpose ids are enumerated in OguryChoiceManager.TcfV2.Purpose.

Check the status for processing of personal data under legitimate interests for specific vendor and his declared Legitimate interest based purposes

User can choose to object to processing of their personal data under legitimate interests for each purpose and each vendor separately.‌

Sometimes to disable/enable some feature of particular vendor’s SDKs you will need to know if all legitimate interests conditions are met - both for that vendor, and for each of purposes under legitimate interests declared by that vendor. In this case use the following method:

OguryChoiceManager.TcfV2.IsVendorsLiAndLiPurposeMet(vendorId);

The IsVendorLiAndLiPurposeMet method takes following parameter:‌

• a vendorId integer, uniquely identifying each vendor. As an example, the vendor id is 277 for Ogury. You can find the list of all vendor identifiers in the Ogury Choice Manager vendor list.

Note that you can identify yourself as a vendor if you need specific consent for some use cases involving personal data. In this case, you first need to add yourself as a vendor in the consent notice, and then use the vendor id 0 in the IsVendorLiAndLiPurposeMet method.‌

Check if all conditions are met for a specific vendor

Sometimes you will need to know if all conditions are met for a particular vendor. That means that the user sent a signal matching all of the following conditions:‌

• User gave consent to all consent based purposes declared by this vendor

• User gave consent to the processing for this vendor

• User did not object to legitimate interest processing to any purposes declared under legitimate interest by this vendor

• User did not object to legitimate interest processing for this vendor

To check if all conditions are met call:

OguryChoiceManager.TcfV2.IsAllVendorConditionsMet(vendorId);

The IsAllVendorConditionsMet method takes following parameter:‌

• a vendorId integer, uniquely identifying each vendor. As an example, the vendor id is 277 for Ogury. You can find the list of all vendor identifiers in the Ogury Choice Manager vendor list.

Note that you can identify yourself as a vendor if you need specific consent for some use cases involving personal data. In this case, you first need to add yourself as a vendor in the consent notice, and then use the vendor id 0 in the IsAllVendorConditionsMet method.

Check if the user has consented to Special Features the status

Your users can enable or disable collection and processing of some Special Features with Ogury Choice Manager.

You can use the following call to check if the user has consented to it:

OguryChoiceManager.TcfV2.IsSpecialFeatureAccepted(specialFeatureInt);

The IsSpecialFeatureAccepted method takes the following parameter:

• a specialFeatureInt integer value identifying an IAB Special Feature. The predefined values are available in the OguryChoiceManager.TcfV2.SpecialFeature object.

Here is the list of all purpose values in OguryChoiceManager.TcfV2.SpecialFeature object:

IAB specialnames	Purpose description
PreciseGeoLocation	Precise geolocation data
ScanDeviceCharacteristics	Identification through device scanning

We recommend to use this property only in the OnAskComplete/OnEditComplete event callbacks to get the updated value of the consent signal.