*이 콘텐츠는 AI(베타)를 사용해 번역되었으며, 오류가 있을 수 있습니다. 이 페이지를 영어로 보려면 여기를 클릭하세요.

UserRestriction

사용자에 대한 제한을 나타냅니다.

  • 리소스 경로
  • /cloud/v2/universes/{universe_id}/user-restrictions
  • /cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

특성

pathstring

사용자 제한의 리소스 경로.

형식:

  • universes/{universe_id}/user-restrictions/{user_restriction_id}
  • universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}.
updateTimestring
출력 전용

사용자 제한이 마지막으로 업데이트된 시간戳. 이 문자열은 Timestamp 형식으로 지정됩니다.

userstring
출력 전용

영향을 받은 사용자.

gameJoinRestrictionobject

사용자가 부모 우주나 플레이스금지되었습니다.

기본 URL

https://apis.roblox.com
UserRestriction 리소스

{
"path": "universes/123/user-restrictions/123",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/156",
"gameJoinRestriction": {
"active": true,
"startTime": "2023-07-05T12:34:56Z",
"duration": "3s",
"privateReason": "some private reason",
"displayReason": "some display reason",
"excludeAltAccounts": true,
"inherited": true
}
}

UserRestriction

List User Restrictions
베타

GET /cloud/v2/universes/{universe_id}/user-restrictions

우주나 특정 플레이스금지된 적이 있는 사용자에 대한 사용자 제한 목록을 나열합니다.

범위
universe.user-restriction:read
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

쿼리 매개 변수
maxPageSizenumber

반환할 사용자 제한 최대 수.서비스는 이 값보다 적은 값을 반환할 수 있습니다.지정되지 않으면 최대 10개의 사용자 제한이 반환됩니다.최대 값은 100이며 더 높은 값은 100으로 설정됩니다.

pageTokenstring

이전 호출에서 받은 페이지 토큰으로, 이후 페이지를 검색합니다.

페이징할 때 후속 호출에 제공된 모든 다른 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

응답

부모 컬렉션의 사용자 제한 목록.

userRestrictionsarray<UserRestriction>

지정된 우주 또는 장소의 사용자 제한.

nextPageTokenstring

다음 페이지를 검색하기 위해 pageToken 매개변수로 보낼 수 있는 토큰입니다. 이 필드가 생략되면 후속 페이지가 없습니다.

GET /cloud/v2/universes/{universe_id}/user-restrictions

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/user-restrictions?maxPageSize=10&pageToken={string}' \
-H 'x-api-key: {your-api-key}'
응답

{
"userRestrictions": [
{
"path": "universes/123/user-restrictions/123",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/156",
"gameJoinRestriction": {
"active": true,
"startTime": "2023-07-05T12:34:56Z",
"duration": "3s",
"privateReason": "some private reason",
"displayReason": "some display reason",
"excludeAltAccounts": true,
"inherited": true
}
}
],
"nextPageToken": "string"
}

UserRestriction

Get User Restriction
베타

GET /cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}

사용자 제한 얻기.

범위
universe.user-restriction:read
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

user_restriction_idstring
필수

사용자 제한 ID.

GET /cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}' \
-H 'x-api-key: {your-api-key}'
응답

{
"path": "universes/123/user-restrictions/123",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/156",
"gameJoinRestriction": {
"active": true,
"startTime": "2023-07-05T12:34:56Z",
"duration": "3s",
"privateReason": "some private reason",
"displayReason": "some display reason",
"excludeAltAccounts": true,
"inherited": true
}
}

UserRestriction

Update User Restriction
베타

PATCH /cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}

사용자 제한 업데이트.

범위
universe.user-restriction:write
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

user_restriction_idstring
필수

사용자 제한 ID.

쿼리 매개 변수
updateMaskstring

업데이트할 필드 목록.

