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.

[4.2.0] - 2022-08-15

Added

  • SessionID property that returns the GUID value currently being used to populate the "sessionID" parameter of all events

Changed

  • Reduced frequency of gameRunning event to reduce excess traffic (this will not affect the quality of your data)

Fixed

  • SDK initialisation failing silently on WebGL due to problem with privacy consent flow
  • SDK event batching for upload failing silently on WebGL

[4.1.0] - 2022-06-16

New

  • Added a method to access the user ID used by Analytics at runtime

Fixed

  • Events are now recorded with timestamps including milliseconds
  • XML documentation is available for more model objects
  • A better error message will be displayed when the project ID is missing

[4.0.1] - 2022-05-18

Fixed

  • Change assertions to error logs for missing required parameters

[4.0.0] - 2022-05-12

The UGS Analytics is no longer pre-release! No other changes in this version.

[4.0.0-pre.3] - 2022-05-10

Fixed

  • Events will now consistently use local time + offset for timestamps
  • Fixes an issue that could occur when the SDK was disabled

[4.0.0-pre.2] - 2022-04-06

New

  • Added a new event (transactionFailed) for recording failed transactions

Changed

  • IDFA usage has also been removed from the SDK - this identifier will no longer be added to events automatically when available.
  • This release restores the previous Events API for backwards compatability with 3.0.0 versions of the SDK. This API will be removed in a future release.

[4.0.0-pre.1] - 2022-03-14

Breaking Changes

  • The API of the Analytics package has been updated to match the other UGS packages. This means that APIs for recording events that were previously available on the Events static class are now available via AnalyticsService.Instance instead. In addition, some classes that were previously nested in other types have been moved to standalone classes.
    • The Events static class has changed to AnalyticsService.Instance - the same event recording methods are found on this new instance
    • The Transaction method now uses standalone classes for Product, TransactionType, etc.
    • The AdImpressionArgs object has been changed to an AdImpressionParameters struct
    • Some parameter objects have been changed from lowercase fields to uppercase to match C# guidelines
  • Code in the Unity.Services.Analytics.Editor.Settings namespace has been made internal as it was never meant to be public.

New Features

  • Added support for sending a new event: acquisitionSource.
  • Added a method to convert currency to units suitable for the Transaction event
  • Added new Sample Scene
  • Added abilitiy to disable and re-enable the Analytics SDK

Bug Fixes

  • Fixed a bug that would block the main thread when trying to send large amounts of events

[3.0.0-pre.4] - 2022-02-15

  • Fixed a bug where event data was not cached locally when the game closes
  • Fixed a bug where floats were not serialized properly in cultures where the , character is used for decimals rather than .

[3.0.0-pre.3] - 2022-01-27

  • Adds support for using a custom analytics ID via the Core SDK.

[3.0.0-pre.2] - 2021-12-02

  • Analytics Runtime dependency has been updated, the PIPL headers are now included in ForgetMe event, when appropriate.

[3.0.0-pre.1] - 2021-11-26

Added

Breaking Change:

  • New APIs provided for checking if PIPL consent is needed, and recording users' consent. It is now required to check if any consent is required, and provide that consent if necessary, before the events will be sent from the SDK.

[2.0.7-pre.7] - 2021-10-20

Added

  • projectID parameter to all events

Fixed

  • GameStart event idLocalProject having a nonsense value
  • Heartbeat cadence being affected by Time Scale
  • Failing to compile for WebGL with error " The type or namespace name 'DllImportAttribute' could not be found"

Changed

  • User opt-out of data collection. Developers must expose this mechanism to users in an appropriate way:
    • Give users access to the privacy policy, the URL for which is stored in the Events.PrivacyUrl property
    • Disable analytics if requested using the Events.OptOut() method

Removed

  • Deprecated Transaction event isInitiator parameter
  • Deprecated previous opt-out mechanism (DataPrivacy and DataPrivacyButton)

[2.0.7-pre.6] - 2021-08-26

Fixed

  • GameRunning event being recorded and uploaded erratically
  • Removed some obsolete steps from readme
  • Clarified and added some missing XmlDoc comments on public methods

[2.0.7-pre.4] - 2021-08-19

Changed

  • Updated README
  • Regenerated .meta files for privacy

[2.0.7-pre.2] - 2021-08-18

Removed

  • Version of CustomData method that takes an Event Version

Changed

  • Regen'd .meta files for privacy

Added

  • Added UI as a dependency

[2.0.7] - 2021-08-09

Changed

  • New custom code entry point.
  • Arguments for AdImpression now handled by an object.

Added

  • New way to interact with buffer.

[2.0.6] - 2021-06-17

Changed

  • Bump dependencies

[2.0.5] - 2021-05-18

Changed

  • Use Core for Authentication ID
  • Use Core for Install ID
  • Use https instead of http

[2.0.4] - 2021-05-10

Changed

  • URL now uses the new collect url based off project_id and not a legacy one.

Removed

  • UI for setting up the collect url.

[2.0.3] - 2021-05-05

Added

  • Re added support for 2019.4
  • Update dependencies

[2.0.2] - 2021-04-29

Added

  • Project settings UI

Removed

  • Setup() API entry point
  • Custom UserID and SessionID

[0.1.1] - 2021-04-01

Changed

  • Removed util package
  • Changed RecordEvent entry point to CustomData

[0.1.0] - 2021-03-31

Added

  • Standard events