GameDefinition

Represents information about a game that's offered as a reward to customers and loyalty program 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

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 until when the game can be offered.

ExpirationPeriod

Type: int

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

Description: The number of days or months a game remains valid for play after it’s assigned.

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 customers or loyalty program members are eligible to play the game only if they’re 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.

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 for which 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.