game_join_restriction 필드는 원자적으로 업데이트되어야 하며, game_join_restriction (예: "game_join_restriction.active")에 인덱싱되는 필드 마스크는 지원되지 않습니다. 이 문자열은 FieldMask 형식으로 지정됩니다.

idempotencyKey.keystring

무결성에 사용할 고유한 키입니다.

idempotencyKey.firstSentstring

첫 번째 요청이 전송된 타임스탬프.

이것이 idempotency 키의 수명보다 멀리 과거라면 (which 가 표시된 최소 수명을 초과할 수 있음) 서버는 오류를 반환해야 합니다. 이 문자열은 Timestamp 형식으로 지정됩니다.

요청 본문UserRestriction
PATCH /cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}?updateMask={string}&idempotencyKey.key={string}&idempotencyKey.firstSent={string}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"gameJoinRestriction": {
"active": true,
"duration": "3s",
"privateReason": "some private reason",
"displayReason": "some display reason",
"excludeAltAccounts": true
}
}'
응답

{
"path": "universes/123/user-restrictions/123",
"updateTime": "2023-07-05T12:34:56Z",
"user": "users/156",
"gameJoinRestriction": {
"active": true,
"startTime": "2023-07-05T12:34:56Z",
"duration": "3s",
"privateReason": "some private reason",
"displayReason": "some display reason",
"excludeAltAccounts": true,
"inherited": true
}
}

UserRestriction

List User Restriction Logs
베타

GET /cloud/v2/universes/{universe_id}/user-restrictions:listLogs

지정된 우주 내의 사용자 제한 리소스 변경 목록. 이에는 우주 수준과 장소 수준의 제한이 모두 포함됩니다.

우주 수준 제한 로그의 경우 place 필드가 비어 있습니다.

범위
universe.user-restriction:read
요청경로 매개 변수
universe_idstring
필수

유니버스 ID.

쿼리 매개 변수
maxPageSizenumber

반환할 사용자 제한 로그의 최대 수.서비스는 이 값보다 적은 값을 반환할 수 있습니다.지정되지 않으면 최대 10개의 사용자 제한 로그가 반환됩니다.최대 값은 100이며 더 높은 값은 100으로 설정됩니다.

pageTokenstring

이전 호출에서 받은 페이지 토큰으로, 이후 페이지를 검색합니다.

페이징할 때 후속 호출에 제공된 모든 다른 매개변수는 페이지 토큰을 제공한 호출과 일치해야 합니다.

filterstring

이 필드는 반환된 로그를 필터링하도록 설정할 수 있습니다.

filter 필드는 매우 작은 수의 CEL을 지원합니다:

  • user
  • place
  • 비교 연산자 ==)가 사용 가능합니다.
  • 논리 연산자 &&도 지원됩니다.

예를 들어, 사용자와 장소를 필터링하는 경우 형식이 filter="user == 'users/123'" && "place == 'places/456'".

응답

사용자 제한 리소스에 적용된 변경 로그 목록을 반환합니다.

logsarray<object>

지정된 우주의 UserRestrictionLogs.

nextPageTokenstring

다음 페이지를 검색하기 위해 pageToken 매개변수로 보낼 수 있는 토큰입니다. 이 필드가 생략되면 후속 페이지가 없습니다.

GET /cloud/v2/universes/{universe_id}/user-restrictions:listLogs

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/user-restrictions:listLogs?maxPageSize=10&pageToken={string}&filter={string}' \
-H 'x-api-key: {your-api-key}'
응답

{
"logs": [
{
"user": "users/156",
"place": "places/456",
"moderator": {
"robloxUser": "users/156"
},
"createTime": "2023-07-05T12:34:56Z",
"active": true,
"startTime": "2023-07-05T12:34:56Z",
"duration": "3s",
"privateReason": "some private reason",
"displayReason": "some display reason",
"restrictionType": {
"gameJoinRestriction": {}
},
"excludeAltAccounts": true
}
],
"nextPageToken": "string"
}