UgsAnalytics
16 tools in this family (folder Editor/Tools/UgsAnalytics/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.
| Tool | Effect | Description |
|---|---|---|
ugs_analytics_export_setup | read-only | Export the complete analytics setup as a portable JSON document: identity (player_id, session_id, |
ugs_analytics_flush | writes | Force-flush buffered events to the server right now (bypasses the 60s auto-flush cadence). Useful |
ugs_analytics_get_buffer_status | read-only | Return analytics buffer health: pending_count (events queued but not yet flushed), last_flushed_utc |
ugs_analytics_get_session_id | read-only | Return the current analytics session id. Sessions auto-start on init, auto-rotate after 1 hour of |
ugs_analytics_get_user_properties | read-only | Return every user property currently attached to the player. Includes the mock defaults |
ugs_analytics_init | writes | Initialize UGS Analytics. Verifies UGS Authentication is initialized and the player is signed in |
ugs_analytics_record_acquisition | writes | Record an install attribution payload — paid user acquisition tracking. Pair with a deferred deep |
ugs_analytics_record_ad_impression | writes | Record a paid ad impression — sent every time an interstitial / rewarded / banner displays. Used |
ugs_analytics_record_cohort | writes | Tag the user as belonging to a cohort. Cohorts are slice-cuts the dashboard exposes: 'whale' (LTV |
ugs_analytics_record_standard_event | writes | Send a pre-defined Unity standard event with Unity-enforced schema. Valid kinds: gameStarted (no |
ugs_analytics_request_data_deletion | destructive | DESTRUCTIVE. GDPR / CCPA right-to-be-forgotten — issues a server-side delete request for ALL |
ugs_analytics_send_event | writes | Send a custom analytics event. Event name must match [A-Za-z0-9_]+ and be <= 64 characters. The |
ugs_analytics_set_user_property | writes | Set a per-user property attached to every event the player sends afterwards. Properties are visible |
ugs_analytics_setup_auto_tracker | writes | Generate ready-to-drop C# files for a project: a consent toggle UI (opt-in/out + GDPR delete button)… |
ugs_analytics_start_collection | writes | Opt the player IN to analytics data collection. Call AFTER the privacy consent UI returns 'consent |
ugs_analytics_stop_collection | writes | Opt the player OUT of analytics data collection. Subsequent send_event / record_standard_event calls… |