Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Solved
  • Unsolved
  • Users
Skins
  • Light
  • Brite
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (Darkly)
  • No Skin
Collapse
brainCloud Forums
  1. Home
  2. General
  3. Confirming Campaign feature write API limitations and Trigger timing (v6.0)

Confirming Campaign feature write API limitations and Trigger timing (v6.0)

Scheduled Pinned Locked Moved Solved General
3 Posts 2 Posters 28 Views 2 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • J Offline
    J Offline
    jongdae.won
    wrote last edited by
    #1

    Hi brainCloud team,

    We're evaluating the LiveOps Campaign feature for a time-limited in-game event system, and based on the public documentation and our local SDK/CloudCode type definitions, we've drawn some conclusions we'd like to confirm before committing to a design around them. Could you help verify the following?

    1. No write/update operation for Campaign definitions
      Per docs.braincloudservers.com/api/capi/campaign/ and .../api/s2s/campaign/, the only operations exposed are GetMyCampaigns, SysTriggerCampaignForUser, SysRemoveCampaignForUser, and SysRemoveAllCampaignsForUser — all of which manage a specific player's enrollment/participation, not the campaign definition itself. We see that GetMyCampaigns returns free-form campaignJson and scenarioJson fields, but we can't find any operation (Client API or S2S) that writes to campaignJson/scenarioJson/startAt/endAt/scenarios/overrides after the campaign is created.

    Is this correct — is Campaign definition data (including campaignJson) only editable through the Design Portal UI, with no API path (including any Server-to-Server or "Sys"-prefixed operation) to create or update it programmatically?
    Is there a separate Builder/Design API (e.g. using a personal team-member API key rather than app credentials) that does support programmatic campaign creation/updates? If so, could you point us to its documentation?

    1. Trigger evaluation timing
      The docs state Trigger is "evaluated on LOGIN or REGISTRATION." For a player who is already in an active session when a campaign's startAt passes, will they be evaluated/enrolled into that campaign before their next login (e.g. on their next authenticated API call), or strictly only on an actual login/registration event? If the latter, is there any other mechanism (e.g. session refresh, heartbeat) that also triggers re-evaluation?

    2. Feature maturity / plan tier
      LiveOps Campaigns is marked beta as of SDK 6.0 documentation.

    Is this feature considered stable enough for production use in a live game (i.e. tied to real reward grants), or is it still recommended for experimentation only?
    Our production app is on a Bulk+ 100M plan add-on over a Business Plus baseline. Does this tier fully support Campaign, or does it require a separate Enterprise-tier confirmation?

    1. Cross-environment campaign management
      We maintain separate brainCloud apps for dev/staging/production and use our own internal tooling to diff and promote Custom Entity–based content between them via S2S. Since Campaign isn't a Custom Entity, is there any supported way (API-driven or otherwise) to keep a Campaign definition consistent across multiple apps, other than manually re-creating it in each app's Design Portal?

    Thanks in advance — confirming these will directly decide whether we build our event schedule/targeting on Campaign or on an alternative (Custom Entity–based) mechanism.

    Best regards

    1 Reply Last reply
    0
    • Paul WinterhalderP Offline
      Paul WinterhalderP Offline
      Paul Winterhalder
      brainCloudAdmin
      wrote last edited by
      #2

      Hi Jongdae,

      Great questions!

      Before I answer them, though - heads up that we have an update to LiveOps campaigns coming next week. It provides a great analytics screen for campaigns, so you can see how they are impacting player engagement, monetization, retention, etc.

      That said, you are pointing out some additional caps that we'll want to address quickly:

      1. The management APIs for campaigns are following in a future release - but we can see about getting some APIs that specifically target updating the custom JSON for campaigns and scenarios. I'm going to see if I can slip that into next week's release.

      2. Right now campaign enrollment is only triggered upon login. We're planning to add an optional "trigger": true flag ot the getMyCampaigns() call, though - which would allow games to make that call periodically (i.e., after the player finishes a "match," perhaps), as makes sense on a per-game basis. Longer-term, we are considering adding an RTT channel that clients could listen to to be notified of when a new campaign launches...

      3. Feature maturity - with the 6.0.1 update that we're releasing, the feature is mature enough to build upon. We'll continue to extend it, but we can do so without invalidating the foundation we have built.

      4. Cross-environment campaign management - we'll be adding some features to allow easy importing / exporting of campaigns between environments. Plus the S2S management api will help too... All coming this fall!

      I hope that helps,

      Paul.

      1 Reply Last reply
      0
      • J Offline
        J Offline
        jongdae.won
        wrote last edited by
        #3

        The answer was very helpful. Thank you for the quick feedback!

        1 Reply Last reply
        0
        • J jongdae.won has marked this topic as solved

        Hello! It looks like you're interested in this conversation, but you don't have an account yet.

        Getting fed up of having to scroll through the same posts each visit? When you register for an account, you'll always come back to exactly where you were before, and choose to be notified of new replies (either via email, or push notification). You'll also be able to save bookmarks and upvote posts to show your appreciation to other community members.

        With your input, this post could be even better 💗

        Register Login
        Reply
        • Reply as topic
        Log in to reply
        • Oldest to Newest
        • Newest to Oldest
        • Most Votes


        • Login

        • Login or register to search.
        • First post
          Last post
        0
        • Categories
        • Recent
        • Tags
        • Popular
        • Solved
        • Unsolved
        • Users