This is a JSON template for a turn-based match resource object.

Attributes

• applicationId (String): The ID of the application being played. Defaults to: null.
• autoMatchingCriteria (TurnBasedAutoMatchingCriteria): Criteria for auto-matching players into this match. Defaults to: null.
• creationDetails (TurnBasedMatchModification): Details about the match creation. Defaults to: null.
• data (TurnBasedMatchData): The data / game state for this match. Defaults to: null.
• description (String): This short description is generated by our servers based on turn state and is localized and worded relative to the player requesting the match. It is intended to be displayed when the match is shown in a list. Defaults to: null.
• inviterId (String): The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. Defaults to: null.
• kind (String): Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. Defaults to: null.
• lastUpdateDetails (TurnBasedMatchModification): Details about the last update to the match. Defaults to: null.
• matchId (String): Globally unique ID for a turn-based match. Defaults to: null.
• matchNumber (Integer): The number of the match in a chain of rematches. Will be set to 1 for the first match and incremented by 1 for each rematch. Defaults to: null.
• matchVersion (Integer): The version of this match: an increasing counter, used to avoid out-of-date updates to the match. Defaults to: null.
• participants (List[TurnBasedMatchParticipant]): The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. Defaults to: null.
• pendingParticipantId (String): The ID of the participant that is taking a turn. Defaults to: null.
• previousMatchData (TurnBasedMatchData): The data / game state for the previous match; set for the first turn of rematches only. Defaults to: null.
• rematchId (String): The ID of a rematch of this match. Only set for completed matches that have been rematched. Defaults to: null.
• results (List[ParticipantResult]): The results reported for this match. Defaults to: null.
• status (String): The status of the match. Possible values are: - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. - "MATCH_ACTIVE" - The match has started. - "MATCH_COMPLETE" - The match has finished. - "MATCH_CANCELED" - The match was canceled. - "MATCH_EXPIRED" - The match expired due to inactivity. - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. Defaults to: null.
• userMatchStatus (String): The status of the current user in the match. Derived from the match type, match status, the user's participant status, and the pending participant for the match. Possible values are: - "USER_INVITED" - The user has been invited to join the match and has not responded yet. - "USER_AWAITING_TURN" - The user is waiting for their turn. - "USER_TURN" - The user has an action to take in the match. - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) Defaults to: null.
• variant (Integer): The variant / mode of the application being played; can be any integer value, or left blank. Defaults to: null.
• withParticipantId (String): The ID of another participant in the match that can be used when describing the participants the user is playing with. Defaults to: null.