Adjust Sherlock Analytics Service

Overview

This is an analytics service that integrates Adjust SDK with the Sherlock module for tracking and attribution analytics. For detailed information, please refer to https://matchinghamgames.gitlab.io/docs/sherlock-analytics/.

Installing

• Import package from Package Manager UI.
• Add "com.adjust" to scopes of the registry whose URL is "https://package.openupm.com" (if not exist, add). Alternatively, you can install it from here: https://openupm.com/packages/com.adjust.sdk/
• Ensure Adjust SDK (v5.0.2+) is properly installed.
• Compatible with Unity 2022.3+.

API & Details

• SendCustom(eventName: string, parameters: IDictionary<string, object> (null)) : Allows sending a custom, self styled analytics event to Adjust. Most of the events are sent with this method.

• GetAdID() : Returns the Adjust AdID for the current device. Returns a random GUID when running in editor.

• GetAttribution(): IAttributionInfo : Returns the current attribution information. When attribution is not available, it returns a null object.

• SetAttributionChangeCallback(AttributionChangeDelegate) : Sets a callback for notifications when the adjust attribution changes.

• SendInAppPurchaseRevenueEvent(string token, string transactionId, string currency, double amount, string receipt, IDictionary<string, object> extraParameters = null) : Track in-app purchase revenue through Adjust analytics.

• SendInAppPurchaseRevenueEventForVerification(string token, string transactionId, string currency, double amount, string receipt, IDictionary<string, object> extraParameters = null) : Track in-app purchase revenue through Adjust analytics with verification.

• VerifyInAppPurchaseRevenueEvent(string token, string transactionId, string currency, double amount, string receipt, IDictionary<string, object> extraParameters = null) : Verify an in-app purchase without sending the event.

• VerifyAndSendInAppPurchaseRevenueEvent(string token, string transactionId, string currency, double amount, string receipt, IDictionary<string, object> extraParameters = null) : Verify and send an in-app purchase revenue event.

Features

• Automatic iOS build configuration (AdSupport, AdServices, AppTrackingTransparency, and StoreKit frameworks)
• Automatic Android build configuration (necessary permissions)
• Privacy Manifest post-processing for iOS
• Google DMA compliance support
• Facebook SDK integration (if installed)
• Offline mode support
• Sandbox mode in development builds

Dependencies

• Adjust SDK (v5.0.2+)
• Handyman (v5.8.2+)
• Sherlock Analytics Core (v12.0.0+)
• Unity (v2022.3+)
• Logger (v2.1.0+)
• Serializable Dictionary
• DataUsageConsentManager (v11.0.0+) - for consent management

Notes

• Requires proper setup of DataUsageConsentManager for consent handling
• If using Usercentrics, ensure Adjust and its partners are added as Data Processing Services
• Sets attribution info (trackerName, trackerToken) as Firebase user properties
• Compatible with log4net when enabled