Unity

最低要求

Android

iOS

集成

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

<application>
    <receiver android:name="com.my.tracker.campaign.MultipleInstallReceiver"
              android:permission="android.permission.INSTALL_PACKAGES"
              android:exported="true">
        <intent-filter>
            <action android:name="com.android.vending.INSTALL_REFERRER"/>
        </intent-filter>
    </receiver>
    <service android:name="com.my.tracker.campaign.CampaignService" />

</application>

-keep class com.my.tracker.** { *; }
-dontwarn com.my.tracker.**
-keep class com.android.installreferrer.** { *; }
-keep class com.android.vending.billing.** { *; }
-keep class com.android.billingclient.api.** { *; }
-keep class com.google.android.gms.** { *; }

Gradle编译（构建）环境能在处理aar文件时自动地导入上述规则

初始化

SDK_KEY is generated automatically after you added your application to MyTracker. To get the key, go to the Application list page, select the required application, and copy the key from the Overview tab. Please note that if you build an app for different platforms, you need individual SDK_KEY for each of them.

public class YourMonoBehaviour : MonoBehaviour
{
    public void Awake()
    {
#if !UNITY_IOS && !UNITY_ANDROID
        return;
#endif

        // 如有需要，对跟踪器配置进行调整
        var myTrackerConfig = MyTracker.MyTrackerConfig;
        // ...
        // 调整跟踪器的参数
        // ...

        // 根据平台进行跟踪器的初始化
#if UNITY_IOS
        MyTracker.Init("SDK_KEY_IOS");
#elif UNITY_ANDROID
        MyTracker.Init("SDK_KEY_ANDROID");
#endif
    }
}

API

跟踪器的配置

跟踪器的配置可以通过MyTrackerConfig类的实例以及 MyTracker.MyTrackerConfig属性进行调整。可以设定以下参数：

IsTrackingLaunchEnabled:应用程序启动的跟踪。默认值 true。

Boolean IsTrackingLaunchEnabled { get; set; }

LaunchTimeout:当应用程序最小化时，在以秒为单位计算的时间间隔内，应用的新启动不会被计算，且会话不被中断。默认值：30秒。调整范围：30—7200秒。

Int32 LaunchTimeout { get; set; }

BufferingPeriod:在以秒为单位计算的时间间隔内，事件在发送到服务器之前将积累在相关设备上。默认值：900秒。调整范围：1—86400秒。

Int32 BufferingPeriod { get; set; }

ForcingPeriod:在以秒为单位计算的时间间隔内，事件在发送到服务器之前将积累在相关设备上。默认值：900秒。调整范围：1—86400秒。

Int32 ForcingPeriod { get; set; }

IsTrackingLocationEnabled:跟踪位置信息。 True for iOS and false for Android platforms by default.

If your Android app requests access to the user's location, we recommend enabling tracking for more accurate analytics. In the app description in Google Play, be sure to specify "Yes" in the question about collecting location data.

For the Android platform, this parameter is disabled by default since SDK version 3.0.2

Boolean IsTrackingLocationEnabled { get; set; }

Region:统计收集服务器所在的区域。例如，由于法律要求，需要更换区域。可用的值：

Since March 1, 2023, the region parameter is disabled. Regardless of the selected value, the data will be sent to servers located in the Russian Federation. To select a different region, please contact our support team

• RegionEnum.RU — 俄罗斯联邦境内的服务器

• RegionEnum.EU — 欧盟境内的服务器

public RegionEnum Region { set; }

RegisterForSkAdAttribution: SKAdNetwork attribution support. YES by default.

SKAdNetwork is Apple's solution to attribute app installations to a particular campaign while maintaining user privacy.

By default, when a user first launches the app on iOS 14.5+ devices, MyTracker SDK v2.1.2 and newer calls the SKAdNetwork method — RegisterForSkAdAttribution, to pass advertisement-driven install notifications to ad networks. For its parts, the ad network can send data to MyTracker. Since iOS 15, you can send a copy of the SKAN data directly to MyTracker in addition to sending it to ad networks.

You can choose to turn the RegisterForSkAdAttribution parameter off and set up SKAdNetwork methods on your own. Without SKAdNetwork, you will not be able to track attribution on devices if the user denied permission.

For more details, refer to the iOS & SKAdNetwork section and the Apple documentation

Boolean RegisterForSkAdAttribution { get; set; }

打开/关闭调试模式

