GameReward

The reward that’s offered to participants of a game. This object is available in API version 60.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Color

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The color of the segment in the Spin the Wheel board that represents the game reward.

CurrentRewardCount

Type: int

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The number of times the reward has been provided to game participants until the current date.

Description

Type: textarea

Properties: Create, Filter, Nillable, Sort, Update

Description: The description of the reward.

GameDefinitionId

Type: reference

Properties: Create, Filter, Group, Sort

Description: The game that the reward belongs to.

This field is a relationship field.

Relationship Name: GameDefinition

Relationship Type: Lookup

Refers To: GameDefinition

ImageUrl

Type: string

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The image URL of the segment in the Spin the Wheel board that the represents the game reward.

LastReferencedDate

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The most recent date on which a user referenced this record.

LastViewedDate

Type: dateTime

Properties: Filter, Nillable, Sort

Description: The most recent date on which a user viewed this record.

MaximumRewardCount

Type: int

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: The maximum number of times the reward can be provided to game participants.

Name

Type: string

Properties: Create, Filter, Group, idLookup, Sort, Update

Description: The name of the reward.

RewardDefinitionId

Type: reference

Properties: Create, Filter, Group, Nillable, Sort, Update

Description: ID of the voucher definition that’s used to issue vouchers to customers.

ID of the voucher definition used to issue vouchers, or of the loyalty program currency used to credit points to loyalty program members as a game reward.

This field is a polymorphic relationship field.

Relationship Name: RewardDefinition

Relationship Type: Lookup

Refers To: LoyaltyProgramCurrency, VoucherDefinition

RewardType

Type: picklist

Properties: Create, Filter, Group, Restricted picklist, Sort, Update

Description: Specifies the type of reward offered by the game.

Possible values are:

CustomReward
LoyaltyPoints
NoReward
Raffle—Reserved for future use.
Voucher

RewardValue

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The value of the currency or voucher that’s issued to participants as a game reward.

WinProbability

Type: double

Properties: Create, Filter, Nillable, Sort, Update

Description: The probability of the reward being provided to a participant.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

GameRewardChangeEvent (API Version 62.0): Change events are available for the object.

GameRewardFeed: Feed tracking is available for the object.

GameRewardHistory: History is available for tracked fields of the object.