활동 배치 가져오기

사용자 목록에 대한 멀티 플레이어 활동 배치를 가져옵니다.

이 API를 사용하면 클라이언트와 서비스가 사용자 목록에 대한 일련의 활동을 가져올 수 있습니다.

이 API는 부분적인 결과를 반환할 수 있습니다. 주어진 사용자는 완전한 활동 세트를 갖지만 일부 사용자는 활동이 전혀 없을 수 있습니다. 사용자의 하위 집합에 대한 활동을 찾은 경우 해당 활동을 반환합니다. 활동을 찾을 수 없는 사용자의 경우 해당 사용자에 대한 빈 목록을 반환합니다. 내부 오류로 인해 활동을 가져올 수 없는 사용자의 경우 해당 사용자에 대해 null을 반환합니다. 클라이언트는 호출을 다시 시도해야 합니다. 간단히 말해서, 사용자는 활동 목록, 빈 목록 또는 Null을 가질 수 있습니다.

POST /titles/{titleId}/activities/query

URI 매개 변수

매개 변수	그런 다음	필수	유형	설명
titleId	path	TRUE	정수	요청이 전송되는 게임의 titleId입니다.

요청 본문

이름	필수	유형	설명
users	TRUE	string[]	활동 정보를 검색해야 하는 사용자의 ID입니다. 최대 30명의 사용자가 지원됩니다.

요청 헤더

이름	필수	유형	설명
Authorization	TRUE	정수	호출자는 XBL 3.0 인증 형식으로 XToken을 제공해야 합니다. 예를 들어 권한 부여: XBL3.0 x=2553948354698;>암호화된 토큰<)
콘텐츠 종류	TRUE	문자열	ContentType을 application/json으로 설정해야 합니다.

응답

이름	유형	설명
200 OK	GetActivityBatchResponse	반환 개체에는 각 사용자의 활동 목록이 포함됩니다. 사용자에게 현재 활동이 없으면 해당 사용자의 활동 목록이 비어 있습니다. 사용자의 활동을 가져오는 서비스 문제가 있는 경우 해당 사용자의 활동 목록은 Null이 됩니다.
400 잘못된 요청	ErrorResponse	요청을 처리하는 동안 오류가 발생했습니다. 가능한 오류 코드: "InvalidRequest - 요청 페이로드가 잘못되었습니다.", " AuthorizationError: 호출자가 리소스에 액세스할 수 없습니다."
기타 상태 코드	ThrottledEntity	요청이 너무 많습니다. 헤더 Retry-After: 정수

용어 정의

• ErrorResponse
• GetActivityBatchRequest
• GetActivityBatchResponse
• GetActivityResponse
• JoinRestriction
• 플랫폼
• ThrottledEntity
• 사용자 활동

ErrorResponse

이름	유형	설명
디버그 메시지	문자열	디버깅에 사용할 수 있는 오류 메시지의 사람이 읽을 수 있는 버전입니다.
errorCode	문자열	오류 코드 열거형.

GetActivityBatchRequest

이름	유형	설명
users	string[]	활동 정보를 검색해야 하는 사용자의 ID입니다. 최대 30명의 사용자가 지원됩니다.

GetActivityBatchResponse

이름	유형	설명
사용자 활동	사용자 활동[]

GetActivityResponse

이름	유형	설명
connectionString	문자열	연결 문자열은 게임에 참여하기 위해 연결하는 클라이언트에 전달되는 개체입니다. 연결 문자열에는 일반적으로 참여하는 사용자가 연결할 수 있도록 하는 서버 IP와 같은 정보가 포함됩니다. 연결 문자열의 길이는 512자로 제한됩니다.
currentPlayers	정수	멀티 플레이어 활동에서 사용자와 함께 이미 플레이 중인 플레이어의 수입니다.
groupId	문자열	동일한 게임의 일부로 플레이하는 모든 사용자를 그룹화하는 고유 식별자입니다.
joinRestriction	JoinRestriction	현재 플레이어에 참가할 수 있는 사용자를 활성화하는 설정입니다.
maxPlayers	정수	현재 활동에서 이 플레이어와 함께 플레이할 수 있는 최대 플레이어 수입니다.
플랫폼	플랫폼
sequenceNumber	문자열	이것은 클라이언트가 각 요청에 대해 전달해야 하는 단조 증가 숫자(ulong)의 문자열 표현입니다. 활동에 대한 업데이트의 순서를 보장하는 데 사용됩니다. sequenceNumber의 좋은 예는 증가하는 것이 보장되기 때문에 클라이언트의 유닉스 시간이 될 수 있습니다. 0보다 커야 하며 최대 ulong보다 클 수 없습니다.
titleId	정수	활동이 요청된 게임의 titleId입니다.

JoinRestriction

이름	유형	설명
Followed	문자열
InviteOnly	문자열
공개	문자열

플랫폼

이름	유형	설명
Android	문자열
iOS	문자열
닌텐도	문자열
PlayStation	문자열
Scarlett	문자열
Win32	문자열
WindowsOneCore	문자열
XboxOne	문자열

ThrottledEntity

이름	유형	설명
currentRequests	문자열	현재 요청 수 - 동시성 또는 속도입니다.
디버그 메시지	문자열	디버깅에 사용할 수 있는 스로틀 메시지의 사람이 읽을 수 있는 버전입니다.
제한 유형	문자열	제한 유형, 즉 동시성 또는 비율입니다.
maxRequests	문자열	허용되는 최대 요청 수 - 동시성 또는 속도.
periodInSeconds	문자열	속도 또는 동시성 제한이 초과될 때 적용되는 기간(초)입니다.
version	문자열	현재 스로틀 계약 버전입니다.

사용자 활동

이름	유형	설명
작업	GetActivityResponse[]
userId	문자열