Skip to main content

offer.targeted

Generated from spec/protocol.yaml. Do not edit by hand.

Overview

  • ID: 119
  • Header: TARGET_OFFER
  • Direction: Server to Client (s2c)
  • Realm: Subscription & Offers
  • Phase: session
  • Since: nitro-1.6.6
  • Summary: Deliver a targeted offer to the player

Payload fields

FieldTypeRequiredDescription
offerIdint32requiredTargeted offer identifier.
identifierstringrequiredInternal offer string key.
productCodestringrequiredPrimary product code.
priceCreditsint32requiredCredit cost.
priceActivityPointsint32requiredActivity point cost.
activityPointTypeint32requiredType of activity points used.
purchaseLimitint32requiredMaximum number of times this offer can be purchased.
expirationTimeint32requiredSeconds until the offer expires.
titlestringrequiredDisplay title.
descriptionstringrequiredOffer description text.
imageUrlstringrequiredURL of the offer banner image.
iconImageUrlstringrequiredURL of the offer icon.
typeint32requiredOffer layout type.
subProductCodeslist<string>requiredAdditional product codes included in the offer.

Behavior

Sender

Sent on login or in response to a targeted offer request when one is available.

Receiver

The client displays the targeted offer overlay with the offer details, products, and pricing.

Notes

  • No additional notes