Skip to content

Configuring SDK

Denis edited this page Mar 16, 2021 · 49 revisions

⚡ Before you start
Make sure you have correctly configure SDK.


This documentation is provided for compliance with various privacy laws. If you are collecting consent from your users, you can make use of APIs discussed below to inform CAS and all downstream consumers of this information.

A detailed article on the use of user data can be found in the Privacy Policy.

GDPR Managing Consent

This documentation is provided for compliance with the European Union's General Data Protection Regulation (GDPR). In order to pass GDPR consent from your users, you should make use of the APIs and methods discussed below to inform CAS and all downstream consumers of this information.

Passing Consent to CAS API, use this functions:
When the user provide consent use:

CAS.MobileAds.settings.userConsent = ConsentStatus.Accepted;

When the user did not consent use:

CAS.MobileAds.settings.userConsent = ConsentStatus.Denied;

By default, user consent management is passed on to media networks:

CAS.MobileAds.settings.userConsent = ConsentStatus.Undefined;

CCPA Compliance

This documentation is provided for compliance with the California Consumer Privacy Act (CCPA). In order to pass CCPA opt-outs from your users, you should make use of the APIs discussed below to inform CAS and all downstream consumers of this information.

Passing Opt-outs In the Android SDK v1.4, we added privacy methods to our AdsSettings API for additional support in CCPA compliance. To successfully pass us an opt-out signal, the publisher will need to provide CAS a signal to indicate whether CCPA legislation is applicable to the user in addition to the actual consent value.

When user has opted-in to the sale of their data, as defined by the CCPA, and CAS should continue with our standard processing of user information.

CAS.MobileAds.settings.userCCPAStatus = CCPAStatus.OptInSale;

When user has opted-out to the sale of their data use:

CAS.MobileAds.settings.userCCPAStatus = CCPAStatus.OptOutSale;

By default, user consent management is passed on to media networks. For reset state:

CAS.MobileAds.settings.userCCPAStatus = CCPAStatus.Undefined;

COPPA and EEA Compliance

This documentation is provided for additional compliance with the Children’s Online Privacy Protection Act (COPPA). Publishers may designate all inventory within their applications as being child-directed or as COPPA-applicable though our UI. Publishers who have knowledge of specific individuals as being COPPA-applicable should make use of the API discussed below to inform CAS and all downstream consumers of this information.

You can mark your ad requests to receive treatment for users in the European Economic Area (EEA) under the age of consent. This feature is designed to help facilitate compliance with the General Data Protection Regulation (GDPR). Note that you may have other legal obligations under GDPR. Please review the European Union’s guidance and consult with your own legal counsel. Please remember that CAS tools are designed to facilitate compliance and do not relieve any particular publisher of its obligations under the law.

To indicate that your content treated as child-directed for purposes of COPPA or receive treatment for users in the European Economic Area (EEA) under the age of consent use:

CAS.MobileAds.settings.taggedAudience = Audience.Children;

To indicate that your content treated as not child-directed use:

CAS.MobileAds.settings.taggedAudience = Audience.NotChildren;

By default, the audience is unknown and the mediation ad network will work as usual. For reset state:

CAS.MobileAds.settings.taggedAudience = Audience.Mixed;

We recommend to set Privacy API before initializing CAS SDK.

User Consent module

Every application, except for children, must make certain disclosures to users in the European Economic Area (EEA) along with the UK and obtain their consent to use cookies or other local storage, where legally required, and to use personal data (such as AdID) to serve ads. This policy reflects the requirements of the EU ePrivacy Directive and the General Data Protection Regulation (GDPR).

The CAS Unity Consent provides tools for publishers to request consent for personalized ads as well as to handle Apple's App Tracking Transparency (ATT) requirements. Publishers can use the UMP SDK to handle either or both of these requests by showing a single a form, as all of the configuration happens in the unity inspector.


What’s Next?

Clone this wiki locally