Blame - docs/dyn/games_v1.rooms.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

106

<code class="details" id="create">create(body=None, language=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

107

<pre>Create a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

108

109

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

110

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

111

The object takes the form of:

112

113

{ # This is a JSON template for a room creation request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

114

"autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.

115

"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.

116

"kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.

117

"maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.

118

"minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

119

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

120

"capabilities": [ # The capabilities that this client supports for realtime communication.

121

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

122

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

123

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the player creating the room.

124

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

125

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

126

},

127

"invitedPlayerIds": [ # The player IDs to invite to the room.

128

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

129

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

130

"kind": "games#roomCreateRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomCreateRequest.

131

"networkDiagnostics": { # This is a JSON template for network diagnostics reported for a client. # Network diagnostics for the client creating the room.

132

"androidNetworkSubtype": 42, # The Android network subtype.

133

"androidNetworkType": 42, # The Android network type.

134

"iosNetworkType": 42, # iOS network type as defined in Reachability.h.

135

"kind": "games#networkDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics.

136

"networkOperatorCode": "A String", # The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html

137

"networkOperatorName": "A String", # The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName

138

"registrationLatencyMillis": 42, # The amount of time in milliseconds it took for the client to establish a connection with the XMPP server.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

139

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

140

"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.

141

"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

2014-04-24 15:46:26 -0400

[diff] [blame]

142

}

143

144

language: string, The preferred language to use for strings returned by this method.

145

146

Returns:

147

An object of the form:

148

149

{ # This is a JSON template for a room resource object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

150

"applicationId": "A String", # The ID of the application being played.

151

"autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.

152

"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.

153

"kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.

154

"maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.

155

"minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

156

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

157

"autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue.

158

"kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.

159

"waitEstimateSeconds": 42, # An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

160

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

161

"creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.

162

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

163

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

164

"participantId": "A String", # The ID of the participant that modified the room.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

165

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

166

"description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)

167

"inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.

168

"kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.

169

"lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.

170

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

171

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

172

"participantId": "A String", # The ID of the participant that modified the room.

173

},

174

"participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

175

{ # This is a JSON template for a participant in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

176

"autoMatched": True or False, # True if this participant was auto-matched with the requesting player.

177

"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.)

178

"avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.

179

"displayName": "A String", # The name to display for the anonymous player.

180

"kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

181

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

182

"capabilities": [ # The capabilities which can be used when communicating with this participant.

183

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

184

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

185

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.

186

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

187

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

188

},

189

"connected": True or False, # True if this participant is in the fully connected set of peers in the room.

190

"id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.

191

"kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.

192

"leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.

193

# Possible values are:

194

# - "PLAYER_LEFT" - The player explicitly chose to leave the room.

195

# - "GAME_LEFT" - The game chose to remove the player from the room.

196

# - "ABANDONED" - The player switched to another application and abandoned the room.

197

# - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.

198

# - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.

199

# - "TIMEOUT" - The client timed out while waiting for players to join and connect.

200

# - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.

201

"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.)

202

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

203

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

204

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

205

"displayName": "A String", # The name to display for the player.

206

"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.

207

"currentExperiencePoints": "A String", # The current number of experience points for the player.

208

"currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.

209

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

210

"level": 42, # The level for the user.

211

"maxExperiencePoints": "A String", # The maximum experience points for this level.

212

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

213

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

214

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

215

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.

216

"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.

217

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

218

"level": 42, # The level for the user.

219

"maxExperiencePoints": "A String", # The maximum experience points for this level.

220

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

221

},

222

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

223

"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.

224

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

225

"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.

226

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

227

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

228

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

229

},

230

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

231

"familyName": "A String", # The family name of this player. In some places, this is known as the last name.

232

"givenName": "A String", # The given name of this player. In some places, this is known as the first name.

233

},

234

"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.

235

"playerId": "A String", # The ID of the player.

236

"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.

237

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

238

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

239

"profileVisible": True or False,

240

},

241

"title": "A String", # The player's title rewarded for their game activities.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

242

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

243

"status": "A String", # The status of the participant with respect to the room.

244

# Possible values are:

245

# - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.

246

# - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)

247

# - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.

248

# - "PARTICIPANT_LEFT" - The participant joined the room and then left it.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

249

},

250

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

251

"roomId": "A String", # Globally unique ID for a room.

252

"roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.

253

"status": "A String", # The status of the room.

254

# Possible values are:

255

# - "ROOM_INVITING" - One or more players have been invited and not responded.

256

# - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.

257

# - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).

258

# - "ROOM_ACTIVE" - All players have joined and connected to each other.

259

# - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

260

"variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

265

