Campaign

Campaign is a LiveOps service that enables no-code A/B testing and feature flagging. Game operators can create time-bounded campaigns that modify game behavior for targeted player segments — without deploying new code.

API Summary

• SysTriggerCampaignForUser - Triggers a campaign scenario for a specific player, bypassing normal eligibility constraints. Player must be flagged as a tester.
• SysRemoveCampaignForUser - Removes a player's participation in a specific campaign.
• SysRemoveAllCampaignsForUser - Removes a player's participation in all campaigns.
• SysCreateCampaign - Creates a new campaign. A control scenario is automatically created alongside the campaign.
• SysReadCampaign - Reads a campaign's full configuration, optionally including the details of every scenario.
• SysUpdateCampaign - Updates some or all of a campaign's configuration fields.
• SysDeleteCampaign - Deletes a campaign along with all of its scenarios, participation records and metrics.
• SysEnableCampaign - Enables or disables a campaign without changing any other fields.
• SysGetCampaignPage - Returns a filtered, sorted page of the app's campaigns.
• SysGetCampaignPageOffset - Returns another page of campaigns using the context from a previous page request.
• SysCreateScenario - Creates a new variant scenario under a campaign.
• SysReadScenario - Reads a campaign scenario's full configuration.
• SysUpdateScenario - Updates some or all of a variant scenario's configuration fields.
• SysDeleteScenario - Deletes a variant scenario and moves its weight to the control scenario.
• SysUpdateCampaignScenarioWeights - Sets the traffic split between a campaign's scenarios.
• SysUpdateCampaignJson - Updates only the free-form campaignJson custom payload on a campaign.
• SysUpdateScenarioJson - Updates only the free-form scenarioJson custom payload on a campaign scenario.

tip

All client APIs whose names begin with "Sys" are also available to S2S. For the usages of the S2S campaign APIs, refer to the brainCloud client campaign APIs.

🗃️ Cloud Code Bridge

18 items

🗃️ Authentication

1 item

📄️ Campaign

Campaign is a LiveOps service that enables no-code A/B testing and feature flagging. Game operators can create time-bounded campaigns that modify game behavior for targeted player segments — without deploying new code.

🗃️ Chat

12 items

🗃️ Custom Entity

6 items

🗃️ Event

1 item

🗃️ Friend

1 item

🗃️ Gamification

1 item

🗃️ Global App

1 item

🗃️ Global Entity

17 items

🗃️ Global File

18 items

🗃️ Global Statistics

5 items

🗃️ Group

1 item

🗃️ Group File

1 item

🗃️ Heartbeat

1 item

🗃️ HTTP Client

8 items

🗃️ Identity

1 item

🗃️ Item Catalog

9 items

🗃️ Leaderboard

9 items

🗃️ Lobby

6 items

🗃️ Logging

6 items

🗃️ Mail

3 items

🗃️ Messaging

7 items

📄️ Playback Stream

The PlaybackStreamService allows for the creation and replay of a series of events. A Stream can be created using the StartStream call.

📄️ Player State

The Player State service provides session management operations for use by server-side scripts. These system calls allow invalidating active sessions for users, useful for implementing forced logout or security enforcement workflows.

📄️ Player Statistics

The BrainCloudPlayerStatistics service is used for all user-scoped statistics operations, including Player Experience (XP).

🗃️ Presence

4 items

🗃️ ProductManagement

9 items

🗃️ Promotions

6 items

🗃️ Push Notifications

14 items

🗃️ Redemption Codes

6 items

📄️ Report

Report is a new service that allows devs to retrieve user-analytics-report data programmatically via S2S and cloud-code.

📄️ RoomServer

RoomServer service allows devs to directly launch hosted servers without going through lobby matchmaking.

🗃️ RTT

1 item

🗃️ Script

11 items

🗃️ Segment

1 item

🗃️ SuperRTT

2 items

🗃️ Time

1 item

🗃️ Tournament

2 items

📄️ User

The User service, introduced in version 4.3, supports basic user CRUD operations and allows iteration over all users in an app. Note that this service is only accessible via Cloud Code.

📄️ User Items

The User Items service, introduced in 4.2, is used to manage a collection of in-app items that users can be awarded, buy, sell, or trade (using virtual currency). Optionally, these items can be backed up to the blockchain.

🗃️ Virtual Currency

3 items