跳至主要内容

Onboarding banner action node for campaign graphs

What's new

Campaign graphs accept a new node type, CreateOnboardingPlayerBannerActionNode, which places a checklist banner on a Game Hub page. It carries the same placement fields as the existing CreateItemBannerActionNodepage_id or page_slug for where the banner goes, and duration for how long it stays — but its config is a TranslatableOnboardingPlayerBannerConfig:

  • title, description, image_url, and background_image_size for the banner itself.
  • tasks — 1 to 10 TranslatableOnboardingTask entries. Required.
  • loyalty_program_id and progression_program_id, naming the programs that task points go to.

Each task has a required type — one of submit_email, pwa_install, or webpush_subscribe — plus its own title, description, and image_url, a points value (minimum 1), and up to 10 rewards. A reward is an item_id, a quantity, and an image_url.

The node is campaign-only. Page graph_rules and segment-group graphs are unchanged.

Impact

The three onboarding asks that campaigns already handled one node at a time — EmailPromptActionNode, PWAPromptActionNode, and WebpushPromptActionNode — can now run as a single banner with visible progress and a reward per step, instead of a chain of popups.

Changes

ResourceChange
create_campaign, update_campaignAdded the node to the graph.nodes discriminator and oneOf
update_campaign_graphAdded the node to the graph nodes discriminator and oneOf on the request
get_campaign_graphAdded the node to the graph nodes discriminator and oneOf on the 200 response

Upgrade

  • No action required. To use the node, add an entry to the campaign graph nodes map with model_type set to CreateOnboardingPlayerBannerActionNode and a config holding at least one task.
  • Clients that read campaign graphs against a generated model should regenerate — this node type can now come back in a get_campaign_graph response, and a strict decoder will reject it.

需要技术支持?
联系我们的集成技术团队: [email protected]