Matchmaking Admin - List Matchmaking Queues
SDK support is limited to C# and Java for this API. List all matchmaking queue configs.
POST https://titleId.playfabapi.com/Match/ListMatchmakingQueuesRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-EntityToken | True |
string |
This API requires an Entity Session Token, available from the Entity GetEntityToken method. |
Request Body
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-EntityToken
This API requires an Entity Session Token, available from the Entity GetEntityToken method.
Type:
apiKey
In:
header
Definitions
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
AttributeMergeFunction
| Name | Type | Description |
|---|---|---|
| Average |
string |
|
| Max |
string |
|
| Min |
string |
AttributeNotSpecifiedBehavior
| Name | Type | Description |
|---|---|---|
| MatchAny |
string |
|
| UseDefault |
string |
AttributeSource
| Name | Type | Description |
|---|---|---|
| PlayerEntity |
string |
|
| User |
string |
BuildAliasParams
| Name | Type | Description |
|---|---|---|
| AliasId |
string |
The guid string alias ID to use for the request. |
CustomDifferenceRuleExpansion
| Name | Type | Description |
|---|---|---|
| DifferenceOverrides |
Manually specify the values to use for each expansion interval (this overrides Difference, Delta, and MaxDifference). |
|
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
CustomRegionSelectionRuleExpansion
| Name | Type | Description |
|---|---|---|
| MaxLatencyOverrides |
Manually specify the maximum latency to use for each expansion interval. |
|
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
CustomSetIntersectionRuleExpansion
| Name | Type | Description |
|---|---|---|
| MinIntersectionSizeOverrides |
Manually specify the values to use for each expansion interval. |
|
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
CustomTeamDifferenceRuleExpansion
| Name | Type | Description |
|---|---|---|
| DifferenceOverrides |
Manually specify the team difference value to use for each expansion interval. |
|
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
CustomTeamSizeBalanceRuleExpansion
| Name | Type | Description |
|---|---|---|
| DifferenceOverrides |
Manually specify the team size difference to use for each expansion interval. |
|
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
DifferenceRule
| Name | Type | Description |
|---|---|---|
| Attribute |
Description of the attribute used by this rule to match tickets. |
|
| AttributeNotSpecifiedBehavior |
Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity profile. |
|
| CustomExpansion |
Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. When this is set, Difference is ignored. |
|
| DefaultAttributeValue |
number |
The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that AttributeNotSpecifiedBehavior is false). Optional. |
| Difference |
number |
The allowed difference between any two tickets at the start of matchmaking. |
| LinearExpansion |
Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. |
|
| MergeFunction |
How values are treated when there are multiple players in a single ticket. |
|
| Name |
string |
Friendly name chosen by developer. |
| SecondsUntilOptional |
number |
How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be prioritized over those that don't). Leave blank if this rule is always enforced. |
| Weight |
number |
The relative weight of this rule compared to others. |
LinearDifferenceRuleExpansion
| Name | Type | Description |
|---|---|---|
| Delta |
number |
This value gets added to Difference at every expansion interval. |
| Limit |
number |
Once the total difference reaches this value, expansion stops. Optional. |
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
LinearRegionSelectionRuleExpansion
| Name | Type | Description |
|---|---|---|
| Delta |
number |
This value gets added to MaxLatency at every expansion interval. |
| Limit |
number |
Once the max Latency reaches this value, expansion stops. |
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
LinearSetIntersectionRuleExpansion
| Name | Type | Description |
|---|---|---|
| Delta |
number |
This value gets added to MinIntersectionSize at every expansion interval. |
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
LinearTeamDifferenceRuleExpansion
| Name | Type | Description |
|---|---|---|
| Delta |
number |
This value gets added to Difference at every expansion interval. |
| Limit |
number |
Once the total difference reaches this value, expansion stops. Optional. |
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
LinearTeamSizeBalanceRuleExpansion
| Name | Type | Description |
|---|---|---|
| Delta |
number |
This value gets added to Difference at every expansion interval. |
| Limit |
number |
Once the total difference reaches this value, expansion stops. Optional. |
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
ListMatchmakingQueuesRequest
Gets a list of all the matchmaking queue configurations for the title.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
ListMatchmakingQueuesResult
| Name | Type | Description |
|---|---|---|
| MatchMakingQueues |
The list of matchmaking queue configs for this title. |
MatchmakingQueueConfig
| Name | Type | Description |
|---|---|---|
| BuildAliasParams |
This is the buildAlias that will be used to allocate the multiplayer server for the match. |
|
| BuildId |
string |
This is the buildId that will be used to allocate the multiplayer server for the match. |
| DifferenceRules |
List of difference rules used to find an optimal match. |
|
| MatchTotalRules |
List of match total rules used to find an optimal match. |
|
| MaxMatchSize |
number |
Maximum number of players in a match. |
| MaxTicketSize |
number |
Maximum number of players in a ticket. Optional. |
| MinMatchSize |
number |
Minimum number of players in a match. |
| Name |
string |
Unique identifier for a Queue. Chosen by the developer. |
| RegionSelectionRule |
Region selection rule used to find an optimal match. |
|
| ServerAllocationEnabled |
boolean |
Boolean flag to enable server allocation for the queue. |
| SetIntersectionRules |
List of set intersection rules used to find an optimal match. |
|
| StatisticsVisibilityToPlayers |
Controls which statistics are visible to players. |
|
| StringEqualityRules |
List of string equality rules used to find an optimal match. |
|
| TeamDifferenceRules |
List of team difference rules used to find an optimal match. |
|
| TeamSizeBalanceRule |
Team size balance rule used to find an optimal match. |
|
| TeamTicketSizeSimilarityRule |
Team ticket size similarity rule used to find an optimal match. |
|
| Teams |
The team configuration for a match. This may be null if there are no teams. |
MatchmakingQueueTeam
| Name | Type | Description |
|---|---|---|
| MaxTeamSize |
number |
The maximum number of players required for the team. |
| MinTeamSize |
number |
The minimum number of players required for the team. |
| Name |
string |
A name to identify the team. This is case insensitive. |
MatchTotalRule
| Name | Type | Description |
|---|---|---|
| Attribute |
Description of the attribute used by this rule to match tickets. |
|
| Expansion |
Collection of fields relating to expanding this rule at set intervals. |
|
| Max |
number |
The maximum total value for a group. Must be >= Min. |
| Min |
number |
The minimum total value for a group. Must be >=2. |
| Name |
string |
Friendly name chosen by developer. |
| SecondsUntilOptional |
number |
How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be prioritized over those that don't). Leave blank if this rule is always enforced. |
| Weight |
number |
The relative weight of this rule compared to others. |
MatchTotalRuleExpansion
| Name | Type | Description |
|---|---|---|
| MaxOverrides |
Manually specify the values to use for each expansion interval. When this is set, Max is ignored. |
|
| MinOverrides |
Manually specify the values to use for each expansion interval. When this is set, Min is ignored. |
|
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
OverrideDouble
| Name | Type | Description |
|---|---|---|
| Value |
number |
The custom expansion value. |
OverrideUnsignedInt
| Name | Type | Description |
|---|---|---|
| Value |
number |
The custom expansion value. |
QueueRuleAttribute
| Name | Type | Description |
|---|---|---|
| Path |
string |
Specifies which attribute in a ticket to use. |
| Source |
Specifies which source the attribute comes from. |
RegionSelectionRule
| Name | Type | Description |
|---|---|---|
| CustomExpansion |
Controls how the Max Latency parameter expands over time. Only one expansion can be set per rule. When this is set, MaxLatency is ignored. |
|
| LinearExpansion |
Controls how the Max Latency parameter expands over time. Only one expansion can be set per rule. |
|
| MaxLatency |
number |
Specifies the maximum latency that is allowed between the client and the selected server. The value is in milliseconds. |
| Name |
string |
Friendly name chosen by developer. |
| Path |
string |
Specifies which attribute in a ticket to use. |
| SecondsUntilOptional |
number |
How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be prioritized over those that don't). Leave blank if this rule is always enforced. |
| Weight |
number |
The relative weight of this rule compared to others. |
SetIntersectionRule
| Name | Type | Description |
|---|---|---|
| Attribute |
Description of the attribute used by this rule to match tickets. |
|
| AttributeNotSpecifiedBehavior |
Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity profile. |
|
| CustomExpansion |
Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. When this is set, MinIntersectionSize is ignored. |
|
| DefaultAttributeValue |
string[] |
The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that AttributeNotSpecifiedBehavior is UseDefault). Values must be unique. |
| LinearExpansion |
Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. |
|
| MinIntersectionSize |
number |
The minimum number of values that must match between sets. |
| Name |
string |
Friendly name chosen by developer. |
| SecondsUntilOptional |
number |
How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be prioritized over those that don't). Leave blank if this rule is always enforced. |
| Weight |
number |
The relative weight of this rule compared to others. |
StatisticsVisibilityToPlayers
| Name | Type | Description |
|---|---|---|
| ShowNumberOfPlayersMatching |
boolean |
Whether to allow players to view the current number of players in the matchmaking queue. |
| ShowTimeToMatch |
boolean |
Whether to allow players to view statistics representing the time it takes for tickets to find a match. |
StringEqualityRule
| Name | Type | Description |
|---|---|---|
| Attribute |
Description of the attribute used by this rule to match tickets. |
|
| AttributeNotSpecifiedBehavior |
Describes the behavior when an attribute is not specified in the ticket creation request or in the user's entity profile. |
|
| DefaultAttributeValue |
string |
The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that AttributeNotSpecifiedBehavior is false). |
| Expansion |
Collection of fields relating to expanding this rule at set intervals. For StringEqualityRules, this is limited to turning the rule off or on during different intervals. |
|
| Name |
string |
Friendly name chosen by developer. |
| SecondsUntilOptional |
number |
How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be prioritized over those that don't). Leave blank if this rule is always enforced. |
| Weight |
number |
The relative weight of this rule compared to others. |
StringEqualityRuleExpansion
| Name | Type | Description |
|---|---|---|
| EnabledOverrides |
boolean[] |
List of bools specifying whether the rule is applied during this expansion. |
| SecondsBetweenExpansions |
number |
How many seconds before this rule is expanded. |
TeamDifferenceRule
| Name | Type | Description |
|---|---|---|
| Attribute |
Description of the attribute used by this rule to match teams. |
|
| CustomExpansion |
Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. When this is set, Difference is ignored. |
|
| DefaultAttributeValue |
number |
The default value assigned to tickets that are missing the attribute specified by AttributePath (assuming that AttributeNotSpecifiedBehavior is false). |
| Difference |
number |
The allowed difference between any two teams at the start of matchmaking. |
| LinearExpansion |
Collection of fields relating to expanding this rule at set intervals. Only one expansion can be set per rule. |
|
| Name |
string |
Friendly name chosen by developer. |
| SecondsUntilOptional |
number |
How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be prioritized over those that don't). Leave blank if this rule is always enforced. |
TeamSizeBalanceRule
| Name | Type | Description |
|---|---|---|
| CustomExpansion |
Controls how the Difference parameter expands over time. Only one expansion can be set per rule. When this is set, Difference is ignored. |
|
| Difference |
number |
The allowed difference in team size between any two teams. |
| LinearExpansion |
Controls how the Difference parameter expands over time. Only one expansion can be set per rule. |
|
| Name |
string |
Friendly name chosen by developer. |
| SecondsUntilOptional |
number |
How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be prioritized over those that don't). Leave blank if this rule is always enforced. |
TeamTicketSizeSimilarityRule
| Name | Type | Description |
|---|---|---|
| Name |
string |
Friendly name chosen by developer. |
| SecondsUntilOptional |
number |
How many seconds before this rule is no longer enforced (but tickets that comply with this rule will still be prioritized over those that don't). Leave blank if this rule is always enforced. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for