<code class="details" id="decline">decline(roomId, language=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

266

<pre>Decline an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

267

268

Args:

269

roomId: string, The ID of the room. (required)

270

language: string, The preferred language to use for strings returned by this method.

271

272

Returns:

273

An object of the form:

274

275

{ # This is a JSON template for a room resource object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

276

"applicationId": "A String", # The ID of the application being played.

277

"autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.

278

"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.

279

"kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.

280

"maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.

281

"minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

282

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

283

"autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue.

284

"kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.

285

"waitEstimateSeconds": 42, # An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

286

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

287

"creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.

288

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

289

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

290

"participantId": "A String", # The ID of the participant that modified the room.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

291

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

292

"description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)

293

"inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.

294

"kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.

295

"lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.

296

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

297

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

298

"participantId": "A String", # The ID of the participant that modified the room.

299

},

300

"participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

301

{ # This is a JSON template for a participant in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

302

"autoMatched": True or False, # True if this participant was auto-matched with the requesting player.

303

"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.)

304

"avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.

305

"displayName": "A String", # The name to display for the anonymous player.

306

"kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

307

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

"capabilities": [ # The capabilities which can be used when communicating with this participant.

309

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

310

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

311

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.

312

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

313

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

314

},

315

"connected": True or False, # True if this participant is in the fully connected set of peers in the room.

316

"id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.

317

"kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.

318

"leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.

319

# Possible values are:

320

# - "PLAYER_LEFT" - The player explicitly chose to leave the room.

321

# - "GAME_LEFT" - The game chose to remove the player from the room.

322

# - "ABANDONED" - The player switched to another application and abandoned the room.

323

# - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.

324

# - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.

325

# - "TIMEOUT" - The client timed out while waiting for players to join and connect.

326

# - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.

327

"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.)

328

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

329

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

330

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

331

"displayName": "A String", # The name to display for the player.

332

"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.

333

"currentExperiencePoints": "A String", # The current number of experience points for the player.

334

"currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.

335

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

336

"level": 42, # The level for the user.

337

"maxExperiencePoints": "A String", # The maximum experience points for this level.

338

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

339

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

340

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

341

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.

342

"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.

343

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

344

"level": 42, # The level for the user.

345

"maxExperiencePoints": "A String", # The maximum experience points for this level.

346

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

347

},

348

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

349

"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.

350

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

351

"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.

352

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

353

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

354

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

355

},

356

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

357

"familyName": "A String", # The family name of this player. In some places, this is known as the last name.

358

"givenName": "A String", # The given name of this player. In some places, this is known as the first name.

359

},

360

"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.

361

"playerId": "A String", # The ID of the player.

362

"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.

363

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

364

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

365

"profileVisible": True or False,

366

},

367

"title": "A String", # The player's title rewarded for their game activities.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

368

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

369

"status": "A String", # The status of the participant with respect to the room.

370

# Possible values are:

371

# - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.

372

# - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)

373

# - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.

374

# - "PARTICIPANT_LEFT" - The participant joined the room and then left it.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

375

},

376

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

377

"roomId": "A String", # Globally unique ID for a room.

378

"roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.

379

"status": "A String", # The status of the room.

380

# Possible values are:

381

# - "ROOM_INVITING" - One or more players have been invited and not responded.

382

# - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.

383

# - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).

384

# - "ROOM_ACTIVE" - All players have joined and connected to each other.

385

# - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

386

"variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

391

<code class="details" id="dismiss">dismiss(roomId)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

392

<pre>Dismiss an invitation to join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

393

394

Args:

395

roomId: string, The ID of the room. (required)

</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

400

<code class="details" id="get">get(roomId, language=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

401

<pre>Get the data for a room.

402

403

Args:

404

roomId: string, The ID of the room. (required)

405

language: string, The preferred language to use for strings returned by this method.

406

407

Returns:

408

An object of the form:

409

410

{ # This is a JSON template for a room resource object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

411

"applicationId": "A String", # The ID of the application being played.

412

"autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.

413

"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.

414

"kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.

415

"maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.

416

"minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

417

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

418

"autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue.

419

"kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.

420

"waitEstimateSeconds": 42, # An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

421

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

422

"creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.

423

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

424

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

425

"participantId": "A String", # The ID of the participant that modified the room.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

426

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

427

"description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)

428

"inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.

429

"kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.

430

"lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.

431

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

432

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

433

"participantId": "A String", # The ID of the participant that modified the room.

434

},

435

"participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

436

{ # This is a JSON template for a participant in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

437

"autoMatched": True or False, # True if this participant was auto-matched with the requesting player.

438

"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.)

439

"avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.

440

"displayName": "A String", # The name to display for the anonymous player.

441

"kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

442

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

443

"capabilities": [ # The capabilities which can be used when communicating with this participant.

444

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

445

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

446

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.

447

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

448

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

449

},

450

"connected": True or False, # True if this participant is in the fully connected set of peers in the room.

451

"id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.

452

"kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.

453

"leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.

454

# Possible values are:

455

# - "PLAYER_LEFT" - The player explicitly chose to leave the room.

456

# - "GAME_LEFT" - The game chose to remove the player from the room.

457

# - "ABANDONED" - The player switched to another application and abandoned the room.

458

# - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.

459

# - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.

460

# - "TIMEOUT" - The client timed out while waiting for players to join and connect.

461

# - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.

462

"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.)

463

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

464

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

465

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

466

"displayName": "A String", # The name to display for the player.

467

"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.

468

"currentExperiencePoints": "A String", # The current number of experience points for the player.

469

"currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.

470

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

471

"level": 42, # The level for the user.

472

"maxExperiencePoints": "A String", # The maximum experience points for this level.

473

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

474

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

475

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

476

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.

477

"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.

478

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

479

"level": 42, # The level for the user.

480

"maxExperiencePoints": "A String", # The maximum experience points for this level.

481

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

482

},

483

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

484

"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.

485

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

486

"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.

487

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

488

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

489

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

490

},

