| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="games_v1.html">Google Play Game Services API</a> . <a href="games_v1.turnBasedMatches.html">turnBasedMatches</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 78 | <code><a href="#cancel">cancel(matchId)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 79 | <p class="firstline">Cancel a turn-based match.</p> |
| 80 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(body=None, language=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 82 | <p class="firstline">Create a turn-based match.</p> |
| 83 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <code><a href="#decline">decline(matchId, language=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 85 | <p class="firstline">Decline an invitation to play a turn-based match.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 87 | <code><a href="#dismiss">dismiss(matchId)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 88 | <p class="firstline">Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications.</p> |
| 89 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 90 | <code><a href="#finish">finish(matchId, body=None, language=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 91 | <p class="firstline">Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state.</p> |
| 92 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 93 | <code><a href="#get">get(matchId, includeMatchData=None, language=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 94 | <p class="firstline">Get the data for a turn-based match.</p> |
| 95 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 96 | <code><a href="#join">join(matchId, language=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 97 | <p class="firstline">Join a turn-based match.</p> |
| 98 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 99 | <code><a href="#leave">leave(matchId, language=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 100 | <p class="firstline">Leave a turn-based match when it is not the current player's turn, without canceling the match.</p> |
| 101 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | <code><a href="#leaveTurn">leaveTurn(matchId, matchVersion, language=None, pendingParticipantId=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 103 | <p class="firstline">Leave a turn-based match during the current player's turn, without canceling the match.</p> |
| 104 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 105 | <code><a href="#list">list(includeMatchData=None, language=None, maxCompletedMatches=None, maxResults=None, pageToken=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 106 | <p class="firstline">Returns turn-based matches the player is or was involved in.</p> |
| 107 | <p class="toc_element"> |
| 108 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 109 | <p class="firstline">Retrieves the next page of results.</p> |
| 110 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 111 | <code><a href="#rematch">rematch(matchId, language=None, requestId=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 112 | <p class="firstline">Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn.</p> |
| 113 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 114 | <code><a href="#sync">sync(includeMatchData=None, language=None, maxCompletedMatches=None, maxResults=None, pageToken=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 115 | <p class="firstline">Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED.</p> |
| 116 | <p class="toc_element"> |
| 117 | <code><a href="#sync_next">sync_next(previous_request, previous_response)</a></code></p> |
| 118 | <p class="firstline">Retrieves the next page of results.</p> |
| 119 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 120 | <code><a href="#takeTurn">takeTurn(matchId, body=None, language=None)</a></code></p> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 121 | <p class="firstline">Commit the results of a player turn.</p> |
| 122 | <h3>Method Details</h3> |
| 123 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 124 | <code class="details" id="cancel">cancel(matchId)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 125 | <pre>Cancel a turn-based match. |
| 126 | |
| 127 | Args: |
| 128 | matchId: string, The ID of the match. (required) |
| 129 | </pre> |
| 130 | </div> |
| 131 | |
| 132 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 133 | <code class="details" id="create">create(body=None, language=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 134 | <pre>Create a turn-based match. |
| 135 | |
| 136 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 137 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 138 | The object takes the form of: |
| 139 | |
| 140 | { # This is a JSON template for a turn-based match creation request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 141 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 142 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 143 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 144 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 145 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 146 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 147 | "invitedPlayerIds": [ # The player ids to invite to the match. |
| 148 | "A String", |
| 149 | ], |
| 150 | "kind": "games#turnBasedMatchCreateRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchCreateRequest. |
| 151 | "requestId": "A String", # A randomly generated numeric ID. This number is used at the server to ensure that the request is handled correctly across retries. |
| 152 | "variant": 42, # The variant / mode of the application to be played. This can be any integer value, or left blank. You should use a small number of variants to keep the auto-matching pool as large as possible. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 153 | } |
| 154 | |
| 155 | language: string, The preferred language to use for strings returned by this method. |
| 156 | |
| 157 | Returns: |
| 158 | An object of the form: |
| 159 | |
| 160 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 161 | "applicationId": "A String", # The ID of the application being played. |
| 162 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 163 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 164 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 165 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 166 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 167 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 168 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 169 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 170 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 171 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 172 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 173 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 174 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 175 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 176 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 177 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "description": "A 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. |
| 179 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 180 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 181 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 182 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 183 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 184 | "participantId": "A String", # The ID of the participant that modified the match. |
| 185 | }, |
| 186 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 187 | "matchNumber": 42, # 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. |
| 188 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 189 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 190 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 191 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 192 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 193 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 194 | "displayName": "A String", # The name to display for the anonymous player. |
| 195 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 196 | }, |
| 197 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 198 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 199 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 200 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 201 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 202 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 203 | "displayName": "A String", # The name to display for the player. |
| 204 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 205 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 206 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 207 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 208 | "level": 42, # The level for the user. |
| 209 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 210 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 211 | }, |
| 212 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 213 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 214 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 215 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 216 | "level": 42, # The level for the user. |
| 217 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 218 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 219 | }, |
| 220 | }, |
| 221 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 222 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 223 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 224 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 225 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 226 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 227 | }, |
| 228 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 229 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 230 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 231 | }, |
| 232 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 233 | "playerId": "A String", # The ID of the player. |
| 234 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 235 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 236 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 237 | "profileVisible": True or False, |
| 238 | }, |
| 239 | "title": "A String", # The player's title rewarded for their game activities. |
| 240 | }, |
| 241 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 242 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 243 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 244 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 245 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 246 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 247 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 248 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 249 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 250 | }, |
| 251 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 252 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 253 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 254 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 255 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 256 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 257 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 258 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 259 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 260 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 262 | "participantId": "A String", # The ID of the participant. |
| 263 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 264 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 265 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 266 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 267 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 268 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 269 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 270 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 271 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 272 | }, |
| 273 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 274 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 275 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 276 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 277 | # - "MATCH_ACTIVE" - The match has started. |
| 278 | # - "MATCH_COMPLETE" - The match has finished. |
| 279 | # - "MATCH_CANCELED" - The match was canceled. |
| 280 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 281 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 282 | "userMatchStatus": "A 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. |
| 283 | # Possible values are: |
| 284 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 285 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 286 | # - "USER_TURN" - The user has an action to take in the match. |
| 287 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 288 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 289 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 290 | }</pre> |
| 291 | </div> |
| 292 | |
| 293 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 294 | <code class="details" id="decline">decline(matchId, language=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 295 | <pre>Decline an invitation to play a turn-based match. |
| 296 | |
| 297 | Args: |
| 298 | matchId: string, The ID of the match. (required) |
| 299 | language: string, The preferred language to use for strings returned by this method. |
| 300 | |
| 301 | Returns: |
| 302 | An object of the form: |
| 303 | |
| 304 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 305 | "applicationId": "A String", # The ID of the application being played. |
| 306 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 307 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 308 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 309 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 310 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 311 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 312 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 313 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 314 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 315 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 316 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 317 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 318 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 319 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 320 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 321 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 322 | "description": "A 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. |
| 323 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 324 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 325 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 326 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 327 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 328 | "participantId": "A String", # The ID of the participant that modified the match. |
| 329 | }, |
| 330 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 331 | "matchNumber": 42, # 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. |
| 332 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 333 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 334 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 335 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 336 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 337 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 338 | "displayName": "A String", # The name to display for the anonymous player. |
| 339 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 340 | }, |
| 341 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 342 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 343 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 344 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 345 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 346 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 347 | "displayName": "A String", # The name to display for the player. |
| 348 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 349 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 350 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 351 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 352 | "level": 42, # The level for the user. |
| 353 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 354 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 355 | }, |
| 356 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 357 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 358 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 359 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 360 | "level": 42, # The level for the user. |
| 361 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 362 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 363 | }, |
| 364 | }, |
| 365 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 366 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 367 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 368 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 369 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 370 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 371 | }, |
| 372 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 373 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 374 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 375 | }, |
| 376 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 377 | "playerId": "A String", # The ID of the player. |
| 378 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 379 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 380 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 381 | "profileVisible": True or False, |
| 382 | }, |
| 383 | "title": "A String", # The player's title rewarded for their game activities. |
| 384 | }, |
| 385 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 386 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 387 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 388 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 389 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 390 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 391 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 392 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 393 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 394 | }, |
| 395 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 396 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 397 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 398 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 399 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 400 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 401 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 402 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 403 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 404 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 405 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 406 | "participantId": "A String", # The ID of the participant. |
| 407 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 408 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 409 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 410 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 411 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 412 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 413 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 414 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 415 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 416 | }, |
| 417 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 418 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 419 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 420 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 421 | # - "MATCH_ACTIVE" - The match has started. |
| 422 | # - "MATCH_COMPLETE" - The match has finished. |
| 423 | # - "MATCH_CANCELED" - The match was canceled. |
| 424 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 425 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 426 | "userMatchStatus": "A 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. |
| 427 | # Possible values are: |
| 428 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 429 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 430 | # - "USER_TURN" - The user has an action to take in the match. |
| 431 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 432 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 433 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 434 | }</pre> |
| 435 | </div> |
| 436 | |
| 437 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 438 | <code class="details" id="dismiss">dismiss(matchId)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 439 | <pre>Dismiss a turn-based match from the match list. The match will no longer show up in the list and will not generate notifications. |
| 440 | |
| 441 | Args: |
| 442 | matchId: string, The ID of the match. (required) |
| 443 | </pre> |
| 444 | </div> |
| 445 | |
| 446 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 447 | <code class="details" id="finish">finish(matchId, body=None, language=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 448 | <pre>Finish a turn-based match. Each player should make this call once, after all results are in. Only the player whose turn it is may make the first call to Finish, and can pass in the final match state. |
| 449 | |
| 450 | Args: |
| 451 | matchId: string, The ID of the match. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 452 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 453 | The object takes the form of: |
| 454 | |
| 455 | { # This is a JSON template for a turn-based match results object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 456 | "data": { # This is a JSON template for sending a turn-based match data object. # The final match data. |
| 457 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 458 | "kind": "games#turnBasedMatchDataRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchDataRequest. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 459 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 460 | "kind": "games#turnBasedMatchResults", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchResults. |
| 461 | "matchVersion": 42, # The version of the match being updated. |
| 462 | "results": [ # The match results for the participants in the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 463 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 464 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 465 | "participantId": "A String", # The ID of the participant. |
| 466 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 467 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 468 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 469 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 470 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 471 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 472 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 473 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 474 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 475 | }, |
| 476 | ], |
| 477 | } |
| 478 | |
| 479 | language: string, The preferred language to use for strings returned by this method. |
| 480 | |
| 481 | Returns: |
| 482 | An object of the form: |
| 483 | |
| 484 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 485 | "applicationId": "A String", # The ID of the application being played. |
| 486 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 487 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 488 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 489 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 490 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 491 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 492 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 493 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 494 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 495 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 496 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 497 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 498 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 499 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 500 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 501 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 502 | "description": "A 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. |
| 503 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 504 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 505 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 506 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 507 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 508 | "participantId": "A String", # The ID of the participant that modified the match. |
| 509 | }, |
| 510 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 511 | "matchNumber": 42, # 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. |
| 512 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 513 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 514 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 515 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 516 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 517 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 518 | "displayName": "A String", # The name to display for the anonymous player. |
| 519 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 520 | }, |
| 521 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 522 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 523 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 524 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 525 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 526 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 527 | "displayName": "A String", # The name to display for the player. |
| 528 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 529 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 530 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 531 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 532 | "level": 42, # The level for the user. |
| 533 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 534 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 535 | }, |
| 536 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 537 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 538 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 539 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 540 | "level": 42, # The level for the user. |
| 541 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 542 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 543 | }, |
| 544 | }, |
| 545 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 546 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 547 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 548 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 549 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 550 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 551 | }, |
| 552 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 553 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 554 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 555 | }, |
| 556 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 557 | "playerId": "A String", # The ID of the player. |
| 558 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 559 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 560 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 561 | "profileVisible": True or False, |
| 562 | }, |
| 563 | "title": "A String", # The player's title rewarded for their game activities. |
| 564 | }, |
| 565 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 566 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 567 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 568 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 569 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 570 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 571 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 572 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 573 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 574 | }, |
| 575 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 576 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 577 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 578 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 579 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 580 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 581 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 582 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 583 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 584 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 585 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 586 | "participantId": "A String", # The ID of the participant. |
| 587 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 588 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 589 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 590 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 591 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 592 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 593 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 594 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 595 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 596 | }, |
| 597 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 598 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 599 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 600 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 601 | # - "MATCH_ACTIVE" - The match has started. |
| 602 | # - "MATCH_COMPLETE" - The match has finished. |
| 603 | # - "MATCH_CANCELED" - The match was canceled. |
| 604 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 605 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 606 | "userMatchStatus": "A 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. |
| 607 | # Possible values are: |
| 608 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 609 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 610 | # - "USER_TURN" - The user has an action to take in the match. |
| 611 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 612 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 613 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 614 | }</pre> |
| 615 | </div> |
| 616 | |
| 617 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 618 | <code class="details" id="get">get(matchId, includeMatchData=None, language=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 619 | <pre>Get the data for a turn-based match. |
| 620 | |
| 621 | Args: |
| 622 | matchId: string, The ID of the match. (required) |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 623 | includeMatchData: boolean, Get match data along with metadata. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 624 | language: string, The preferred language to use for strings returned by this method. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 625 | |
| 626 | Returns: |
| 627 | An object of the form: |
| 628 | |
| 629 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 630 | "applicationId": "A String", # The ID of the application being played. |
| 631 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 632 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 633 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 634 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 635 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 636 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 637 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 638 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 639 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 640 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 641 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 642 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 643 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 644 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 645 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 646 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 647 | "description": "A 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. |
| 648 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 649 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 650 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 651 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 652 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 653 | "participantId": "A String", # The ID of the participant that modified the match. |
| 654 | }, |
| 655 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 656 | "matchNumber": 42, # 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. |
| 657 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 658 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 659 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 660 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 661 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 662 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 663 | "displayName": "A String", # The name to display for the anonymous player. |
| 664 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 665 | }, |
| 666 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 667 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 668 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 669 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 670 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 671 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 672 | "displayName": "A String", # The name to display for the player. |
| 673 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 674 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 675 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 676 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 677 | "level": 42, # The level for the user. |
| 678 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 679 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 680 | }, |
| 681 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 682 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 683 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 684 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 685 | "level": 42, # The level for the user. |
| 686 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 687 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 688 | }, |
| 689 | }, |
| 690 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 691 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 692 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 693 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 694 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 695 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 696 | }, |
| 697 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 698 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 699 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 700 | }, |
| 701 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 702 | "playerId": "A String", # The ID of the player. |
| 703 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 704 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 705 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 706 | "profileVisible": True or False, |
| 707 | }, |
| 708 | "title": "A String", # The player's title rewarded for their game activities. |
| 709 | }, |
| 710 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 711 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 712 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 713 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 714 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 715 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 716 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 717 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 718 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 719 | }, |
| 720 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 721 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 722 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 723 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 724 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 725 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 726 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 727 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 728 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 729 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 730 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 731 | "participantId": "A String", # The ID of the participant. |
| 732 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 733 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 734 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 735 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 736 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 737 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 738 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 739 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 740 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 741 | }, |
| 742 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 743 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 744 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 745 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 746 | # - "MATCH_ACTIVE" - The match has started. |
| 747 | # - "MATCH_COMPLETE" - The match has finished. |
| 748 | # - "MATCH_CANCELED" - The match was canceled. |
| 749 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 750 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 751 | "userMatchStatus": "A 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. |
| 752 | # Possible values are: |
| 753 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 754 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 755 | # - "USER_TURN" - The user has an action to take in the match. |
| 756 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 757 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 758 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 759 | }</pre> |
| 760 | </div> |
| 761 | |
| 762 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 763 | <code class="details" id="join">join(matchId, language=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 764 | <pre>Join a turn-based match. |
| 765 | |
| 766 | Args: |
| 767 | matchId: string, The ID of the match. (required) |
| 768 | language: string, The preferred language to use for strings returned by this method. |
| 769 | |
| 770 | Returns: |
| 771 | An object of the form: |
| 772 | |
| 773 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 774 | "applicationId": "A String", # The ID of the application being played. |
| 775 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 776 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 777 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 778 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 779 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 780 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 781 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 782 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 783 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 784 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 785 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 786 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 787 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 788 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 789 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 790 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 791 | "description": "A 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. |
| 792 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 793 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 794 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 795 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 796 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 797 | "participantId": "A String", # The ID of the participant that modified the match. |
| 798 | }, |
| 799 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 800 | "matchNumber": 42, # 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. |
| 801 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 802 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 803 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 804 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 805 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 806 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 807 | "displayName": "A String", # The name to display for the anonymous player. |
| 808 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 809 | }, |
| 810 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 811 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 812 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 813 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 814 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 815 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 816 | "displayName": "A String", # The name to display for the player. |
| 817 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 818 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 819 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 820 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 821 | "level": 42, # The level for the user. |
| 822 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 823 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 824 | }, |
| 825 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 826 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 827 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 828 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 829 | "level": 42, # The level for the user. |
| 830 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 831 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 832 | }, |
| 833 | }, |
| 834 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 835 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 836 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 837 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 838 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 839 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 840 | }, |
| 841 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 842 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 843 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 844 | }, |
| 845 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 846 | "playerId": "A String", # The ID of the player. |
| 847 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 848 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 849 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 850 | "profileVisible": True or False, |
| 851 | }, |
| 852 | "title": "A String", # The player's title rewarded for their game activities. |
| 853 | }, |
| 854 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 855 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 856 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 857 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 858 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 859 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 860 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 861 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 862 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 863 | }, |
| 864 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 865 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 866 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 867 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 868 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 869 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 870 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 871 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 872 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 873 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 874 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 875 | "participantId": "A String", # The ID of the participant. |
| 876 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 877 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 878 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 879 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 880 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 881 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 882 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 883 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 884 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 885 | }, |
| 886 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 887 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 888 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 889 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 890 | # - "MATCH_ACTIVE" - The match has started. |
| 891 | # - "MATCH_COMPLETE" - The match has finished. |
| 892 | # - "MATCH_CANCELED" - The match was canceled. |
| 893 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 894 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 895 | "userMatchStatus": "A 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. |
| 896 | # Possible values are: |
| 897 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 898 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 899 | # - "USER_TURN" - The user has an action to take in the match. |
| 900 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 901 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 902 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 903 | }</pre> |
| 904 | </div> |
| 905 | |
| 906 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 907 | <code class="details" id="leave">leave(matchId, language=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 908 | <pre>Leave a turn-based match when it is not the current player's turn, without canceling the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 909 | |
| 910 | Args: |
| 911 | matchId: string, The ID of the match. (required) |
| 912 | language: string, The preferred language to use for strings returned by this method. |
| 913 | |
| 914 | Returns: |
| 915 | An object of the form: |
| 916 | |
| 917 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 918 | "applicationId": "A String", # The ID of the application being played. |
| 919 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 920 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 921 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 922 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 923 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 924 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 925 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 926 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 927 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 928 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 929 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 930 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 931 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 932 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 933 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 934 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 935 | "description": "A 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. |
| 936 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 937 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 938 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 939 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 940 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 941 | "participantId": "A String", # The ID of the participant that modified the match. |
| 942 | }, |
| 943 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 944 | "matchNumber": 42, # 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. |
| 945 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 946 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 947 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 948 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 949 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 950 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 951 | "displayName": "A String", # The name to display for the anonymous player. |
| 952 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 953 | }, |
| 954 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 955 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 956 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 957 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 958 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 959 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 960 | "displayName": "A String", # The name to display for the player. |
| 961 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 962 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 963 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 964 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 965 | "level": 42, # The level for the user. |
| 966 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 967 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 968 | }, |
| 969 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 970 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 971 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 972 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 973 | "level": 42, # The level for the user. |
| 974 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 975 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 976 | }, |
| 977 | }, |
| 978 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 979 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 980 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 981 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 982 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 983 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 984 | }, |
| 985 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 986 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 987 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 988 | }, |
| 989 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 990 | "playerId": "A String", # The ID of the player. |
| 991 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 992 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 993 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 994 | "profileVisible": True or False, |
| 995 | }, |
| 996 | "title": "A String", # The player's title rewarded for their game activities. |
| 997 | }, |
| 998 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 999 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1000 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 1001 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 1002 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 1003 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 1004 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 1005 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 1006 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1007 | }, |
| 1008 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1009 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 1010 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 1011 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1012 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1013 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1014 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1015 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 1016 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1017 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1018 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 1019 | "participantId": "A String", # The ID of the participant. |
| 1020 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 1021 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1022 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1023 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 1024 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 1025 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 1026 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 1027 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 1028 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1029 | }, |
| 1030 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1031 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1032 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1033 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 1034 | # - "MATCH_ACTIVE" - The match has started. |
| 1035 | # - "MATCH_COMPLETE" - The match has finished. |
| 1036 | # - "MATCH_CANCELED" - The match was canceled. |
| 1037 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 1038 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 1039 | "userMatchStatus": "A 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. |
| 1040 | # Possible values are: |
| 1041 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 1042 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 1043 | # - "USER_TURN" - The user has an action to take in the match. |
| 1044 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 1045 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 1046 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1047 | }</pre> |
| 1048 | </div> |
| 1049 | |
| 1050 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1051 | <code class="details" id="leaveTurn">leaveTurn(matchId, matchVersion, language=None, pendingParticipantId=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1052 | <pre>Leave a turn-based match during the current player's turn, without canceling the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1053 | |
| 1054 | Args: |
| 1055 | matchId: string, The ID of the match. (required) |
| 1056 | matchVersion: integer, The version of the match being updated. (required) |
| 1057 | language: string, The preferred language to use for strings returned by this method. |
| 1058 | pendingParticipantId: string, The ID of another participant who should take their turn next. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players. |
| 1059 | |
| 1060 | Returns: |
| 1061 | An object of the form: |
| 1062 | |
| 1063 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1064 | "applicationId": "A String", # The ID of the application being played. |
| 1065 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 1066 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 1067 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 1068 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 1069 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1070 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1071 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 1072 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1073 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1074 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1075 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1076 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 1077 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1078 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1079 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1080 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1081 | "description": "A 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. |
| 1082 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 1083 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 1084 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 1085 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1086 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1087 | "participantId": "A String", # The ID of the participant that modified the match. |
| 1088 | }, |
| 1089 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 1090 | "matchNumber": 42, # 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. |
| 1091 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 1092 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1093 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1094 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 1095 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1096 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 1097 | "displayName": "A String", # The name to display for the anonymous player. |
| 1098 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 1099 | }, |
| 1100 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 1101 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 1102 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1103 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 1104 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 1105 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 1106 | "displayName": "A String", # The name to display for the player. |
| 1107 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 1108 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 1109 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 1110 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1111 | "level": 42, # The level for the user. |
| 1112 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1113 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1114 | }, |
| 1115 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 1116 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 1117 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 1118 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1119 | "level": 42, # The level for the user. |
| 1120 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1121 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1122 | }, |
| 1123 | }, |
| 1124 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 1125 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 1126 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 1127 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 1128 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 1129 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 1130 | }, |
| 1131 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 1132 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 1133 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 1134 | }, |
| 1135 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 1136 | "playerId": "A String", # The ID of the player. |
| 1137 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 1138 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 1139 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 1140 | "profileVisible": True or False, |
| 1141 | }, |
| 1142 | "title": "A String", # The player's title rewarded for their game activities. |
| 1143 | }, |
| 1144 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1145 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1146 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 1147 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 1148 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 1149 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 1150 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 1151 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 1152 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1153 | }, |
| 1154 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1155 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 1156 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 1157 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1158 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1159 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1160 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1161 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 1162 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1163 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1164 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 1165 | "participantId": "A String", # The ID of the participant. |
| 1166 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 1167 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1168 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1169 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 1170 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 1171 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 1172 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 1173 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 1174 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1175 | }, |
| 1176 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1177 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1178 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1179 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 1180 | # - "MATCH_ACTIVE" - The match has started. |
| 1181 | # - "MATCH_COMPLETE" - The match has finished. |
| 1182 | # - "MATCH_CANCELED" - The match was canceled. |
| 1183 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 1184 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 1185 | "userMatchStatus": "A 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. |
| 1186 | # Possible values are: |
| 1187 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 1188 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 1189 | # - "USER_TURN" - The user has an action to take in the match. |
| 1190 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 1191 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 1192 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1193 | }</pre> |
| 1194 | </div> |
| 1195 | |
| 1196 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1197 | <code class="details" id="list">list(includeMatchData=None, language=None, maxCompletedMatches=None, maxResults=None, pageToken=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1198 | <pre>Returns turn-based matches the player is or was involved in. |
| 1199 | |
| 1200 | Args: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1201 | includeMatchData: boolean, True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1202 | language: string, The preferred language to use for strings returned by this method. |
| 1203 | maxCompletedMatches: integer, The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled. |
| 1204 | maxResults: integer, The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults. |
| 1205 | pageToken: string, The token returned by the previous request. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1206 | |
| 1207 | Returns: |
| 1208 | An object of the form: |
| 1209 | |
| 1210 | { # This is a JSON template for a list of turn-based matches. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1211 | "items": [ # The matches. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1212 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1213 | "applicationId": "A String", # The ID of the application being played. |
| 1214 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 1215 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 1216 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 1217 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 1218 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1219 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1220 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 1221 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1222 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1223 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1224 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1225 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 1226 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1227 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1228 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1229 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1230 | "description": "A 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. |
| 1231 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 1232 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 1233 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 1234 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1235 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1236 | "participantId": "A String", # The ID of the participant that modified the match. |
| 1237 | }, |
| 1238 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 1239 | "matchNumber": 42, # 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. |
| 1240 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 1241 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1242 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1243 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 1244 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1245 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 1246 | "displayName": "A String", # The name to display for the anonymous player. |
| 1247 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 1248 | }, |
| 1249 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 1250 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 1251 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1252 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 1253 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 1254 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 1255 | "displayName": "A String", # The name to display for the player. |
| 1256 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 1257 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 1258 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 1259 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1260 | "level": 42, # The level for the user. |
| 1261 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1262 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1263 | }, |
| 1264 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 1265 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 1266 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 1267 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1268 | "level": 42, # The level for the user. |
| 1269 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1270 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1271 | }, |
| 1272 | }, |
| 1273 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 1274 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 1275 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 1276 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 1277 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 1278 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 1279 | }, |
| 1280 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 1281 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 1282 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 1283 | }, |
| 1284 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 1285 | "playerId": "A String", # The ID of the player. |
| 1286 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 1287 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 1288 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 1289 | "profileVisible": True or False, |
| 1290 | }, |
| 1291 | "title": "A String", # The player's title rewarded for their game activities. |
| 1292 | }, |
| 1293 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1294 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1295 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 1296 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 1297 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 1298 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 1299 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 1300 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 1301 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1302 | }, |
| 1303 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1304 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 1305 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 1306 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1307 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1308 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1309 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1310 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 1311 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1312 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1313 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 1314 | "participantId": "A String", # The ID of the participant. |
| 1315 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 1316 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1317 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1318 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 1319 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 1320 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 1321 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 1322 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 1323 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1324 | }, |
| 1325 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1326 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1327 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1328 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 1329 | # - "MATCH_ACTIVE" - The match has started. |
| 1330 | # - "MATCH_COMPLETE" - The match has finished. |
| 1331 | # - "MATCH_CANCELED" - The match was canceled. |
| 1332 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 1333 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 1334 | "userMatchStatus": "A 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. |
| 1335 | # Possible values are: |
| 1336 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 1337 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 1338 | # - "USER_TURN" - The user has an action to take in the match. |
| 1339 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 1340 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 1341 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1342 | }, |
| 1343 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1344 | "kind": "games#turnBasedMatchList", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchList. |
| 1345 | "nextPageToken": "A String", # The pagination token for the next page of results. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1346 | }</pre> |
| 1347 | </div> |
| 1348 | |
| 1349 | <div class="method"> |
| 1350 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1351 | <pre>Retrieves the next page of results. |
| 1352 | |
| 1353 | Args: |
| 1354 | previous_request: The request for the previous page. (required) |
| 1355 | previous_response: The response from the request for the previous page. (required) |
| 1356 | |
| 1357 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1358 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1359 | page. Returns None if there are no more items in the collection. |
| 1360 | </pre> |
| 1361 | </div> |
| 1362 | |
| 1363 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1364 | <code class="details" id="rematch">rematch(matchId, language=None, requestId=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1365 | <pre>Create a rematch of a match that was previously completed, with the same participants. This can be called by only one player on a match still in their list; the player must have called Finish first. Returns the newly created match; it will be the caller's turn. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1366 | |
| 1367 | Args: |
| 1368 | matchId: string, The ID of the match. (required) |
| 1369 | language: string, The preferred language to use for strings returned by this method. |
| 1370 | requestId: string, A randomly generated numeric ID for each request specified by the caller. This number is used at the server to ensure that the request is handled correctly across retries. |
| 1371 | |
| 1372 | Returns: |
| 1373 | An object of the form: |
| 1374 | |
| 1375 | { # This is a JSON template for a rematch response. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1376 | "kind": "games#turnBasedMatchRematch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchRematch. |
| 1377 | "previousMatch": { # This is a JSON template for a turn-based match resource object. # The old match that the rematch was created from; will be updated such that the rematchId field will point at the new match. |
| 1378 | "applicationId": "A String", # The ID of the application being played. |
| 1379 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 1380 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 1381 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 1382 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 1383 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1384 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1385 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 1386 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1387 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1388 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1389 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1390 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 1391 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1392 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1393 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1394 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1395 | "description": "A 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. |
| 1396 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 1397 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 1398 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 1399 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1400 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1401 | "participantId": "A String", # The ID of the participant that modified the match. |
| 1402 | }, |
| 1403 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 1404 | "matchNumber": 42, # 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. |
| 1405 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 1406 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1407 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1408 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 1409 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1410 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 1411 | "displayName": "A String", # The name to display for the anonymous player. |
| 1412 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 1413 | }, |
| 1414 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 1415 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 1416 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1417 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 1418 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 1419 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 1420 | "displayName": "A String", # The name to display for the player. |
| 1421 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 1422 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 1423 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 1424 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1425 | "level": 42, # The level for the user. |
| 1426 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1427 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1428 | }, |
| 1429 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 1430 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 1431 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 1432 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1433 | "level": 42, # The level for the user. |
| 1434 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1435 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1436 | }, |
| 1437 | }, |
| 1438 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 1439 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 1440 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 1441 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 1442 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 1443 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 1444 | }, |
| 1445 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 1446 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 1447 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 1448 | }, |
| 1449 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 1450 | "playerId": "A String", # The ID of the player. |
| 1451 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 1452 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 1453 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 1454 | "profileVisible": True or False, |
| 1455 | }, |
| 1456 | "title": "A String", # The player's title rewarded for their game activities. |
| 1457 | }, |
| 1458 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1459 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1460 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 1461 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 1462 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 1463 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 1464 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 1465 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 1466 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1467 | }, |
| 1468 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1469 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 1470 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 1471 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1472 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1473 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1474 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1475 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 1476 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1477 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1478 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 1479 | "participantId": "A String", # The ID of the participant. |
| 1480 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 1481 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1482 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1483 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 1484 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 1485 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 1486 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 1487 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 1488 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1489 | }, |
| 1490 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1491 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1492 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1493 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 1494 | # - "MATCH_ACTIVE" - The match has started. |
| 1495 | # - "MATCH_COMPLETE" - The match has finished. |
| 1496 | # - "MATCH_CANCELED" - The match was canceled. |
| 1497 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 1498 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 1499 | "userMatchStatus": "A 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. |
| 1500 | # Possible values are: |
| 1501 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 1502 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 1503 | # - "USER_TURN" - The user has an action to take in the match. |
| 1504 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 1505 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 1506 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1507 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1508 | "rematch": { # This is a JSON template for a turn-based match resource object. # The newly created match; a rematch of the old match with the same participants. |
| 1509 | "applicationId": "A String", # The ID of the application being played. |
| 1510 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 1511 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 1512 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 1513 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 1514 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1515 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1516 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 1517 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1518 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1519 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1520 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1521 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 1522 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1523 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1524 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1525 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1526 | "description": "A 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. |
| 1527 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 1528 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 1529 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 1530 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1531 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1532 | "participantId": "A String", # The ID of the participant that modified the match. |
| 1533 | }, |
| 1534 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 1535 | "matchNumber": 42, # 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. |
| 1536 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 1537 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1538 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1539 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 1540 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1541 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 1542 | "displayName": "A String", # The name to display for the anonymous player. |
| 1543 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 1544 | }, |
| 1545 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 1546 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 1547 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1548 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 1549 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 1550 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 1551 | "displayName": "A String", # The name to display for the player. |
| 1552 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 1553 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 1554 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 1555 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1556 | "level": 42, # The level for the user. |
| 1557 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1558 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1559 | }, |
| 1560 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 1561 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 1562 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 1563 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1564 | "level": 42, # The level for the user. |
| 1565 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1566 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1567 | }, |
| 1568 | }, |
| 1569 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 1570 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 1571 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 1572 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 1573 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 1574 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 1575 | }, |
| 1576 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 1577 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 1578 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 1579 | }, |
| 1580 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 1581 | "playerId": "A String", # The ID of the player. |
| 1582 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 1583 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 1584 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 1585 | "profileVisible": True or False, |
| 1586 | }, |
| 1587 | "title": "A String", # The player's title rewarded for their game activities. |
| 1588 | }, |
| 1589 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1590 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1591 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 1592 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 1593 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 1594 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 1595 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 1596 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 1597 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1598 | }, |
| 1599 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1600 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 1601 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 1602 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1603 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1604 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1605 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1606 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 1607 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1608 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1609 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 1610 | "participantId": "A String", # The ID of the participant. |
| 1611 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 1612 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1613 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1614 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 1615 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 1616 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 1617 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 1618 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 1619 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1620 | }, |
| 1621 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1622 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1623 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1624 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 1625 | # - "MATCH_ACTIVE" - The match has started. |
| 1626 | # - "MATCH_COMPLETE" - The match has finished. |
| 1627 | # - "MATCH_CANCELED" - The match was canceled. |
| 1628 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 1629 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 1630 | "userMatchStatus": "A 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. |
| 1631 | # Possible values are: |
| 1632 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 1633 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 1634 | # - "USER_TURN" - The user has an action to take in the match. |
| 1635 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 1636 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 1637 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1638 | }, |
| 1639 | }</pre> |
| 1640 | </div> |
| 1641 | |
| 1642 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1643 | <code class="details" id="sync">sync(includeMatchData=None, language=None, maxCompletedMatches=None, maxResults=None, pageToken=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1644 | <pre>Returns turn-based matches the player is or was involved in that changed since the last sync call, with the least recent changes coming first. Matches that should be removed from the local cache will have a status of MATCH_DELETED. |
| 1645 | |
| 1646 | Args: |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1647 | includeMatchData: boolean, True if match data should be returned in the response. Note that not all data will necessarily be returned if include_match_data is true; the server may decide to only return data for some of the matches to limit download size for the client. The remainder of the data for these matches will be retrievable on request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1648 | language: string, The preferred language to use for strings returned by this method. |
| 1649 | maxCompletedMatches: integer, The maximum number of completed or canceled matches to return in the response. If not set, all matches returned could be completed or canceled. |
| 1650 | maxResults: integer, The maximum number of matches to return in the response, used for paging. For any response, the actual number of matches to return may be less than the specified maxResults. |
| 1651 | pageToken: string, The token returned by the previous request. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1652 | |
| 1653 | Returns: |
| 1654 | An object of the form: |
| 1655 | |
| 1656 | { # This is a JSON template for a list of turn-based matches returned from a sync. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1657 | "items": [ # The matches. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1658 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1659 | "applicationId": "A String", # The ID of the application being played. |
| 1660 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 1661 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 1662 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 1663 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 1664 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1665 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1666 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 1667 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1668 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1669 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1670 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1671 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 1672 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1673 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1674 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1675 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1676 | "description": "A 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. |
| 1677 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 1678 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 1679 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 1680 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1681 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1682 | "participantId": "A String", # The ID of the participant that modified the match. |
| 1683 | }, |
| 1684 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 1685 | "matchNumber": 42, # 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. |
| 1686 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 1687 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1688 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1689 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 1690 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1691 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 1692 | "displayName": "A String", # The name to display for the anonymous player. |
| 1693 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 1694 | }, |
| 1695 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 1696 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 1697 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1698 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 1699 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 1700 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 1701 | "displayName": "A String", # The name to display for the player. |
| 1702 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 1703 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 1704 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 1705 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1706 | "level": 42, # The level for the user. |
| 1707 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1708 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1709 | }, |
| 1710 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 1711 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 1712 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 1713 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1714 | "level": 42, # The level for the user. |
| 1715 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1716 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1717 | }, |
| 1718 | }, |
| 1719 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 1720 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 1721 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 1722 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 1723 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 1724 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 1725 | }, |
| 1726 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 1727 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 1728 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 1729 | }, |
| 1730 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 1731 | "playerId": "A String", # The ID of the player. |
| 1732 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 1733 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 1734 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 1735 | "profileVisible": True or False, |
| 1736 | }, |
| 1737 | "title": "A String", # The player's title rewarded for their game activities. |
| 1738 | }, |
| 1739 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1740 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1741 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 1742 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 1743 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 1744 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 1745 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 1746 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 1747 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1748 | }, |
| 1749 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1750 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 1751 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 1752 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1753 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1754 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1755 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1756 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 1757 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1758 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1759 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 1760 | "participantId": "A String", # The ID of the participant. |
| 1761 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 1762 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1763 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1764 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 1765 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 1766 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 1767 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 1768 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 1769 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1770 | }, |
| 1771 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1772 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1773 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1774 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 1775 | # - "MATCH_ACTIVE" - The match has started. |
| 1776 | # - "MATCH_COMPLETE" - The match has finished. |
| 1777 | # - "MATCH_CANCELED" - The match was canceled. |
| 1778 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 1779 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 1780 | "userMatchStatus": "A 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. |
| 1781 | # Possible values are: |
| 1782 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 1783 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 1784 | # - "USER_TURN" - The user has an action to take in the match. |
| 1785 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 1786 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 1787 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1788 | }, |
| 1789 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1790 | "kind": "games#turnBasedMatchSync", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchSync. |
| 1791 | "moreAvailable": True or False, # True if there were more matches available to fetch at the time the response was generated (which were not returned due to page size limits.) |
| 1792 | "nextPageToken": "A String", # The pagination token for the next page of results. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1793 | }</pre> |
| 1794 | </div> |
| 1795 | |
| 1796 | <div class="method"> |
| 1797 | <code class="details" id="sync_next">sync_next(previous_request, previous_response)</code> |
| 1798 | <pre>Retrieves the next page of results. |
| 1799 | |
| 1800 | Args: |
| 1801 | previous_request: The request for the previous page. (required) |
| 1802 | previous_response: The response from the request for the previous page. (required) |
| 1803 | |
| 1804 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1805 | A request object that you can call 'execute()' on to request the next |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1806 | page. Returns None if there are no more items in the collection. |
| 1807 | </pre> |
| 1808 | </div> |
| 1809 | |
| 1810 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1811 | <code class="details" id="takeTurn">takeTurn(matchId, body=None, language=None)</code> |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1812 | <pre>Commit the results of a player turn. |
| 1813 | |
| 1814 | Args: |
| 1815 | matchId: string, The ID of the match. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1816 | body: object, The request body. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1817 | The object takes the form of: |
| 1818 | |
| 1819 | { # This is a JSON template for the object representing a turn. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1820 | "data": { # This is a JSON template for sending a turn-based match data object. # The shared game state data after the turn is over. |
| 1821 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1822 | "kind": "games#turnBasedMatchDataRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchDataRequest. |
| 1823 | }, |
| 1824 | "kind": "games#turnBasedMatchTurn", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchTurn. |
| 1825 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 1826 | "pendingParticipantId": "A String", # The ID of the participant who should take their turn next. May be set to the current player's participant ID to update match state without changing the turn. If not set, the match will wait for other player(s) to join via automatching; this is only valid if automatch criteria is set on the match with remaining slots for automatched players. |
| 1827 | "results": [ # The match results for the participants in the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1828 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1829 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 1830 | "participantId": "A String", # The ID of the participant. |
| 1831 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 1832 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1833 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1834 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 1835 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 1836 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 1837 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 1838 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 1839 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1840 | }, |
| 1841 | ], |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1842 | } |
| 1843 | |
| 1844 | language: string, The preferred language to use for strings returned by this method. |
| 1845 | |
| 1846 | Returns: |
| 1847 | An object of the form: |
| 1848 | |
| 1849 | { # This is a JSON template for a turn-based match resource object. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1850 | "applicationId": "A String", # The ID of the application being played. |
| 1851 | "autoMatchingCriteria": { # This is a JSON template for an turn-based auto-match criteria object. # Criteria for auto-matching players into this match. |
| 1852 | "exclusiveBitmask": "A String", # A bitmask indicating when auto-matches are valid. When ANDed with other exclusive bitmasks, the result must be zero. Can be used to support exclusive roles within a game. |
| 1853 | "kind": "games#turnBasedAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedAutoMatchingCriteria. |
| 1854 | "maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the match by auto-matching. |
| 1855 | "minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the match by auto-matching. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1856 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1857 | "creationDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the match creation. |
| 1858 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1859 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1860 | "participantId": "A String", # The ID of the participant that modified the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1861 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1862 | "data": { # This is a JSON template for a turn-based match data object. # The data / game state for this match. |
| 1863 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1864 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1865 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1866 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1867 | "description": "A 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. |
| 1868 | "inviterId": "A String", # The ID of the participant that invited the user to the match. Not set if the user was not invited to the match. |
| 1869 | "kind": "games#turnBasedMatch", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatch. |
| 1870 | "lastUpdateDetails": { # This is a JSON template for turn-based match modification metadata. # Details about the last update to the match. |
| 1871 | "kind": "games#turnBasedMatchModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchModification. |
| 1872 | "modifiedTimestampMillis": "A String", # The timestamp at which they modified the match, in milliseconds since the epoch in UTC. |
| 1873 | "participantId": "A String", # The ID of the participant that modified the match. |
| 1874 | }, |
| 1875 | "matchId": "A String", # Globally unique ID for a turn-based match. |
| 1876 | "matchNumber": 42, # 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. |
| 1877 | "matchVersion": 42, # The version of this match: an increasing counter, used to avoid out-of-date updates to the match. |
| 1878 | "participants": [ # The participants involved in the match, along with their statuses. Includes participants who have left or declined invitations. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1879 | { # This is a JSON template for a participant in a turn-based match. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1880 | "autoMatched": True or False, # True if this participant was auto-matched with the requesting player. |
| 1881 | "autoMatchedPlayer": { # This is a JSON template for an anonymous player # Information about a player that has been anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1882 | "avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player. |
| 1883 | "displayName": "A String", # The name to display for the anonymous player. |
| 1884 | "kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer. |
| 1885 | }, |
| 1886 | "id": "A String", # An identifier for the participant in the scope of the match. Cannot be used to identify a player across matches or in other contexts. |
| 1887 | "kind": "games#turnBasedMatchParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchParticipant. |
| 1888 | "player": { # This is a JSON template for a Player resource. # Information about the player. Not populated if this player was anonymously auto-matched against the requesting player. (Either player or autoMatchedPlayer will be set.) |
| 1889 | "avatarImageUrl": "A String", # The base URL for the image that represents the player. |
| 1890 | "bannerUrlLandscape": "A String", # The url to the landscape mode player banner image. |
| 1891 | "bannerUrlPortrait": "A String", # The url to the portrait mode player banner image. |
| 1892 | "displayName": "A String", # The name to display for the player. |
| 1893 | "experienceInfo": { # This is a JSON template for 1P/3P metadata about the player's experience. # An object to represent Play Game experience information for the player. |
| 1894 | "currentExperiencePoints": "A String", # The current number of experience points for the player. |
| 1895 | "currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player. |
| 1896 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1897 | "level": 42, # The level for the user. |
| 1898 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1899 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1900 | }, |
| 1901 | "kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo. |
| 1902 | "lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC. |
| 1903 | "nextLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The next level of the player. If the current level is the maximum level, this should be same as the current level. |
| 1904 | "kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel. |
| 1905 | "level": 42, # The level for the user. |
| 1906 | "maxExperiencePoints": "A String", # The maximum experience points for this level. |
| 1907 | "minExperiencePoints": "A String", # The minimum experience points for this level. |
| 1908 | }, |
| 1909 | }, |
| 1910 | "friendStatus": "A String", # The friend status of the given player, relative to the requester. This is unset if the player is not sharing their friends list with the game. |
| 1911 | "kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player. |
| 1912 | "lastPlayedWith": { # This is a JSON template for metadata about a player playing a game with the currently authenticated user. # Details about the last time this player played a multiplayer game with the currently authenticated player. Populated for PLAYED_WITH player collection members. |
| 1913 | "autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user. |
| 1914 | "kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played. |
| 1915 | "timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC. |
| 1916 | }, |
| 1917 | "name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present. |
| 1918 | "familyName": "A String", # The family name of this player. In some places, this is known as the last name. |
| 1919 | "givenName": "A String", # The given name of this player. In some places, this is known as the first name. |
| 1920 | }, |
| 1921 | "originalPlayerId": "A String", # The player ID that was used for this player the first time they signed into the game in question. This is only populated for calls to player.get for the requesting player, only if the player ID has subsequently changed, and only to clients that support remapping player IDs. |
| 1922 | "playerId": "A String", # The ID of the player. |
| 1923 | "profileSettings": { # This is a JSON template for profile settings # The player's profile settings. Controls whether or not the player's profile is visible to other players. |
| 1924 | "friendsListVisibility": "A String", # Whether the player's friends list is visible to the game. |
| 1925 | "kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings. |
| 1926 | "profileVisible": True or False, |
| 1927 | }, |
| 1928 | "title": "A String", # The player's title rewarded for their game activities. |
| 1929 | }, |
| 1930 | "status": "A String", # The status of the participant with respect to the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1931 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1932 | # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to the match, but the invitation has not been sent; the invite will be sent when it becomes their turn. |
| 1933 | # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, but has not yet responded. |
| 1934 | # - "PARTICIPANT_JOINED" - The participant has joined the match (either after creating it or accepting an invitation.) |
| 1935 | # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the match. |
| 1936 | # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. |
| 1937 | # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. |
| 1938 | # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the allotted time. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1939 | }, |
| 1940 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1941 | "pendingParticipantId": "A String", # The ID of the participant that is taking a turn. |
| 1942 | "previousMatchData": { # This is a JSON template for a turn-based match data object. # The data / game state for the previous match; set for the first turn of rematches only. |
| 1943 | "data": "A String", # The byte representation of the data (limited to 128 kB), as a Base64-encoded string with the URL_SAFE encoding option. |
| 1944 | "dataAvailable": True or False, # True if this match has data available but it wasn't returned in a list response; fetching the match individually will retrieve this data. |
| 1945 | "kind": "games#turnBasedMatchData", # Uniquely identifies the type of this resource. Value is always the fixed string games#turnBasedMatchData. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1946 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1947 | "rematchId": "A String", # The ID of a rematch of this match. Only set for completed matches that have been rematched. |
| 1948 | "results": [ # The results reported for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1949 | { # This is a JSON template for a result for a match participant. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1950 | "kind": "games#participantResult", # Uniquely identifies the type of this resource. Value is always the fixed string games#participantResult. |
| 1951 | "participantId": "A String", # The ID of the participant. |
| 1952 | "placing": 42, # The placement or ranking of the participant in the match results; a number from one to the number of participants in the match. Multiple participants may have the same placing value in case of a type. |
| 1953 | "result": "A String", # The result of the participant for this match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1954 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1955 | # - "MATCH_RESULT_WIN" - The participant won the match. |
| 1956 | # - "MATCH_RESULT_LOSS" - The participant lost the match. |
| 1957 | # - "MATCH_RESULT_TIE" - The participant tied the match. |
| 1958 | # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or loses this kind of game.) |
| 1959 | # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the match. |
| 1960 | # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for this participant. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1961 | }, |
| 1962 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1963 | "status": "A String", # The status of the match. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1964 | # Possible values are: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1965 | # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; the match cannot be established until they are filled. |
| 1966 | # - "MATCH_ACTIVE" - The match has started. |
| 1967 | # - "MATCH_COMPLETE" - The match has finished. |
| 1968 | # - "MATCH_CANCELED" - The match was canceled. |
| 1969 | # - "MATCH_EXPIRED" - The match expired due to inactivity. |
| 1970 | # - "MATCH_DELETED" - The match should no longer be shown on the client. Returned only for tombstones for matches when sync is called. |
| 1971 | "userMatchStatus": "A 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. |
| 1972 | # Possible values are: |
| 1973 | # - "USER_INVITED" - The user has been invited to join the match and has not responded yet. |
| 1974 | # - "USER_AWAITING_TURN" - The user is waiting for their turn. |
| 1975 | # - "USER_TURN" - The user has an action to take in the match. |
| 1976 | # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or expired.) |
| 1977 | "variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank. |
| 1978 | "withParticipantId": "A String", # The ID of another participant in the match that can be used when describing the participants the user is playing with. |
| John Asmuth | 614db98 | 2014-04-24 15:46:26 -0400 | [diff] [blame] | 1979 | }</pre> |
| 1980 | </div> |
| 1981 | |
| 1982 | </body></html> |