특정 타이틀을 플레이하는 사용자의 활동을 설정하거나 업데이트합니다.
이 API를 사용하면 게임 클라이언트 또는 서버가 특정 타이틀을 플레이하는 사용자에 대한 멀티 플레이어 활동을 설정/업데이트할 수 있습니다. 사용자가 멀티 플레이어 활동에서 활성화되는 즉시 활동을 설정해야 합니다. Xbox Live 사용자는 다른 사용자(일반적으로 친구)의 활동 변경 내용을 구독할 수 있으며 이러한 업데이트는 RTA를 통해 Xbox 클라이언트에 푸시됩니다.
PUT /titles/{titleId}/users/{xuid}/activities
URI 매개 변수
| 매개 변수 |
그런 다음 |
필수 |
유형 |
설명 |
| titleId |
path |
TRUE |
정수 |
요청이 전송되는 게임의 titleId입니다. |
| xuid |
path |
TRUE |
문자열 |
현재 요청에서 참조되는 사용자의 XUID입니다. XUID는 밑이 10인 정수로 표시됩니다. |
| 이름 |
필수 |
유형 |
설명 |
| Authorization |
TRUE |
정수 |
호출자는 XBL 3.0 인증 형식으로 XToken을 제공해야 합니다. 예를 들어 권한 부여: XBL3.0 x=2553948354698;<암호화된 토큰>) |
| 콘텐츠 종류 |
TRUE |
문자열 |
ContentType을 application/json으로 설정해야 합니다. |
요청 본문
| 이름 |
필수 |
유형 |
설명 |
| connectionString |
TRUE |
문자열 |
연결 문자열은 게임에 참여하기 위해 연결하는 클라이언트에 전달되는 개체입니다. 연결 문자열에는 일반적으로 참여하는 사용자가 연결할 수 있도록 하는 서버 IP와 같은 정보가 포함됩니다. 연결 문자열의 길이는 512자로 제한됩니다. |
| joinRestriction |
TRUE |
JoinRestriction |
현재 플레이어에 참가할 수 있는 사용자를 활성화하는 설정입니다. |
| sequenceNumber |
TRUE |
문자열 |
이것은 클라이언트가 각 요청에 대해 전달해야 하는 단조 증가 숫자(ulong)의 문자열 표현입니다. 활동에 대한 업데이트의 순서를 보장하는 데 사용됩니다. sequenceNumber의 좋은 예는 증가하는 것이 보장되기 때문에 클라이언트의 유닉스 시간이 될 수 있습니다. 0보다 커야 하며 최대 ulong보다 클 수 없습니다. |
| currentPlayers |
|
정수 |
멀티 플레이어 활동에서 사용자와 함께 이미 플레이 중인 플레이어의 수입니다. |
| groupId |
|
문자열 |
동일한 게임의 일부로 플레이하는 모든 사용자를 그룹화하는 고유 식별자입니다. |
| maxPlayers |
|
정수 |
현재 활동에서 이 플레이어와 함께 플레이할 수 있는 최대 플레이어 수입니다. |
| 플랫폼 |
|
플랫폼 |
|
응답
| 이름 |
유형 |
설명 |
| 204 콘텐츠 없음 |
|
활동을 설정했습니다. |
| 400 잘못된 요청 |
ErrorResponse |
요청을 처리하는 동안 오류가 발생했습니다. 가능한 오류 코드: " RequestValidationError: 요청 유효성 검사에 실패했습니다.", " AuthorizationError: 호출자가 리소스에 액세스할 수 없습니다. 요청이 너무 많습니다. “ |
| 기타 상태 코드 |
ThrottledEntity |
요청이 너무 많습니다. 헤더 Retry-After: 정수 |
용어 정의
ErrorResponse
| 이름 |
유형 |
설명 |
| 디버그 메시지 |
문자열 |
디버깅에 사용할 수 있는 오류 메시지의 사람이 읽을 수 있는 버전입니다. |
| errorCode |
문자열 |
오류 코드 열거형. |
JoinRestriction
현재 플레이어에 참가할 수 있는 사용자를 활성화하는 설정입니다.
| 이름 |
유형 |
설명 |
| Followed |
문자열 |
|
| InviteOnly |
문자열 |
|
| 공개 |
문자열 |
|
| 이름 |
유형 |
설명 |
| Android |
문자열 |
|
| iOS |
문자열 |
|
| 닌텐도 |
문자열 |
|
| PlayStation |
문자열 |
|
| Scarlett |
문자열 |
|
| Win32 |
문자열 |
|
| WindowsOneCore |
문자열 |
|
| XboxOne |
문자열 |
|
SetActivityRequest
활동에 대한 플랫폼이 요청 내에서 설정된 경우 해당 플랫폼에서만 조인할 수 있습니다. 플랫폼이 설정되지 않으면 게임을 플레이할 수 있는 모든 플랫폼에서 활동을 참가할 수 있습니다.
| 이름 |
유형 |
설명 |
| connectionString |
문자열 |
연결 문자열은 게임에 참여하기 위해 연결하는 클라이언트에 전달되는 개체입니다. 연결 문자열에는 일반적으로 참여하는 사용자가 연결할 수 있도록 하는 서버 IP와 같은 정보가 포함됩니다. 연결 문자열의 길이는 512자로 제한됩니다. |
| currentPlayers |
정수 |
멀티 플레이어 활동에서 사용자와 함께 이미 플레이 중인 플레이어의 수입니다. |
| groupId |
문자열 |
동일한 게임의 일부로 플레이하는 모든 사용자를 그룹화하는 고유 식별자입니다. |
| joinRestriction |
JoinRestriction |
현재 플레이어에 참가할 수 있는 사용자를 활성화하는 설정입니다. |
| maxPlayers |
정수 |
현재 활동에서 이 플레이어와 함께 플레이할 수 있는 최대 플레이어 수입니다. |
| 플랫폼 |
플랫폼 |
|
| sequenceNumber |
문자열 |
이것은 클라이언트가 각 요청에 대해 전달해야 하는 단조 증가 숫자(ulong)의 문자열 표현입니다. 활동에 대한 업데이트의 순서를 보장하는 데 사용됩니다. sequenceNumber의 좋은 예는 증가하는 것이 보장되기 때문에 클라이언트의 유닉스 시간이 될 수 있습니다. 0보다 커야 하며 최대 ulong보다 클 수 없습니다. |
ThrottledEntity
| 이름 |
유형 |
설명 |
| currentRequests |
문자열 |
현재 요청 수 - 동시성 또는 속도입니다. |
| 디버그 메시지 |
문자열 |
디버깅에 사용할 수 있는 스로틀 메시지의 사람이 읽을 수 있는 버전입니다. |
| 제한 유형 |
문자열 |
제한 유형, 즉 동시성 또는 비율입니다. |
| maxRequests |
문자열 |
허용되는 최대 요청 수 - 동시성 또는 속도. |
| periodInSeconds |
문자열 |
속도 또는 동시성 제한이 초과될 때 적용되는 기간(초)입니다. |
| version |
문자열 |
현재 스로틀 계약 버전입니다. |