Skip to content
This repository has been archived by the owner on Jul 25, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Str4tos authored Mar 15, 2021
1 parent 586b012 commit 95f83f3
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ Every application, except for children, must make certain disclosures to users i
## Add the CAS Consent package to Your Project
if you are using Unity 2018.4 or newer then you can add CAS SDK to your Unity project using the [Unity Package Manager](https://docs.unity3d.com/Manual/upm-ui.html), or you can import the package manually.

<details><summary><b>Unity Package Manager</b></summary>

#### Option 1 Unity Package Manager
Add the **Game Package Registry by Google** and CAS dependency to your Unity project.
Modify `Packages/manifest.json` to the following form:
```json
Expand All @@ -27,36 +26,28 @@ Modify `Packages/manifest.json` to the following form:
}
```
> Note that some other SDKs, such as the Firebase SDK, may contain [EDM4U](https://github.com/googlesamples/unity-jar-resolver) in their .unitypackage. Check if `Assets/ExternalDependencyManager` or `Assets/PlayServicesResolver` folders exist. If these folders exist, remove them before installing any CAS SDK through Unity Package Manager.
***
</details>
<details><summary><b>Manual installation</b></summary>
#### Option 2 Manual installation
1. Download latest [CleverAdsSolutions_Consent.unitypackage](https://github.com/cleveradssolutions/CAS-Unity-Consent/releases/latest)
2. In your open Unity project, navigate to **Assets > Import Package > Custom Package**.
3. In the *Import Unity Package* window, make sure all of the files are selected and click **Import**.
***
</details>

## Step 2 Configuring the SDK
In your open Unity project, navigate to **Assets > CleverAdsSolutions > Consent request parameters** to create and modify request parameters.

- **With Audience Definition** toggle - With request user year of birth form.
- **With [Request Tracking Transparency](https://developer.apple.com/documentation/apptrackingtransparency)** toggle - With request iOS user authorization to access app-related data for tracking the user or the device.
Available with [NSUserTrackingUsageDescription](https://github.com/cleveradssolutions/CAS-Unity#include-ios) only.
- **Show in Editor** toggle - Show request in Editor.
- **Reset message** button - Resset Consent messages and Mediation Settings messages to default values.
- **Privacy policy URL** field - URL to applicaiton privacy policy for each platform or universal.
- **Terms of Use URL** field - URL to application terms of use for each platform or universal.
- **With Decline Option** toggle - With Decline button for refuse to use personal data.
- **Consent UI Prefab** field - Refference to main canvas prefab.
**Create template** button - Create and set a template prefab in project assets to override the interface.
**Default** button - Set default prefab from package.
- **Consent Message** field - Consent message to user for each system language or universal.
- **With Mediation Settings** toggle - With more options form to select each ad providers consent.
- **Toggle UI prefab** field - Refference to main canvas prefab.
**Create template** button - Create and set a template prefab in project assets to override the interface.
**Default** button - Set default prefab from package.
**Mediaiton Settings Message** field - Message to Mediaiton settings form for each system language or universal.
- **With [Request Tracking Transparency](https://developer.apple.com/documentation/apptrackingtransparency)** toggle - With request iOS user authorization to access app-related data for tracking the user or the device.

## Using the SDK from scripts
### Build request parameters
Expand Down Expand Up @@ -137,6 +128,20 @@ Add component > CleverAdsSolutions > UserConsent > Request
![image](https://user-images.githubusercontent.com/22005013/107221407-47bb0700-6a1c-11eb-825d-3d0a2b500016.png)


## iOS App Tracking Transparency authorization request
iOS 14 and above requires publishers to obtain permission to track the user's device across applications.

1. Open Consent requeset parameters in `Assets > CleverAdsSolution > Consent Request Parameters` menu.
2. Check [iOS App Tracking Transparency authorization request](https://developer.apple.com/documentation/apptrackingtransparency)
3. Define [NSUserTrackingUsageDescription](https://developer.apple.com/documentation/bundleresources/information_property_list/nsusertrackingusagedescription)
Below is an example description text:
- This identifier will be used to deliver personalized ads to you.
- Your data will be used to provide you a better and personalized ad experience.
- We try to show ads for apps and products that will be most interesting to you based on the apps you use.
- We try to show ads for apps and products that will be most interesting to you based on the apps you use, the device you are on, and the country you are in.

> **Important!** CAS does not provide legal advice. Therefore, the information on this page is not a substitute for seeking your own legal counsel to determine the legal requirements of your business and processes, and how to address them.
## GitHub issue tracker
To file bugs, make feature requests, or suggest improvements for the Unity Consent Plugin, please use [GitHub's issue tracker](https://github.com/cleveradssolutions/CAS-Unity-Consent/issues).

Expand Down

0 comments on commit 95f83f3

Please sign in to comment.