Skip to main content

UgsPush

26 tools in this family (folder Editor/Tools/UgsPush/ 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.

ToolEffectDescription
ugs_push_cancel_campaignwritesCancel a campaign permanently (status → Cancelled, ends_at_utc set). Terminal state —
ugs_push_create_campaignwritesCreate a campaign — a named, scheduled (OneShot | Recurring | Drip) push job targeted at
ugs_push_create_experimentwritesCreate an A/B experiment with two variants and a distribution split. variant_a /
ugs_push_create_segmentwritesCreate a named audience segment. Conditions are AND-joined (every condition must hold).
ugs_push_create_templatewritesCreate a reusable Mustache-style ({{var_name}}) message template. Variables are extracted
ugs_push_delete_campaignwritesDelete a campaign and its analytics roll-up. Hard delete — prefer Cancel when you want
ugs_push_emit_deep_link_routerwritesEmit a drop-in deep link router. Parses myapp://host/path → SceneManager.LoadScene via
ugs_push_emit_fcm_handlerwritesEmit a drop-in Android FCM service handler MonoBehaviour. Forwards new tokens into
ugs_push_evaluate_segmentread-onlyRe-evaluate the segment against the current device pool and return the player count.
ugs_push_export_setupread-onlyExport a snapshot of the current Push setup as a single JSON blob: every registered
ugs_push_get_campaign_statsread-onlyReturn roll-up analytics for a campaign: sent, delivered, opened, clicked counts plus
ugs_push_get_experiment_resultsread-onlyReturn per-variant sent / opened / clicked counts + CTRs for an A/B experiment, plus the
ugs_push_get_registration_statusread-onlyReturn every device record registered under the player (iOS + Android + Web — players
ugs_push_initwritesInitialize UGS Push Notifications. Verifies UGS Authentication is initialized + signed in.
ugs_push_list_campaignsread-onlyList push campaigns ordered by created_utc descending. Optional filters: 'status' (Draft |
ugs_push_list_segmentsread-onlyList every defined segment with conditions + cached estimated_player_count. Mock mode
ugs_push_pause_campaignwritesPause an active or scheduled campaign. No further sends will fire until ugs_push_resume_
ugs_push_register_devicewritesRegister a device token under a player. The token is the APNs / FCM / WebPush token captured
ugs_push_render_templateread-onlyRender a template against a variable map → notification payload. Variables not supplied
ugs_push_resume_campaignwritesResume a previously-paused campaign (status Paused → Running). Idempotency: if the
ugs_push_send_campaign_nowwritesForce a campaign to send to its target segment immediately, regardless of its schedule.
ugs_push_send_to_alldestructiveDANGEROUS — push to EVERY registered device, optionally filtered by platform
ugs_push_send_to_playerwritesSend a single notification immediately to one player (every registered device for the
ugs_push_send_to_playerswritesBulk-send a single payload to a list of player ids (length 1-10000). Useful for friend-
ugs_push_send_to_segmentwritesResolve the segment to its current player population and deliver the payload to every
ugs_push_unregister_devicewritesRemove a single (player_id, device_token) registration. Use on app uninstall callbacks or