通过MyTracker类静态属性可以打开/关闭调试模式。默认值：false。

Boolean IsDebugMode { get; set; }

用户跟踪

public void SetUserInfo()
{
    var myTrackerParams = MyTracker.MyTrackerParams;

    // 设置用户的ID
    myTrackerParams.CustomUserId = "user_id";

}

如果在设置customUserId之前，在应用程序中形成了已注册用户的数据库，那么MyTracker将无法获取有关该用户注册时间的数据，并且无法进行Lifetime指标的准确计算。对于此类用户，生命周期统计将根据customUserId首次目标跟踪的日期进行计算。

若需要禁用用户跟踪，请传递customUserId参数中的空值。

事件跟踪

通过MRMyTracker类静态方法可以发送事件。在方法调用之前，设置customUserId参数（选项）以将用户 ID 与每个跟踪事件一起传输。

您可以使用以下方法跟踪各种事件：

注册事件。 用户在应用程序中完成注册，并获取唯一ID后，您就要立刻调用该方法。在调用TrackRegistrationEvent前一定要设定 customUserId参数,否则有关事件将在没有用户ID信息的情况下被传送，导致统计不准确。

userId is a required parameter since SDK version 2.0.1

void TrackRegistrationEvent(String userId)

授权事件。 用户在应用程序中完成登录并获取唯一ID后，您就要立刻调用该方法。在调用TrackLoginEvent前一定要设定 customUserId参数,否则有关事件将在没有用户ID信息的情况下被传送，导致统计不准确。

userId is a required parameter since SDK version 2.0.1

void TrackLoginEvent(String userId)

邀请发送事件。 eventParams附加参数允许为事件设定任意键值参数。键和值的最大长度为255个字符。

void TrackInviteEvent(IDictionary<String, String> eventParams = null)

升级事件。level参数是指等级级别。eventParams附加参数允许为事件设定任意键值的参数。键和值的最大长度为255个字符。

void TrackLevelEvent(Int32? level = null, IDictionary<String, String>eventParams = null)

具有指定名称的任意事件。 eventParams附加参数允许为事件设定任意键值的参数。键和值的最大长度为255个字符。

void TrackEvent(String name, IDictionary<String, String> eventParams = null)

例子：

var IDictionary<String, String> eventCustomParams = new Dictionary<String, String>();
eventCustomParams["someParamKey1"] = "someParamValue1";
eventCustomParams["someParamKey2"] = "someParamValue2";
MyTracker.TrackEvent("eventName", eventCustomParams));

强制发送所有事件并且重置发送计时器。

为了减少信道负载，且最大程度地减少对应用程序性能的影响，在把事件发送到服务器之前，SDK会把设备上的所有事件积累在缓冲区，并定期以压缩包的形式发送收集到的数据。默认情况下，每15分钟一次将数据发送到服务器。您可以通过bufferingPeriod参数在1秒到1天的范围内调整时间间隔。如果用户已关闭了该应用程序，数据将在下次启动时被发送。但是，某些事件对于尽早进入分析至关重要，尤其是在应用程序安装后的第一个会话。用flush()方法可以达成这个目的。

void Flush()

应用内购买跟踪

void TrackPurchaseEvent(Product product, IDictionary<String, String> eventParams = null)

#if UNITY_ANDROID
void TrackPurchaseEvent(String skuDetails, String purchaseData, String dataSignature, IDictionary<String, String> eventParams = null)
#endif

获取instanceId

设备ID instanceId是应用程序首次启动时所生成的UUID v4值，在应用（或其数据）从设备删除之前保持不变。

通过MyTracker类静态方法可以获取instanceId值。

public static String InstanceId { get; }

深层链接的支持

public class YourMonoBehaviour : MonoBehaviour
{
    public void Awake()
    {
#if !UNITY_IOS && !UNITY_ANDROID
        return;
#endif

        // 如有需要，对跟踪器配置进行调整
        var myTrackerConfig = MyTracker.MyTrackerConfig;
        // ...
        // 调整跟踪器的参数
        // ...

        // 安装侦听器
        MyTracker.SetAttributionListener(attribution => Debug.Log("Attribution: " + attribution.Deeplink));

        // 根据平台进行跟踪器的初始化
#if UNITY_IOS
        MyTracker.Init("SDK_KEY_IOS");
#elif UNITY_ANDROID
        MyTracker.Init("SDK_KEY_ANDROID");
#endif
    }
}