Rooms: join

Requires authorization

Join a room. For internal use by the Games SDK only. Calling this method directly is unsupported. Try it now.

Request

HTTP request

POST https://www.googleapis.com/games/v1/rooms/roomId/join

Parameters

Parameter name Value Description
Path parameters
roomId string The ID of the room.
Optional query parameters
consistencyToken long The last-seen mutation timestamp.
language string The preferred language to use for strings returned by this method.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/games

Request body

In the request body, supply data with the following structure:

{
  "kind": "games#roomJoinRequest",
  "clientAddress": {
    "kind": "games#roomClientAddress",
    "xmppAddress": string
  },
  "networkDiagnostics": {
    "kind": "games#networkDiagnostics",
    "registrationLatencyMillis": integer,
    "androidNetworkType": integer,
    "androidNetworkSubtype": integer,
    "iosNetworkType": integer,
    "networkOperatorName": string,
    "networkOperatorCode": string
  },
  "capabilities": [
    string
  ]
}
Property name Value Description Notes
kind string Uniquely identifies the type of this resource. Value is always the fixed string games#roomJoinRequest.
clientAddress nested object Client address for the player joining the room.
clientAddress.kind string Uniquely identifies the type of this resource. Value is always the fixed string games#roomClientAddress.
clientAddress.xmppAddress string The XMPP address of the client on the Google Games XMPP network.
networkDiagnostics nested object Network diagnostics for the client joining the room.
networkDiagnostics.kind string Uniquely identifies the type of this resource. Value is always the fixed string games#networkDiagnostics.
networkDiagnostics.registrationLatencyMillis integer The amount of time in milliseconds it took for the client to establish a connection with the XMPP server.
networkDiagnostics.androidNetworkType integer The Android network type.
networkDiagnostics.androidNetworkSubtype integer The Android network subtype.
networkDiagnostics.iosNetworkType integer iOS network type as defined in Reachability.h.
networkDiagnostics.networkOperatorName 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
networkDiagnostics.networkOperatorCode 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
capabilities[] list The capabilities that this client supports for realtime communication.

Response

If successful, this method returns a Rooms resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.

Enviar comentarios sobre…

Play Games Services for Web
Play Games Services for Web