Lobby Matchmaking Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

• Specification ID: http://lobby-matchmaking-service
• Protobuf File Spec: matchmaking.proto

Table of Contents

• Operations
  • PUB matchmaking
  • PUB matchmakingTotalPlayersInQueue
  • PUB readyConsent

Operations

PUB matchmaking Operation

Accepts one of the following messages:

Message matchmakingRequested

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.matchmakingRequest	object	-	-	-	additional properties are allowed
payload.matchmakingRequest.priority	string	-	-	-	-
payload.matchmakingRequest.createdAt	string	-	-	-	-
payload.matchmakingRequest.channel	string	-	-	-	-
payload.matchmakingRequest.partyId	string	-	-	-	-
payload.matchmakingRequest.ticketId	string	-	-	-	-
payload.matchmakingRequest.partyMembers	array<object>	-	-	-	-
payload.matchmakingRequest.partyMembers.userId	string	-	-	-	-
payload.matchmakingRequest.partyMembers.extraAttributes	object	-	-	-	additional properties are allowed
payload.matchmakingRequest.timestamp	string	-	-	format (date-time)	-
payload.matchmakingRequest.event	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "matchmakingRequest": {
      "priority": "string",
      "createdAt": "string",
      "channel": "string",
      "partyId": "string",
      "ticketId": "string",
      "partyMembers": [
        {
          "userId": "string",
          "extraAttributes": {}
        }
      ],
      "timestamp": "2019-08-24T14:15:22Z",
      "event": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingCanceled

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.matchmaking	object	-	-	-	additional properties are allowed
payload.matchmaking.status	string	-	-	-	-
payload.matchmaking.matchId	string	-	-	-	-
payload.matchmaking.channel	string	-	-	-	-
payload.matchmaking.namespace	string	-	-	-	-
payload.matchmaking.gameMode	string	-	-	-	-
payload.matchmaking.matchingParties	array<object>	-	-	-	-
payload.matchmaking.matchingParties.userId	string	-	-	-	-
payload.matchmaking.matchingParties.extraAttributes	object	-	-	-	additional properties are allowed
payload.matchmaking.ticketId	string	-	-	-	-
payload.matchmaking.ticketIds	array<string>	-	-	-	-
payload.matchmaking.ticketIds (single item)	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "matchmaking": {
      "status": "string",
      "matchId": "string",
      "channel": "string",
      "namespace": "string",
      "gameMode": "string",
      "matchingParties": [
        {
          "userId": "string",
          "extraAttributes": {}
        }
      ],
      "ticketId": "string",
      "ticketIds": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingStarted

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.matchmaking	object	-	-	-	additional properties are allowed
payload.matchmaking.status	string	-	-	-	-
payload.matchmaking.matchId	string	-	-	-	-
payload.matchmaking.channel	string	-	-	-	-
payload.matchmaking.namespace	string	-	-	-	-
payload.matchmaking.gameMode	string	-	-	-	-
payload.matchmaking.matchingParties	array<object>	-	-	-	-
payload.matchmaking.matchingParties.ticket_id	string	-	-	-	-
payload.matchmaking.matchingParties.party_id	string	-	-	-	-
payload.matchmaking.matchingParties.party_members	array<object>	-	-	-	-
payload.matchmaking.matchingParties.party_members.user_id	string	-	-	-	-
payload.matchmaking.matchingParties.party_members.extra_attributes	object	-	-	-	additional properties are allowed
payload.matchmaking.matchingParties.party_attributes	object	-	-	-	additional properties are allowed
payload.matchmaking.matchingParties.ticket_created_at	integer	-	-	-	-
payload.matchmaking.matchingParties.first_ticket_created_at	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "matchmaking": {
      "status": "string",
      "matchId": "string",
      "channel": "string",
      "namespace": "string",
      "gameMode": "string",
      "matchingParties": [
        {
          "ticket_id": "string",
          "party_id": "string",
          "party_members": [
            {
              "user_id": "string",
              "extra_attributes": {}
            }
          ],
          "party_attributes": {},
          "ticket_created_at": 0,
          "first_ticket_created_at": 0
        }
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingTimeout

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.matchmaking	object	-	-	-	additional properties are allowed
payload.matchmaking.status	string	-	-	-	-
payload.matchmaking.matchId	string	-	-	-	-
payload.matchmaking.channel	string	-	-	-	-
payload.matchmaking.namespace	string	-	-	-	-
payload.matchmaking.gameMode	string	-	-	-	-
payload.matchmaking.matchingParties	array<object>	-	-	-	-
payload.matchmaking.matchingParties.userId	string	-	-	-	-
payload.matchmaking.matchingParties.extraAttributes	object	-	-	-	additional properties are allowed
payload.matchmaking.ticketId	string	-	-	-	-
payload.matchmaking.ticketIds	array<string>	-	-	-	-
payload.matchmaking.ticketIds (single item)	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "matchmaking": {
      "status": "string",
      "matchId": "string",
      "channel": "string",
      "namespace": "string",
      "gameMode": "string",
      "matchingParties": [
        {
          "userId": "string",
          "extraAttributes": {}
        }
      ],
      "ticketId": "string",
      "ticketIds": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingRejected

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.matchmaking	object	-	-	-	additional properties are allowed
payload.matchmaking.status	string	-	-	-	-
payload.matchmaking.matchId	string	-	-	-	-
payload.matchmaking.channel	string	-	-	-	-
payload.matchmaking.namespace	string	-	-	-	-
payload.matchmaking.gameMode	string	-	-	-	-
payload.matchmaking.matchingParties	array<object>	-	-	-	-
payload.matchmaking.matchingParties.userId	string	-	-	-	-
payload.matchmaking.matchingParties.extraAttributes	object	-	-	-	additional properties are allowed
payload.matchmaking.ticketId	string	-	-	-	-
payload.matchmaking.ticketIds	array<string>	-	-	-	-
payload.matchmaking.ticketIds (single item)	string	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "matchmaking": {
      "status": "string",
      "matchId": "string",
      "channel": "string",
      "namespace": "string",
      "gameMode": "string",
      "matchingParties": [
        {
          "userId": "string",
          "extraAttributes": {}
        }
      ],
      "ticketId": "string",
      "ticketIds": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingChannelCreated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.ruleset	object	-	-	-	additional properties are allowed
payload.ruleset.alliance	object	-	-	-	additional properties are allowed
payload.ruleset.alliance.min_number	integer	-	-	-	-
payload.ruleset.alliance.max_number	integer	-	-	-	-
payload.ruleset.alliance.player_min_number	integer	-	-	-	-
payload.ruleset.alliance.player_max_number	integer	-	-	-	-
payload.ruleset.alliance.combination	object	-	-	-	additional properties are allowed
payload.ruleset.alliance.combination.role_flexing_enable	boolean	-	-	-	-
payload.ruleset.alliance.combination.role_flexing_second	integer	-	-	-	-
payload.ruleset.alliance.combination.role_flexing_player	integer	-	-	-	-
payload.ruleset.alliance.combination.has_combination	boolean	-	-	-	-
payload.ruleset.alliance.combination.alliances	array<array<object>>	-	-	-	-
payload.ruleset.alliance.combination.alliances (single item)	array<object>	-	-	-	-
payload.ruleset.alliance.combination.alliances.name	string	-	-	-	-
payload.ruleset.alliance.combination.alliances.min	integer	-	-	-	-
payload.ruleset.alliance.combination.alliances.max	integer	-	-	-	-
payload.ruleset.matching_rule	array<object>	-	-	-	-
payload.ruleset.matching_rule.attribute	string	-	-	-	-
payload.ruleset.matching_rule.criteria	string	-	-	-	-
payload.ruleset.matching_rule.reference	number	-	-	format (float)	-
payload.ruleset.flexing_rule	array<object>	-	-	-	-
payload.ruleset.flexing_rule.duration	integer	-	-	-	-
payload.ruleset.flexing_rule.matching_rule	object	-	-	-	additional properties are allowed
payload.ruleset.flexing_rule.matching_rule.attribute	string	-	-	-	-
payload.ruleset.flexing_rule.matching_rule.criteria	string	-	-	-	-
payload.ruleset.flexing_rule.matching_rule.reference	number	-	-	format (float)	-
payload.ruleset.alliance_flexing_rule	array<object>	-	-	-	-
payload.ruleset.alliance_flexing_rule.duration	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule	object	-	-	-	additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.min_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.max_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.player_min_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.player_max_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination	object	-	-	-	additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_enable	boolean	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_second	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_player	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.has_combination	boolean	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances	array<array<object>>	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances (single item)	array<object>	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.name	string	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.min	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.max	integer	-	-	-	-
payload.ruleset.match_options	array<object>	-	-	-	-
payload.ruleset.match_options.options	object	-	-	-	additional properties are allowed
payload.ruleset.match_options.options.name	string	-	-	-	-
payload.ruleset.match_options.options.type	string	-	-	-	-
payload.ruleset.rebalance_enable	boolean	-	-	-	-
payload.description	string	-	-	-	-
payload.gameMode	string	-	-	-	-
payload.findMatchTimeoutSeconds	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "ruleset": {
      "alliance": {
        "min_number": 0,
        "max_number": 0,
        "player_min_number": 0,
        "player_max_number": 0,
        "combination": {
          "role_flexing_enable": true,
          "role_flexing_second": 0,
          "role_flexing_player": 0,
          "has_combination": true,
          "alliances": [
            [
              {
                "name": "string",
                "min": 0,
                "max": 0
              }
            ]
          ]
        }
      },
      "matching_rule": [
        {
          "attribute": "string",
          "criteria": "string",
          "reference": 0
        }
      ],
      "flexing_rule": [
        {
          "duration": 0,
          "matching_rule": {
            "attribute": "string",
            "criteria": "string",
            "reference": 0
          }
        }
      ],
      "alliance_flexing_rule": [
        {
          "duration": 0,
          "AllianceRule": {
            "min_number": 0,
            "max_number": 0,
            "player_min_number": 0,
            "player_max_number": 0,
            "combination": {
              "role_flexing_enable": true,
              "role_flexing_second": 0,
              "role_flexing_player": 0,
              "has_combination": true,
              "alliances": [
                [
                  {
                    "name": "string",
                    "min": 0,
                    "max": 0
                  }
                ]
              ]
            }
          }
        }
      ],
      "match_options": [
        {
          "options": {
            "name": "string",
            "type": "string"
          }
        }
      ],
      "rebalance_enable": true
    },
    "description": "string",
    "gameMode": "string",
    "findMatchTimeoutSeconds": 0
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingChannelDeleted

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.ruleset	object	-	-	-	additional properties are allowed
payload.ruleset.alliance	object	-	-	-	additional properties are allowed
payload.ruleset.alliance.min_number	integer	-	-	-	-
payload.ruleset.alliance.max_number	integer	-	-	-	-
payload.ruleset.alliance.player_min_number	integer	-	-	-	-
payload.ruleset.alliance.player_max_number	integer	-	-	-	-
payload.ruleset.alliance.combination	object	-	-	-	additional properties are allowed
payload.ruleset.alliance.combination.role_flexing_enable	boolean	-	-	-	-
payload.ruleset.alliance.combination.role_flexing_second	integer	-	-	-	-
payload.ruleset.alliance.combination.role_flexing_player	integer	-	-	-	-
payload.ruleset.alliance.combination.has_combination	boolean	-	-	-	-
payload.ruleset.alliance.combination.alliances	array<array<object>>	-	-	-	-
payload.ruleset.alliance.combination.alliances (single item)	array<object>	-	-	-	-
payload.ruleset.alliance.combination.alliances.name	string	-	-	-	-
payload.ruleset.alliance.combination.alliances.min	integer	-	-	-	-
payload.ruleset.alliance.combination.alliances.max	integer	-	-	-	-
payload.ruleset.matching_rule	array<object>	-	-	-	-
payload.ruleset.matching_rule.attribute	string	-	-	-	-
payload.ruleset.matching_rule.criteria	string	-	-	-	-
payload.ruleset.matching_rule.reference	number	-	-	format (float)	-
payload.ruleset.flexing_rule	array<object>	-	-	-	-
payload.ruleset.flexing_rule.duration	integer	-	-	-	-
payload.ruleset.flexing_rule.matching_rule	object	-	-	-	additional properties are allowed
payload.ruleset.flexing_rule.matching_rule.attribute	string	-	-	-	-
payload.ruleset.flexing_rule.matching_rule.criteria	string	-	-	-	-
payload.ruleset.flexing_rule.matching_rule.reference	number	-	-	format (float)	-
payload.ruleset.alliance_flexing_rule	array<object>	-	-	-	-
payload.ruleset.alliance_flexing_rule.duration	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule	object	-	-	-	additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.min_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.max_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.player_min_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.player_max_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination	object	-	-	-	additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_enable	boolean	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_second	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_player	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.has_combination	boolean	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances	array<array<object>>	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances (single item)	array<object>	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.name	string	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.min	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.max	integer	-	-	-	-
payload.ruleset.match_options	array<object>	-	-	-	-
payload.ruleset.match_options.options	object	-	-	-	additional properties are allowed
payload.ruleset.match_options.options.name	string	-	-	-	-
payload.ruleset.match_options.options.type	string	-	-	-	-
payload.ruleset.rebalance_enable	boolean	-	-	-	-
payload.description	string	-	-	-	-
payload.gameMode	string	-	-	-	-
payload.findMatchTimeoutSeconds	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "ruleset": {
      "alliance": {
        "min_number": 0,
        "max_number": 0,
        "player_min_number": 0,
        "player_max_number": 0,
        "combination": {
          "role_flexing_enable": true,
          "role_flexing_second": 0,
          "role_flexing_player": 0,
          "has_combination": true,
          "alliances": [
            [
              {
                "name": "string",
                "min": 0,
                "max": 0
              }
            ]
          ]
        }
      },
      "matching_rule": [
        {
          "attribute": "string",
          "criteria": "string",
          "reference": 0
        }
      ],
      "flexing_rule": [
        {
          "duration": 0,
          "matching_rule": {
            "attribute": "string",
            "criteria": "string",
            "reference": 0
          }
        }
      ],
      "alliance_flexing_rule": [
        {
          "duration": 0,
          "AllianceRule": {
            "min_number": 0,
            "max_number": 0,
            "player_min_number": 0,
            "player_max_number": 0,
            "combination": {
              "role_flexing_enable": true,
              "role_flexing_second": 0,
              "role_flexing_player": 0,
              "has_combination": true,
              "alliances": [
                [
                  {
                    "name": "string",
                    "min": 0,
                    "max": 0
                  }
                ]
              ]
            }
          }
        }
      ],
      "match_options": [
        {
          "options": {
            "name": "string",
            "type": "string"
          }
        }
      ],
      "rebalance_enable": true
    },
    "description": "string",
    "gameMode": "string",
    "findMatchTimeoutSeconds": 0
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingChannelUpdated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.ruleset	object	-	-	-	additional properties are allowed
payload.ruleset.alliance	object	-	-	-	additional properties are allowed
payload.ruleset.alliance.min_number	integer	-	-	-	-
payload.ruleset.alliance.max_number	integer	-	-	-	-
payload.ruleset.alliance.player_min_number	integer	-	-	-	-
payload.ruleset.alliance.player_max_number	integer	-	-	-	-
payload.ruleset.alliance.combination	object	-	-	-	additional properties are allowed
payload.ruleset.alliance.combination.role_flexing_enable	boolean	-	-	-	-
payload.ruleset.alliance.combination.role_flexing_second	integer	-	-	-	-
payload.ruleset.alliance.combination.role_flexing_player	integer	-	-	-	-
payload.ruleset.alliance.combination.has_combination	boolean	-	-	-	-
payload.ruleset.alliance.combination.alliances	array<array<object>>	-	-	-	-
payload.ruleset.alliance.combination.alliances (single item)	array<object>	-	-	-	-
payload.ruleset.alliance.combination.alliances.name	string	-	-	-	-
payload.ruleset.alliance.combination.alliances.min	integer	-	-	-	-
payload.ruleset.alliance.combination.alliances.max	integer	-	-	-	-
payload.ruleset.matching_rule	array<object>	-	-	-	-
payload.ruleset.matching_rule.attribute	string	-	-	-	-
payload.ruleset.matching_rule.criteria	string	-	-	-	-
payload.ruleset.matching_rule.reference	number	-	-	format (float)	-
payload.ruleset.flexing_rule	array<object>	-	-	-	-
payload.ruleset.flexing_rule.duration	integer	-	-	-	-
payload.ruleset.flexing_rule.matching_rule	object	-	-	-	additional properties are allowed
payload.ruleset.flexing_rule.matching_rule.attribute	string	-	-	-	-
payload.ruleset.flexing_rule.matching_rule.criteria	string	-	-	-	-
payload.ruleset.flexing_rule.matching_rule.reference	number	-	-	format (float)	-
payload.ruleset.alliance_flexing_rule	array<object>	-	-	-	-
payload.ruleset.alliance_flexing_rule.duration	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule	object	-	-	-	additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.min_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.max_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.player_min_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.player_max_number	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination	object	-	-	-	additional properties are allowed
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_enable	boolean	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_second	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.role_flexing_player	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.has_combination	boolean	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances	array<array<object>>	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances (single item)	array<object>	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.name	string	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.min	integer	-	-	-	-
payload.ruleset.alliance_flexing_rule.AllianceRule.combination.alliances.max	integer	-	-	-	-
payload.ruleset.match_options	array<object>	-	-	-	-
payload.ruleset.match_options.options	object	-	-	-	additional properties are allowed
payload.ruleset.match_options.options.name	string	-	-	-	-
payload.ruleset.match_options.options.type	string	-	-	-	-
payload.ruleset.rebalance_enable	boolean	-	-	-	-
payload.description	string	-	-	-	-
payload.gameMode	string	-	-	-	-
payload.findMatchTimeoutSeconds	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "ruleset": {
      "alliance": {
        "min_number": 0,
        "max_number": 0,
        "player_min_number": 0,
        "player_max_number": 0,
        "combination": {
          "role_flexing_enable": true,
          "role_flexing_second": 0,
          "role_flexing_player": 0,
          "has_combination": true,
          "alliances": [
            [
              {
                "name": "string",
                "min": 0,
                "max": 0
              }
            ]
          ]
        }
      },
      "matching_rule": [
        {
          "attribute": "string",
          "criteria": "string",
          "reference": 0
        }
      ],
      "flexing_rule": [
        {
          "duration": 0,
          "matching_rule": {
            "attribute": "string",
            "criteria": "string",
            "reference": 0
          }
        }
      ],
      "alliance_flexing_rule": [
        {
          "duration": 0,
          "AllianceRule": {
            "min_number": 0,
            "max_number": 0,
            "player_min_number": 0,
            "player_max_number": 0,
            "combination": {
              "role_flexing_enable": true,
              "role_flexing_second": 0,
              "role_flexing_player": 0,
              "has_combination": true,
              "alliances": [
                [
                  {
                    "name": "string",
                    "min": 0,
                    "max": 0
                  }
                ]
              ]
            }
          }
        }
      ],
      "match_options": [
        {
          "options": {
            "name": "string",
            "type": "string"
          }
        }
      ],
      "rebalance_enable": true
    },
    "description": "string",
    "gameMode": "string",
    "findMatchTimeoutSeconds": 0
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingSessionStatusChanged

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.session	object	-	-	-	additional properties are allowed
payload.session.status	string	-	-	-	-
payload.session.event	string	-	-	-	-
payload.session.party_id	string	-	-	-	-
payload.session.ticket_id	string	-	-	-	-
payload.session.match_id	string	-	-	-	-
payload.session.channel	string	-	-	-	-
payload.session.namespace	string	-	-	-	-
payload.session.game_mode	string	-	-	-	-
payload.session.server_name	string	-	-	-	-
payload.session.client_version	string	-	-	-	-
payload.session.region	string	-	-	-	-
payload.session.joinable	boolean	-	-	-	-
payload.session.matching_allies	array<object>	-	-	-	-
payload.session.matching_allies.matching_parties	array<object>	-	-	-	-
payload.session.matching_allies.matching_parties.ticket_id	string	-	-	-	-
payload.session.matching_allies.matching_parties.party_id	string	-	-	-	-
payload.session.matching_allies.matching_parties.party_members	array<object>	-	-	-	-
payload.session.matching_allies.matching_parties.party_members.user_id	string	-	-	-	-
payload.session.matching_allies.matching_parties.party_members.extra_attributes	object	-	-	-	additional properties are allowed
payload.session.matching_allies.matching_parties.party_attributes	object	-	-	-	additional properties are allowed
payload.session.matching_allies.matching_parties.ticket_created_at	integer	-	-	-	-
payload.session.matching_allies.matching_parties.first_ticket_created_at	integer	-	-	-	-
payload.session.matching_allies.playerCount	integer	-	-	-	-
payload.session.deployment	string	-	-	-	-
payload.session.updatedAt	string	-	-	format (date-time)	-
payload.session.queueAt	integer	-	-	-	-
payload.session.partyAttributes	string	-	-	-	-
payload.session.errorCode	integer	-	-	-	-
payload.session.errorMessage	string	-	-	-	-
payload.session.timestamp	string	-	-	format (date-time)	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "session": {
      "status": "string",
      "event": "string",
      "party_id": "string",
      "ticket_id": "string",
      "match_id": "string",
      "channel": "string",
      "namespace": "string",
      "game_mode": "string",
      "server_name": "string",
      "client_version": "string",
      "region": "string",
      "joinable": true,
      "matching_allies": [
        {
          "matching_parties": [
            {
              "ticket_id": "string",
              "party_id": "string",
              "party_members": [
                {
                  "user_id": "string",
                  "extra_attributes": {}
                }
              ],
              "party_attributes": {},
              "ticket_created_at": 0,
              "first_ticket_created_at": 0
            }
          ],
          "playerCount": 0
        }
      ],
      "deployment": "string",
      "updatedAt": "2019-08-24T14:15:22Z",
      "queueAt": 0,
      "partyAttributes": "string",
      "errorCode": 0,
      "errorMessage": "string",
      "timestamp": "2019-08-24T14:15:22Z"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message matchmakingTicketStatusChanged

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.ticket	object	-	-	-	additional properties are allowed
payload.ticket.priority	integer	-	-	-	-
payload.ticket.created_at	integer	-	-	-	-
payload.ticket.channel	string	-	-	-	-
payload.ticket.namespace	string	-	-	-	-
payload.ticket.ticket_id	string	-	-	-	-
payload.ticket.party_id	string	-	-	-	-
payload.ticket.party_leader_id	string	-	-	-	-
payload.ticket.party_attributes	object	-	-	-	additional properties are allowed
payload.ticket.party_members	array<object>	-	-	-	-
payload.ticket.party_members.user_id	string	-	-	-	-
payload.ticket.party_members.extra_attributes	object	-	-	-	additional properties are allowed
payload.ticket.additional_criteria	object	-	-	-	additional properties are allowed
payload.ticket.latency_map	object	-	-	-	-
payload.ticket.latency_map (additional properties)	integer	-	-	-	-
payload.ticket.sorted_latency	array<object>	-	-	-	-
payload.ticket.sorted_latency.region	string	-	-	-	-
payload.ticket.sorted_latency.latency	integer	-	-	-	-
payload.ticket.first_ticket_created_at	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "ticket": {
      "priority": 0,
      "created_at": 0,
      "channel": "string",
      "namespace": "string",
      "ticket_id": "string",
      "party_id": "string",
      "party_leader_id": "string",
      "party_attributes": {},
      "party_members": [
        {
          "user_id": "string",
          "extra_attributes": {}
        }
      ],
      "additional_criteria": {},
      "latency_map": {
        "property1": 0,
        "property2": 0
      },
      "sorted_latency": [
        {
          "region": "string",
          "latency": 0
        }
      ],
      "first_ticket_created_at": 0
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

PUB matchmakingTotalPlayersInQueue Operation

Message matchmakingTotalPlayersInQueue

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.totalPlayersInQueue	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "totalPlayersInQueue": 0
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

PUB readyConsent Operation

Accepts one of the following messages:

Message readyConsentSuccess

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.successTickets	object	-	-	-	additional properties are allowed
payload.successTickets.partyId	string	-	-	-	-
payload.successTickets.memberIds	array<string>	-	-	-	-
payload.successTickets.memberIds (single item)	string	-	-	-	-
payload.successTickets.ticketCreatedAt	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "successTickets": {
      "partyId": "string",
      "memberIds": [
        "string"
      ],
      "ticketCreatedAt": 0
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}

Message readyConsentFailed

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	allOf	-	-	-	additional properties are allowed
payload	-	-	-	-	additional properties are allowed
payload.successTickets	object	-	-	-	additional properties are allowed
payload.successTickets.partyId	string	-	-	-	-
payload.successTickets.memberIds	array<string>	-	-	-	-
payload.successTickets.memberIds (single item)	string	-	-	-	-
payload.successTickets.ticketCreatedAt	integer	-	-	-	-
payload.failedTickets	object	-	-	-	additional properties are allowed
payload.failedTickets.partyId	string	-	-	-	-
payload.failedTickets.succeedMemberIds	array<string>	-	-	-	-
payload.failedTickets.succeedMemberIds (single item)	string	-	-	-	-
payload.failedTickets.failedMemberIds	array<string>	-	-	-	-
payload.failedTickets.failedMemberIds (single item)	string	-	-	-	-
payload.failedTickets.ticketCreatedAt	integer	-	-	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	as operator id	-	-	-
sessionId	string	-	-	-	-
spanContext	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "successTickets": {
      "partyId": "string",
      "memberIds": [
        "string"
      ],
      "ticketCreatedAt": 0
    },
    "failedTickets": {
      "partyId": "string",
      "succeedMemberIds": [
        "string"
      ],
      "failedMemberIds": [
        "string"
      ],
      "ticketCreatedAt": 0
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "sessionId": "string",
  "spanContext": "string"
}