491

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

492

"familyName": "A String", # The family name of this player. In some places, this is known as the last name.

493

"givenName": "A String", # The given name of this player. In some places, this is known as the first name.

494

},

495

"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.

496

"playerId": "A String", # The ID of the player.

497

"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.

498

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

499

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

500

"profileVisible": True or False,

501

},

502

"title": "A String", # The player's title rewarded for their game activities.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

503

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

504

"status": "A String", # The status of the participant with respect to the room.

505

# Possible values are:

506

# - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.

507

# - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)

508

# - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.

509

# - "PARTICIPANT_LEFT" - The participant joined the room and then left it.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

510

},

511

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

512

"roomId": "A String", # Globally unique ID for a room.

513

"roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.

514

"status": "A String", # The status of the room.

515

# Possible values are:

516

# - "ROOM_INVITING" - One or more players have been invited and not responded.

517

# - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.

518

# - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).

519

# - "ROOM_ACTIVE" - All players have joined and connected to each other.

520

# - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

521

"variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

526

<code class="details" id="join">join(roomId, body=None, language=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

527

<pre>Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

528

529

Args:

530

roomId: string, The ID of the room. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

531

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

532

The object takes the form of:

533

534

{ # This is a JSON template for a join room request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

535

"capabilities": [ # The capabilities that this client supports for realtime communication.

536

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

537

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

538

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the player joining the room.

539

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

540

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

541

},

542

"kind": "games#roomJoinRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomJoinRequest.

543

"networkDiagnostics": { # This is a JSON template for network diagnostics reported for a client. # Network diagnostics for the client joining the room.

544

"androidNetworkSubtype": 42, # The Android network subtype.

545

"androidNetworkType": 42, # The Android network type.

546

"iosNetworkType": 42, # iOS network type as defined in Reachability.h.

547

"kind": "games#networkDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics.

548

"networkOperatorCode": "A String", # The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html

549

"networkOperatorName": "A String", # The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName

550

"registrationLatencyMillis": 42, # The amount of time in milliseconds it took for the client to establish a connection with the XMPP server.

551

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

552

}

553

554

language: string, The preferred language to use for strings returned by this method.

555

556

Returns:

557

An object of the form:

558

559

{ # This is a JSON template for a room resource object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

560

"applicationId": "A String", # The ID of the application being played.

561

"autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.

562

"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.

563

"kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.

564

"maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.

565

"minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

566

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

567

"autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue.

568

"kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.

569

"waitEstimateSeconds": 42, # An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

570

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

571

"creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.

572

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

573

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

574

"participantId": "A String", # The ID of the participant that modified the room.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

575

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

576

"description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)

577

"inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.

578

"kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.

579

"lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.

580

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

581

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

582

"participantId": "A String", # The ID of the participant that modified the room.

583

},

584

"participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

585

{ # This is a JSON template for a participant in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

586

"autoMatched": True or False, # True if this participant was auto-matched with the requesting player.

587

"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.)

588

"avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.

589

"displayName": "A String", # The name to display for the anonymous player.

590

"kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

591

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

592

"capabilities": [ # The capabilities which can be used when communicating with this participant.

593

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

594

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

595

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.

596

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

597

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

598

},

599

"connected": True or False, # True if this participant is in the fully connected set of peers in the room.

600

"id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.

601

"kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.

602

"leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.

603

# Possible values are:

604

# - "PLAYER_LEFT" - The player explicitly chose to leave the room.

605

# - "GAME_LEFT" - The game chose to remove the player from the room.

606

# - "ABANDONED" - The player switched to another application and abandoned the room.

607

# - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.

608

# - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.

609

# - "TIMEOUT" - The client timed out while waiting for players to join and connect.

610

# - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.

611

"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.)

612

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

613

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

614

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

615

"displayName": "A String", # The name to display for the player.

616

"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.

617

"currentExperiencePoints": "A String", # The current number of experience points for the player.

618

"currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.

619

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

620

"level": 42, # The level for the user.

621

"maxExperiencePoints": "A String", # The maximum experience points for this level.

622

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

623

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

624

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

625

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.

626

"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.

627

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

628

"level": 42, # The level for the user.

629

"maxExperiencePoints": "A String", # The maximum experience points for this level.

630

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

631

},

632

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

633

"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.

634

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

635

"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.

636

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

637

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

638

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

639

},

640

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

641

"familyName": "A String", # The family name of this player. In some places, this is known as the last name.

642

"givenName": "A String", # The given name of this player. In some places, this is known as the first name.

643

},

