GameDefinition

Represents information about a game that the loyalty program offers to its members. 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

Field	Details
Description	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The description of the game.
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date till which the game can be offered to members.
ExpirationPeriod	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The number of days or months for which a game is valid for a member to play after the game is assigned to them.
ExpirationPeriodUnit	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The unit of measure for the ExpirationPeriod field. Possible values are: `Days` `Months`
IsGameAssignmentRequired	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether members are eligible to play the game only if they are assigned the game (`true`) or not (`false`). The default value is `false`.
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.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The name of the game.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
StartDate	Type dateTime Properties Create, Filter, Sort, Update Description The date from which the game can be offered to members.
Status	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the game. Possible values are: `Active` `Draft` `Inactive`
TimeoutDuration	Type int Properties Create, Filter, Group, Nillable, Sort, Update Description The duration the game is valid for after a participant starts to play it. The value is specified in seconds.
Type	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The type of game. Possible values are: `Scratchcard` `SpintheWheel`—Spin The Wheel

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.

GameDefinitionFeed: Feed tracking is available for the object.
GameDefinitionHistory: History is available for tracked fields of the object.
GameDefinitionShare: Sharing is available for the object.

Loyalty Management Developer Guide

GameDefinition

Supported Calls

Fields

Associated Objects