12 KiB
12 KiB
Changelog
All notable changes to this package will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
[6.0.1] - 2024-08-22
Added
- New Analytics Debug Panel accessible in the Unity Editor from Services -> Analytics -> Debug Panel
- Monitor the SDK's activity while you play-test
- Observe events as they are recorded and uploaded
- ... and more!
Breaking Changes
- The minimum supported editor version for the UGS Analytics SDK is now 2021.3
- All methods, classes and structs marked as
Obsolete
in earlier versions of the SDK have been removed- If you have trouble upgrading, move to 5.1.0 first, fix the deprecation warnings there, then move to 6.0.0
[5.1.1] - 2024-03-26
Added
- Added Apple Privacy Manifest
Changed
- Updated
com.unity.services.core
dependency to 1.12.5 which contains Apple Privacy Manifest
[5.1.0] - 2024-01-15
Added
- New
RecordEvent(...)
API which takes an instance of the newUnity.Services.Analytics.Event
class- This enables you to codify custom event schemas in helper objects by making your own sub-classes of
Event
, to avoid the risks inherent in directly using plain dictionaries with string keys - Event objects can also be pooled and reused because they are cleared immediately once their contents have been serialized
- A generic
CustomEvent
class is available which can be used in a flexible, dictionary-like way if you do not wish to make your own full sub-classes
- This enables you to codify custom event schemas in helper objects by making your own sub-classes of
Deprecated
- Standard Event recording methods that take
...Parameters
helper structs are now deprecated. Please replace them with the newEvent
sub-classes and use the newRecordEvent(...)
method.- TransactionParameters -> TransactionEvent
- TransactionFailedParameters -> TransactionFailedEvent
- AdImpressionParameters -> AdImpressionEvent
- AcquisitionSourceParameters -> AcquisitionSourceEvent
- CustomData(...) methods
- Use RecordEvent(string) for events with no parameters
- Use RecordEvent(event) for events with parameters, by using CustomEvent or creating your own sub-class of Event to contain the parameters
Improved
- Improved the descriptions of some properties on the
AdImpressionParameters
class
[5.0.2] - 2023-11-27
Fixed
- Analytics no longer throws a fatal exception on shutdown for builds made with 2023 editor versions
[5.0.1] - 2023-10-10
Fixed
- batteryLoad and deviceVolume values are no longer stale when included in some events
- Unity Player ID is no longer included twice in some events
- The Configure button in Unity Package Manager now correctly leads to the Analytics - Gaming Services page in Project Settings
- ClearBuffer(...) no longer throws ArgumentException if a player requests data deletion while an event batch upload is in progress
Improved
- Recording event timestamp and integer values is now slightly faster and generates fewer memory allocations
Changed
- The
PrivacyUrl
property now returns a link to the latest Game Player and App User Privacy Policy page, https://unity.com/legal/game-player-and-app-user-privacy-policy
[5.0.0] - 2023-06-29
Added
- New initialization and consent flow. Please see the migration guide for more information: https://docs.unity.com/ugs/en-us/manual/analytics/manual/sdk5-migration-guide
Deprecated
- The old initialization and consent flow should no longer be used and will be removed in a future version of the SDK. Please see the migration guide for more information: https://docs.unity.com/analytics/en/manual/AnalyticsSDK5MigrationGuide
Changed
- Updated
com.unity.services.core
dependency to 1.10.1
Breaking Changes
- The package no longer has a dependency on Newtonsoft.Json
- The package now has a dependency on the Unity JsonSerialize module (JsonUtility)
- A number of elements that were previously marked as Obsolete have now been removed
Fixed
- Analytics no longer blocks services initialization (
UnityServices.InitializeAsync
) if there is no internet connection - It is now possible to opt in to data collection during a session where the player has previously opted out (requires migration to the new consent flow)
- Application.persistentDataPath is no longer requested on some platforms where access to the file system is denied by default
- Event buffer is now cleared on a wider variety of server responses
- Events are more eagerly cached to disk (if available) on shutdown to prevent data loss if game is closed while offline
- Data deletion requests are now sent using the custom user ID if one is set, instead of always using the installation ID
[4.4.2] - 2023-04-04
Fixed
- Revoking consent (opting out) now successfully uploads a data deletion request
Improved
- Recording events is now significantly faster and generates fewer memory allocations
[4.4.1] - 2023-03-15
Fixed
- Changing ExternalUserId now takes effect immediately, rather than after an unpredictable delay
[4.4.0] - 2023-03-02
Added
- CustomData method now supports IDictionary<string,object>, IList