clevertap / clevertap-unity-sdk Goto Github PK

View Code? Open in Web Editor NEW

7.0 11.0 4.0 1.11 GB

Unity iOS/Android Plugin for the CleverTap SDK

License: Other

C# 69.90% Objective-C 6.56% Objective-C++ 8.92% Java 13.75% Shell 0.87%

clevertap clevertap-unity-sdk unity-sdk analytics engagement user-retention

clevertap-unity-sdk's Introduction

CleverTap Unity Plugin

👋 Introduction

The CleverTap Unity Plugin for Mobile Customer Engagement and Analytics solutions.

For more information check out our website and documentation.

To get started, sign up here.

🛠 Installation and Setup

You can install the CleverTap Unity SDK using the .unitypackage Unity package or as a local package through Unity Package Manager (UPM).

Import the CleverTap Unity Package

Download the latest version of the CleverTap Unity package. Import the .unitypackage into your Unity Project. Go to Assets > Import Package > Custom Package.
Add the PlayServiceResolver and the ExternalDependencyManager folders. These folders will install the EDM4U plugin, which automatically adds all the Android and iOS dependencies when building your project.
Ensure that the scripts inside the Editor folder are added (AndroidPostImport, CleverTapPostBuildProcessor. and the other scripts). The AndroidPostImport script sets up clevertap-android-wrapper library for Android. CleverTapPostBuildProcessor helps iOS setup.

Import the CleverTap Unity Package as a Local Dependency

Clone the latest release version of CleverTap Unity SDK. The SDK can be imported as a local package through the Unity Package Manager.

Set Up the Unity SDK

CleverTap API can be accessed anywhere in your project by simply calling the static CleverTap class. No need to create GameObject or attach any script. The SDK handles the following:

Instantiation of platform-specific binding (iOS, Android, Native)
Creation of GameObject
Script attachment.

You can view your CleverTap Account ID and CleverTap Account Token from the CleverTap Dashboard -> Settings.

// Initialize CleverTap
CleverTap.LaunchWithCredentialsForRegion({YOUR_CLEVERTAP_ACCOUNT_ID}, {YOUR_CLEVERTAP_ACCOUNT_TOKEN}, {CLEVERTAP_ACCOUNT_REGION});
// Enable personalization
CleverTap.EnablePersonalization();

Callbacks

Add an event listener for a callback directly through the CleverTap static events.

CleverTap.OnCleverTapDeepLinkCallback += YOUR_CALLBACK_METHOD;  
CleverTap.OnCleverTapProfileInitializedCallback += YOUR_CALLBACK_METHOD;  
CleverTap.OnCleverTapProfileUpdatesCallback += YOUR_CALLBACK_METHOD;

iOS Instructions

iOS specific setup is described in the iOS Instructions

Android Instructions

Android specific setup is described in the Android Instructions

💻 Example Usage

See the CleverTap Unity Usage Documentation

🆕 Changelog

Check out the CleverTap Unity plugin SDK Change Log here.

⁉️ Questions?

If you have questions or concerns, you can reach out to the CleverTap support team from the CleverTap Dashboard.

TroubleShooting Guide: Please refer here if you are facing common integration issue.

clevertap-unity-sdk's People

Contributors

Stargazers

Watchers

Forkers

dubit ygit isabella232 sarveshgk10

clevertap-unity-sdk's Issues

[IOS] Bug when submit the app

Hello,

I'm trying to implement clevertap on IOS, but i have two issues.
The first one is when Apple try to analyse my application. I receive a mail telling me this :

ITMS-90338: Non-public API usage - The app references non-public selectors in Frameworks/UnityFramework.framework/UnityFramework: setTitleTextColor:. If method names in your source code match the private Apple APIs listed above, altering your method names will help prevent this app from being flagged in future submissions. In addition, note that one or more of the above APIs may be located in a static library that was included with your app. If so, they must be removed. For further information, visit the Technical Support Information at http://developer.apple.com/support/technical/

When i removed CleverTap SDK, everything works fine.

My second issue is when i try to follow the guide (step 2 for ios)

Add a run script to your build phases. In Xcode, go to your Targets, under your app’s name, select Build Phases after embed frameworks, add a run script phase, and set it to use /bin/sh and the iOS script:

i receive an error that's say

Command PhaseScriptExecution failed with a nonzero exit code

Please can someone help me ?

Need a Swift package for iOS frameworks

I'm trying to integrate CleverTap into my Unity project for the first time and run into this error on XCode 12.x when doing this the readme step:

In Xcode, go to your Targets, under your app’s name
Under General, Navigate to Frameworks, Libraries and Embedded Content, please ensure that CleverTapSDK and SDWebImage frameworks are marked as Embed & Sign

After doing some research I found this: https://stackoverflow.com/questions/65303304/xcode-12-3-building-for-ios-simulator-but-the-linked-and-embedded-framework-wa which suggests to rebuild the framework as an XFC framework

Could you please create a swift package so I could use it as a package dependancy?: https://help.apple.com/xcode/mac/current/#/dev9cc785f4a

Unable to Build CleverTap Unity SDK v3.0.0 on Android

I'm encountering issues when trying to build the CleverTap Unity SDK v3.0.0 on Android. We're currently using CleverTap SDK v2.4.2 in production and I'm updating to 3.0.0. However, when building the project I receive the following exceptions for both development and release builds

Could not determine the dependencies of task ':unityLibrary:clevertap-android-wrapper.androidlib:compileDebugAidl'.
Could not determine the dependencies of task ':unityLibrary:clevertap-android-wrapper.androidlib:compileReleaseAidl'.

In an attempt to isolate the issue, I created an empty Unity project, imported the CleverTap SDK v3.0.0, and followed the documentation precisely. However, I encountered the same errors as mentioned above when attempting to build for Android.

Appreciate any assistance or guidance on resolving this issue. Thanks!