644

"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.

645

"playerId": "A String", # The ID of the player.

646

"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.

647

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

648

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

649

"profileVisible": True or False,

650

},

651

"title": "A String", # The player's title rewarded for their game activities.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

652

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

653

"status": "A String", # The status of the participant with respect to the room.

654

# Possible values are:

655

# - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.

656

# - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)

657

# - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.

658

# - "PARTICIPANT_LEFT" - The participant joined the room and then left it.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

659

},

660

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

661

"roomId": "A String", # Globally unique ID for a room.

662

"roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.

663

"status": "A String", # The status of the room.

664

# Possible values are:

665

# - "ROOM_INVITING" - One or more players have been invited and not responded.

666

# - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.

667

# - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).

668

# - "ROOM_ACTIVE" - All players have joined and connected to each other.

669

# - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

670

"variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

675

<code class="details" id="leave">leave(roomId, body=None, language=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

676

<pre>Leave a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

677

678

Args:

679

roomId: string, The ID of the room. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

680

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

681

The object takes the form of:

682

683

{ # This is a JSON template for a leave room request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

684

"kind": "games#roomLeaveRequest", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveRequest.

685

"leaveDiagnostics": { # This is a JSON template for room leave diagnostics. # Diagnostics for a player leaving the room.

686

"androidNetworkSubtype": 42, # Android network subtype. http://developer.android.com/reference/android/net/NetworkInfo.html#getSubtype()

687

"androidNetworkType": 42, # Android network type. http://developer.android.com/reference/android/net/NetworkInfo.html#getType()

688

"iosNetworkType": 42, # iOS network type as defined in Reachability.h.

689

"kind": "games#roomLeaveDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomLeaveDiagnostics.

690

"networkOperatorCode": "A String", # The MCC+MNC code for the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html

691

"networkOperatorName": "A String", # The name of the carrier of the client's network connection. On Android: http://developer.android.com/reference/android/telephony/TelephonyManager.html#getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#//apple_ref/occ/instp/CTCarrier/carrierName

692

"peerSession": [ # Diagnostics about all peer sessions.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

693

{ # This is a JSON template for peer session diagnostics.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

694

"connectedTimestampMillis": "A String", # Connected time in milliseconds.

695

"kind": "games#peerSessionDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#peerSessionDiagnostics.

696

"participantId": "A String", # The participant ID of the peer.

697

"reliableChannel": { # This is a JSON template for peer channel diagnostics. # Reliable channel diagnostics.

698

"bytesReceived": { # This is a JSON template for aggregate stats. # Number of bytes received.

699

"count": "A String", # The number of messages sent between a pair of peers.

700

"kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.

701

"max": "A String", # The maximum amount.

702

"min": "A String", # The minimum amount.

703

"sum": "A String", # The total number of bytes sent for messages between a pair of peers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

704

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

705

"bytesSent": { # This is a JSON template for aggregate stats. # Number of bytes sent.

706

"count": "A String", # The number of messages sent between a pair of peers.

707

"kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.

708

"max": "A String", # The maximum amount.

709

"min": "A String", # The minimum amount.

710

"sum": "A String", # The total number of bytes sent for messages between a pair of peers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

711

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

712

"kind": "games#peerChannelDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#peerChannelDiagnostics.

713

"numMessagesLost": 42, # Number of messages lost.

714

"numMessagesReceived": 42, # Number of messages received.

715

"numMessagesSent": 42, # Number of messages sent.

716

"numSendFailures": 42, # Number of send failures.

717

"roundtripLatencyMillis": { # This is a JSON template for aggregate stats. # Roundtrip latency stats in milliseconds.

718

"count": "A String", # The number of messages sent between a pair of peers.

719

"kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.

720

"max": "A String", # The maximum amount.

721

"min": "A String", # The minimum amount.

722

"sum": "A String", # The total number of bytes sent for messages between a pair of peers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

723

},

724

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

725

"unreliableChannel": { # This is a JSON template for peer channel diagnostics. # Unreliable channel diagnostics.

726

"bytesReceived": { # This is a JSON template for aggregate stats. # Number of bytes received.

727

"count": "A String", # The number of messages sent between a pair of peers.

728

"kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.

729

"max": "A String", # The maximum amount.

730

"min": "A String", # The minimum amount.

731

"sum": "A String", # The total number of bytes sent for messages between a pair of peers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

732

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

733

"bytesSent": { # This is a JSON template for aggregate stats. # Number of bytes sent.

734

"count": "A String", # The number of messages sent between a pair of peers.

735

"kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.

736

"max": "A String", # The maximum amount.

737

"min": "A String", # The minimum amount.

738

"sum": "A String", # The total number of bytes sent for messages between a pair of peers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

739

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

740

"kind": "games#peerChannelDiagnostics", # Uniquely identifies the type of this resource. Value is always the fixed string games#peerChannelDiagnostics.

741

"numMessagesLost": 42, # Number of messages lost.

742

"numMessagesReceived": 42, # Number of messages received.

743

"numMessagesSent": 42, # Number of messages sent.

744

"numSendFailures": 42, # Number of send failures.

745

"roundtripLatencyMillis": { # This is a JSON template for aggregate stats. # Roundtrip latency stats in milliseconds.

746

"count": "A String", # The number of messages sent between a pair of peers.

747

"kind": "games#aggregateStats", # Uniquely identifies the type of this resource. Value is always the fixed string games#aggregateStats.

748

"max": "A String", # The maximum amount.

749

"min": "A String", # The minimum amount.

750

"sum": "A String", # The total number of bytes sent for messages between a pair of peers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

751

},

752

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

753

},

754

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

755

"socketsUsed": True or False, # Whether or not sockets were used.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

756

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

757

"reason": "A String", # Reason for leaving the match.

758

# Possible values are:

759

# - "PLAYER_LEFT" - The player chose to leave the room..

760

# - "GAME_LEFT" - The game chose to remove the player from the room.

761

# - "REALTIME_ABANDONED" - The player switched to another application and abandoned the room.

762

# - "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to establish a connection to other peer(s).

763

# - "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to communicate with the server.

764

# - "REALTIME_SERVER_ERROR" - The client received an error response when it tried to communicate with the server.

765

# - "REALTIME_TIMEOUT" - The client timed out while waiting for a room.

766

# - "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without first calling Leave.

767

# - "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room.

768

# - "REALTIME_GAME_CRASHED" - The game crashed.

769

# - "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed.

770

# - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is trying to enter a room.

771

# - "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying to enter a new room.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

772

}

773

774

language: string, The preferred language to use for strings returned by this method.

775

776

Returns:

777

An object of the form:

778

779

{ # This is a JSON template for a room resource object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

780

"applicationId": "A String", # The ID of the application being played.

781

"autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.

782

"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.

783

"kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.

784

"maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.

785

"minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

786

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

787

"autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue.

788

"kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.

789

"waitEstimateSeconds": 42, # An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

790

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

791

"creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.

792

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

793

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

794

"participantId": "A String", # The ID of the participant that modified the room.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

795

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

796

"description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)

797

"inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.

798

"kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.

799

"lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.

800

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

801

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

802

"participantId": "A String", # The ID of the participant that modified the room.

803

},

804

"participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

805

{ # This is a JSON template for a participant in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

806

"autoMatched": True or False, # True if this participant was auto-matched with the requesting player.

807

"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.)

808

"avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.

809

"displayName": "A String", # The name to display for the anonymous player.

810

"kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

811

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

812

"capabilities": [ # The capabilities which can be used when communicating with this participant.

813

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

814

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

815

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.

816

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

817

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

818

},

819

"connected": True or False, # True if this participant is in the fully connected set of peers in the room.

820

"id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.

821

"kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.

822

"leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.

823

# Possible values are:

824

# - "PLAYER_LEFT" - The player explicitly chose to leave the room.

825

# - "GAME_LEFT" - The game chose to remove the player from the room.

826

# - "ABANDONED" - The player switched to another application and abandoned the room.

827

# - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.

828

# - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.

829

# - "TIMEOUT" - The client timed out while waiting for players to join and connect.

830

# - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.

831

"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.)

832

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

833

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

834

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

835

"displayName": "A String", # The name to display for the player.

836

"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.

837

"currentExperiencePoints": "A String", # The current number of experience points for the player.

838

"currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.

839

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

840

"level": 42, # The level for the user.

841

"maxExperiencePoints": "A String", # The maximum experience points for this level.

842

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

843

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

844

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

845

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.

846

"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.

847

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

848

"level": 42, # The level for the user.

849

"maxExperiencePoints": "A String", # The maximum experience points for this level.

850

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

851

},

852

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

853

"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.

854

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

855

"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.

856

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

857

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

858

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

859

},

860

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

861

"familyName": "A String", # The family name of this player. In some places, this is known as the last name.

862

"givenName": "A String", # The given name of this player. In some places, this is known as the first name.

863

},

864

"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.

865

"playerId": "A String", # The ID of the player.

866

"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.

867

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

868

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

869

"profileVisible": True or False,

870

},

871

"title": "A String", # The player's title rewarded for their game activities.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

872

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

873

"status": "A String", # The status of the participant with respect to the room.

874

# Possible values are:

875

# - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.

876

# - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)

877

# - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.

878

# - "PARTICIPANT_LEFT" - The participant joined the room and then left it.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

879

},

880

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

881

"roomId": "A String", # Globally unique ID for a room.

882

"roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.

883

"status": "A String", # The status of the room.

884

# Possible values are:

885

# - "ROOM_INVITING" - One or more players have been invited and not responded.

886

# - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.

887

# - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).

888

# - "ROOM_ACTIVE" - All players have joined and connected to each other.

889

# - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

890

"variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

895

<code class="details" id="list">list(language=None, maxResults=None, pageToken=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

896

<pre>Returns invitations to join rooms.

897

898

Args:

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

899

language: string, The preferred language to use for strings returned by this method.

900

maxResults: integer, The maximum number of rooms to return in the response, used for paging. For any response, the actual number of rooms to return may be less than the specified maxResults.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

901

pageToken: string, The token returned by the previous request.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

902

903

Returns:

904

An object of the form:

905

906

{ # This is a JSON template for a list of rooms.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

907

"items": [ # The rooms.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

908

{ # This is a JSON template for a room resource object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

909

"applicationId": "A String", # The ID of the application being played.

910

"autoMatchingCriteria": { # This is a JSON template for a room auto-match criteria object. # Criteria for auto-matching players into this room.

911

"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.

912

"kind": "games#roomAutoMatchingCriteria", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchingCriteria.

913

"maxAutoMatchingPlayers": 42, # The maximum number of players that should be added to the room by auto-matching.

914

"minAutoMatchingPlayers": 42, # The minimum number of players that should be added to the room by auto-matching.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

915

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

916

"autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the auto-matching queue.

917

"kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.

918

"waitEstimateSeconds": 42, # An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

919

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

920

"creationDetails": { # This is a JSON template for room modification metadata. # Details about the room creation.

921

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

922

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

923

"participantId": "A String", # The ID of the participant that modified the room.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

924

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

925

"description": "A String", # This short description is generated by our servers and worded relative to the player requesting the room. It is intended to be displayed when the room is shown in a list (that is, an invitation to a room.)

926

"inviterId": "A String", # The ID of the participant that invited the user to the room. Not set if the user was not invited to the room.

927

"kind": "games#room", # Uniquely identifies the type of this resource. Value is always the fixed string games#room.

928

"lastUpdateDetails": { # This is a JSON template for room modification metadata. # Details about the last update to the room.

929

"kind": "games#roomModification", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomModification.

930

"modifiedTimestampMillis": "A String", # The timestamp at which they modified the room, in milliseconds since the epoch in UTC.

931

"participantId": "A String", # The ID of the participant that modified the room.

932

},

933

"participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

934

{ # This is a JSON template for a participant in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

935

"autoMatched": True or False, # True if this participant was auto-matched with the requesting player.

936

"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.)

937

"avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.

938

"displayName": "A String", # The name to display for the anonymous player.

939

"kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

940

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

941

"capabilities": [ # The capabilities which can be used when communicating with this participant.

942

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

943

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

944

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.

945

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

946

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

947

},

948

"connected": True or False, # True if this participant is in the fully connected set of peers in the room.

949

"id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.

950

"kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.

951

"leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.

952

# Possible values are:

953

# - "PLAYER_LEFT" - The player explicitly chose to leave the room.

954

# - "GAME_LEFT" - The game chose to remove the player from the room.

955

# - "ABANDONED" - The player switched to another application and abandoned the room.

956

# - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.

957

# - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.

958

# - "TIMEOUT" - The client timed out while waiting for players to join and connect.

959

# - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.

960

"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.)

961

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

962

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

963

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

964

"displayName": "A String", # The name to display for the player.

965

"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.

966

"currentExperiencePoints": "A String", # The current number of experience points for the player.

967

"currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.

968

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

969

"level": 42, # The level for the user.

970

"maxExperiencePoints": "A String", # The maximum experience points for this level.

971

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

972

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

973

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

974

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.

975

"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.

976

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

977

"level": 42, # The level for the user.

978

"maxExperiencePoints": "A String", # The maximum experience points for this level.

979

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

980

},

981

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

982

"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.

983

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

984

"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.

985

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

986

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

987

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

988

},

989

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

990

"familyName": "A String", # The family name of this player. In some places, this is known as the last name.

991

"givenName": "A String", # The given name of this player. In some places, this is known as the first name.

992

},

993

"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.

994

"playerId": "A String", # The ID of the player.

995

"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.

996

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

997

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

998

"profileVisible": True or False,

999

},

1000

"title": "A String", # The player's title rewarded for their game activities.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1001

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1002

"status": "A String", # The status of the participant with respect to the room.

1003

# Possible values are:

1004

# - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.

1005

# - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)

1006

# - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.

1007

# - "PARTICIPANT_LEFT" - The participant joined the room and then left it.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1008

},

1009

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1010

"roomId": "A String", # Globally unique ID for a room.

1011

"roomStatusVersion": 42, # The version of the room status: an increasing counter, used by the client to ignore out-of-order updates to room status.

1012

"status": "A String", # The status of the room.

1013

# Possible values are:

1014

# - "ROOM_INVITING" - One or more players have been invited and not responded.

1015

# - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.

1016

# - "ROOM_CONNECTING" - Players have joined and are connecting to each other (either before or after auto-matching).

1017

# - "ROOM_ACTIVE" - All players have joined and connected to each other.

1018

# - "ROOM_DELETED" - The room should no longer be shown on the client. Returned in sync calls when a player joins a room (as a tombstone), or for rooms where all joined participants have left.

1019

"variant": 42, # The variant / mode of the application being played; can be any integer value, or left blank.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1020

},

1021

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1022

"kind": "games#roomList", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomList.

1023

"nextPageToken": "A String", # The pagination token for the next page of results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1029

<pre>Retrieves the next page of results.

1030

1031

Args:

1032

previous_request: The request for the previous page. (required)

1033

previous_response: The response from the request for the previous page. (required)

1034

1035

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1036

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1037

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1042

<code class="details" id="reportStatus">reportStatus(roomId, body=None, language=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1043

<pre>Updates sent by a client reporting the status of peers in a room. For internal use by the Games SDK only. Calling this method directly is unsupported.

1044

1045

Args:

1046

roomId: string, The ID of the room. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1047

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1048

The object takes the form of:

1049

1050

{ # This is a JSON template for an update on the status of peers in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1051

"kind": "games#roomP2PStatuses", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatuses.

1052

"updates": [ # The updates for the peers.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1053

{ # This is a JSON template for an update on the status of a peer in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1054

"connectionSetupLatencyMillis": 42, # The amount of time in milliseconds it took to establish connections with this peer.

1055

"error": "A String", # The error code in event of a failure.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1056

# Possible values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1057

# - "P2P_FAILED" - The client failed to establish a P2P connection with the peer.

1058

# - "PRESENCE_FAILED" - The client failed to register to receive P2P connections.

1059

# - "RELAY_SERVER_FAILED" - The client received an error when trying to use the relay server to establish a P2P connection with the peer.

1060

"error_reason": "A String", # More detailed diagnostic message returned in event of a failure.

1061

"kind": "games#roomP2PStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomP2PStatus.

1062

"participantId": "A String", # The ID of the participant.

1063

"status": "A String", # The status of the peer in the room.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1064

# Possible values are:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1065

# - "CONNECTION_ESTABLISHED" - The client established a P2P connection with the peer.

1066

# - "CONNECTION_FAILED" - The client failed to establish directed presence with the peer.

1067

"unreliableRoundtripLatencyMillis": 42, # The amount of time in milliseconds it took to send packets back and forth on the unreliable channel with this peer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

},

],

}

language: string, The preferred language to use for strings returned by this method.

1073

1074

Returns:

1075

An object of the form:

1076

1077

{ # This is a JSON template for the status of a room that the player has joined.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1078

"autoMatchingStatus": { # This is a JSON template for status of room automatching that is in progress. # Auto-matching status for this room. Not set if the room is not currently in the automatching queue.

1079

"kind": "games#roomAutoMatchStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomAutoMatchStatus.

1080

"waitEstimateSeconds": 42, # An estimate for the amount of time (in seconds) that auto-matching is expected to take to complete.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1081

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1082

"kind": "games#roomStatus", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomStatus.

1083

"participants": [ # The participants involved in the room, along with their statuses. Includes participants who have left or declined invitations.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1084

{ # This is a JSON template for a participant in a room.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1085

"autoMatched": True or False, # True if this participant was auto-matched with the requesting player.

1086

"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.)

1087

"avatarImageUrl": "A String", # The base URL for the image to display for the anonymous player.

1088

"displayName": "A String", # The name to display for the anonymous player.

1089

"kind": "games#anonymousPlayer", # Uniquely identifies the type of this resource. Value is always the fixed string games#anonymousPlayer.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1090

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1091

"capabilities": [ # The capabilities which can be used when communicating with this participant.

1092

"A String",

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1093

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1094

"clientAddress": { # This is a JSON template for the client address when setting up a room. # Client address for the participant.

1095

"kind": "games#roomClientAddress", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.

1096

"xmppAddress": "A String", # The XMPP address of the client on the Google Games XMPP network.

1097

},

1098

"connected": True or False, # True if this participant is in the fully connected set of peers in the room.

1099

"id": "A String", # An identifier for the participant in the scope of the room. Cannot be used to identify a player across rooms or in other contexts.

1100

"kind": "games#roomParticipant", # Uniquely identifies the type of this resource. Value is always the fixed string games#roomParticipant.

1101

"leaveReason": "A String", # The reason the participant left the room; populated if the participant status is PARTICIPANT_LEFT.

1102

# Possible values are:

1103

# - "PLAYER_LEFT" - The player explicitly chose to leave the room.

1104

# - "GAME_LEFT" - The game chose to remove the player from the room.

1105

# - "ABANDONED" - The player switched to another application and abandoned the room.

1106

# - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a connection to other peer(s) in the room.

1107

# - "SERVER_ERROR" - The client received an error response when it tried to communicate with the server.

1108

# - "TIMEOUT" - The client timed out while waiting for players to join and connect.

1109

# - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly.

1110

"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.)

1111

"avatarImageUrl": "A String", # The base URL for the image that represents the player.

1112

"bannerUrlLandscape": "A String", # The url to the landscape mode player banner image.

1113

"bannerUrlPortrait": "A String", # The url to the portrait mode player banner image.

1114

"displayName": "A String", # The name to display for the player.

1115

"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.

1116

"currentExperiencePoints": "A String", # The current number of experience points for the player.

1117

"currentLevel": { # This is a JSON template for 1P/3P metadata about a user's level. # The current level of the player.

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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1122

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1123

"kind": "games#playerExperienceInfo", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerExperienceInfo.

1124

"lastLevelUpTimestampMillis": "A String", # The timestamp when the player was leveled up, in millis since Unix epoch UTC.

1125

"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.

1126

"kind": "games#playerLevel", # Uniquely identifies the type of this resource. Value is always the fixed string games#playerLevel.

1127

"level": 42, # The level for the user.

1128

"maxExperiencePoints": "A String", # The maximum experience points for this level.

1129

"minExperiencePoints": "A String", # The minimum experience points for this level.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1130

},

1131

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1132

"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.

1133

"kind": "games#player", # Uniquely identifies the type of this resource. Value is always the fixed string games#player.

1134

"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.

1135

"autoMatched": True or False, # True if the player was auto-matched with the currently authenticated user.

1136

"kind": "games#played", # Uniquely identifies the type of this resource. Value is always the fixed string games#played.

1137

"timeMillis": "A String", # The last time the player played the game in milliseconds since the epoch in UTC.

1138

},

1139

"name": { # An object representation of the individual components of the player's name. For some players, these fields may not be present.

1140

"familyName": "A String", # The family name of this player. In some places, this is known as the last name.

1141

"givenName": "A String", # The given name of this player. In some places, this is known as the first name.

1142

},

1143

"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.

1144

"playerId": "A String", # The ID of the player.

1145

"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.

1146

"friendsListVisibility": "A String", # Whether the player's friends list is visible to the game.

1147

"kind": "games#profileSettings", # Uniquely identifies the type of this resource. Value is always the fixed string games#profileSettings.

1148

"profileVisible": True or False,

1149

},

1150

"title": "A String", # The player's title rewarded for their game activities.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1151

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1152

"status": "A String", # The status of the participant with respect to the room.

1153

# Possible values are:

1154

# - "PARTICIPANT_INVITED" - The participant has been invited to join the room, but has not yet responded.

1155

# - "PARTICIPANT_JOINED" - The participant has joined the room (either after creating it or accepting an invitation.)

1156

# - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the room.

1157

# - "PARTICIPANT_LEFT" - The participant joined the room and then left it.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1158

},

1159

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1160

"roomId": "A String", # Globally unique ID for a room.

1161

"status": "A String", # The status of the room.

1162

# Possible values are:

1163

# - "ROOM_INVITING" - One or more players have been invited and not responded.

1164

# - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching.

1165

# - "ROOM_CONNECTING" - Players have joined are connecting to each other (either before or after auto-matching).

1166

# - "ROOM_ACTIVE" - All players have joined and connected to each other.

1167

# - "ROOM_DELETED" - All joined players have left.

1168

"statusVersion": 42, # The version of the status for the room: an increasing counter, used by the client to ignore out-of-order updates to room status.

John Asmuth