Loyalty Management Developer Guide

Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Apex Reference
Loyalty Management Business APIs
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Supported Versions of Tools and Components
Gamification Mobile SDK for iOS
Clone and Import Gamification Mobile SDK for iOS
Integrate Gamification Mobile iOS SDK into Loyalty Management Mobile iOS SDK
Gamification Mobile SDK iOS Classes
Gamification Mobile SDK API Reference for iOS
Assigned Games
Game reward
Game Zone UI Customization for iOS
Gamification Mobile SDK for Android
Data Processing Engine, Batch Management, and Monitor Workflow Services
Decision Table
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Assigned Games

Get a list of eligible, expired, and played games, such as Spin the Wheel, or Scratch card, for a loyalty program member, an account, or a contact.

Resource

Signature

Input Parameters

Parameter Type Description Required or Optional
devMode Boolean Indicates whether the method is run in the developer mode (true) or not (false). Optional
mockFileName String The name of the file that has the sample response. Optional
participantId String The ID of a loyalty program member, an account, or a contact whose eligible games are to be retrieved. Required
version String Version of the API. The request body is available in version 60.0 and later. Optional

Return Value

A GameModel instance.

Sample Output

Output Parameters

Property Name Type Description Filter Group and Version Available Version
message String Message that provides the reason why a list of games weren't found for the participant. Small, 60.0 60.0
gameDefinitions GameDefinition[] List of game definitions associated with the games assigned to the member.

A game definition has the details of a game, including:

  • The list of possible rewards for the game.
  • The participant game reward records that contain details of the game reward the participant has won for each game play, or can win after playing the game.
 Small, 60.0 60.0
status Boolean Indicates whether the request succeeded (true) or failed (false). Small, 60.0 60.0
Table 1. GameDefinition
Property Name Type Description Filter Group and Version Available Version
description String Description of the game. Small, 60.0 60.0
endDate String Date until which participants are eligible to play the game. Small, 60.0 60.0
gameDefinitionId String ID of the game definition associated with the game. Small, 60.0 60.0
gameRewards GameReward [] List of possible rewards for a game. Small, 60.0 60.0
name String Name of the game definition. Small, 60.0 60.0
participantGameRewards ParticipantGameReward[] List of participant game reward records that contain the details of the game reward the participant has won for each game play, or can win after playing the game. Small, 60.0 60.0
startDate String Date from which participants are eligible to play the game. Small, 60.0 60.0
timeoutDuration Integer Duration of the game in seconds before the game session times out. Small, 60.0 60.0
type String Type of the game. Possible values are:
  • Scratchcard
  • SpintheWheel
 Small, 60.0 60.0
Table 2. GameReward
Property Name Type Description Filter Group and Version Available Version
color String Color of the segment in the Spin the Wheel game that represents the game reward. Small, 60.0 60.0
description String Description of the game reward. Small, 60.0 60.0
imageUrl String Image URL of the segment in the Spin the Wheel game that represents the game reward. Small, 60.0 60.0
name String Name of the game reward. Small, 60.0 60.0
gameRewardId String ID of the game reward. Small, 60.0 60.0
rewardType String Type of the game reward. Possible values are:
  • CustomReward
  • LoyaltyPoints
  • NoReward
  • Raffle
  • Voucher
 Small, 60.0 60.0
rewardValue String Value of the voucher, or the number of points to credit as a game reward to participants. Small, 60.0 60.0
Table 3. ParticipantGameReward
Property Name Type Description Filter Group and Version Available Version
expirationDate String Date until which the game reward is valid. Small, 60.0 60.0
gameParticipantRewardId String ID of the participant game reward object. Small, 60.0 60.0
gameRewardId String ID of the game reward won. This field is null for a game yet to be played. Small, 60.0 60.0
issuedRewardReference String Voucher ID, or the transaction journal ID associated with the voucher, or the loyalty points rewarded to the participant. This field is null for a game yet to be played. Small, 60.0 60.0
sourceActivity String ID of the promotion, or the transaction journal that is associated with the activity because of which the participant was eligible to play the game. Examples of source activities include purchasing a product, and reviewing on social media.

This field is null for a game yet to be played.

 Small, 60.0 60.0
status String Status of the reward. Possible values are:
  • Expired
  • NoReward
  • Rewarded
  • YetToReward
 Small, 60.0 60.0