*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

UserRestriction

Đại diện cho một hạn chế đối với một người dùng.

  • ĐƯỜNG DẪN TÀI NGUYÊN
  • /cloud/v2/universes/{universe_id}/user-restrictions
  • /cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Thuộc Tính

pathstring

Con đường tài nguyên của hạn chế người dùng.

Định dạng:

  • universes/{universe_id}/user-restrictions/{user_restriction_id}
  • universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}.
updateTimestring
Chỉ Xuất

Thời gian chỉnh sửa lần cuối khi hạn chế người dùng được cập nhật. Chuỗi này được định dạng là Dấu thời gian.

userstring
Chỉ Xuất

Người dùng bị ảnh hưởng.

gameJoinRestrictionobject

Người dùng bị cấm khỏi vũ trụ hoặc địa điểmcha mẹ.

URL Cơ Sở
https://apis.roblox.com
Tài nguyên 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
Bản Beta

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

Danh sách hạn chế người dùng cho người dùng đã bị cấm bất kỳ ở vũ trụ hay một địa điểmcụ thể nào.

Phạm Vi
universe.user-restriction:read
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

Tham Số Truy Vấn
maxPageSizenumber

Số lượng hạn chế người dùng tối đa để trả lại.Dịch vụ có thể trả về ít hơn giá trị này.Nếu không được xác định, tối đa 10 hạn chế người dùng được trả về.Giá trị tối đa là 100 và giá trị cao hơn được đặt thành 100.

pageTokenstring

Một token trang, nhận từ cuộc gọi trước, để lấy lại trang tiếp theo.

Khi paginate, tất cả các tham số khác được cung cấp cho cuộc gọi tiếp theo phải phù hợp với cuộc gọi cung cấp token trang.

Phản Hồi

Một danh sách các Giới hạn người dùng trong bộ sưu tập cha.

userRestrictionsarray<UserRestriction>

Các hạn chế người dùng từ Vũ trụ hoặc Địa điểm được chỉ định.

nextPageTokenstring

Một token mà bạn có thể gửi như một tham số pageToken để lấy trang tiếp theo. Nếu trường này bị bỏ qua, không có trang tiếp theo.

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}'
Phản Hồi
{

  "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
Bản Beta

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

Nhận hạn chế người dùng.

Phạm Vi
universe.user-restriction:read
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

user_restriction_idstring
Bắt Buộc

ID hạn chế người dùng.

Phản HồiUserRestriction
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}'
Phản Hồi
{

  "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
Bản Beta

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

Cập nhật hạn chế người dùng.

Phạm Vi
universe.user-restriction:write
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

user_restriction_idstring
Bắt Buộc

ID hạn chế người dùng.

Tham Số Truy Vấn
updateMaskstring

Danh sách các trường để cập nhật.

Trường game_join_restriction phải được cập nhật theo nguyên tử; các mặt nạ trường được chỉ mục vào game_join_restriction (như "game_join_restriction.active" ) không được hỗ trợ. Chuỗi này được định dạng là Mặt nạ trường.

idempotencyKey.keystring

Chìa khóa duy nhất để sử dụng cho idempotency.

idempotencyKey.firstSentstring

Thời gian chính xác mà yêu cầu đầu tiên được khoản

Nếu điều này xảy ra trong quá khứ hơn tuổi thọ của chìa khóa idempotency (mà có thể vượt quá tuổi thọ tối thiểu được ghi chú), máy chủ phải trả lại một lỗi. Chuỗi này được định dạng là Dấu thời gian.

Yêu Cầu Cơ ThểUserRestriction
Phản HồiUserRestriction
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

  }

}'
Phản Hồi
{

  "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
Bản Beta

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

Danh sách các thay đổi đối với tài nguyên Giới hạn người dùng trong một vũ trụ nhất định. Điều này bao gồm cả giới hạn cấp vũ trụ và cấp nơi.

Đối với nhật ký hạn chế cấp vũ trụ, trường place sẽ trống.

Phạm Vi
universe.user-restriction:read
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

Tham Số Truy Vấn
maxPageSizenumber

Số tối đa các UserRestrictionLogs để trả về.Dịch vụ có thể trả về ít hơn giá trị này.Nếu không được xác định, tối đa 10 UserRestrictionLogs được trả về.Giá trị tối đa là 100 và giá trị cao hơn được đặt thành 100.

pageTokenstring

Một token trang, nhận từ cuộc gọi trước, để lấy lại trang tiếp theo.

Khi paginate, tất cả các tham số khác được cung cấp cho cuộc gọi tiếp theo phải phù hợp với cuộc gọi cung cấp token trang.

filterstring

Trường này có thể được đặt để lọc các nhật ký được trả về.

Trường filter hỗ trợ rất ít số CEL:

  • user
  • place
  • Nhà so sánh == có sẵn.
  • Người vận hành logic && cũng được hỗ trợ.

Ví dụ, lọc cho một người dùng và một nơi có dạng filter="user == 'users/123'" && "place == 'places/456'".

Phản Hồi

Trả về một danh sách các bản ghi thay đổi áp dụng cho tài nguyên UserRestriction.

logsarray<object>

Các nhật ký hạn chế người dùng từ vũ trụ được chỉ định.

nextPageTokenstring

Một token mà bạn có thể gửi như một tham số pageToken để lấy trang tiếp theo. Nếu trường này bị bỏ qua, không có trang tiếp theo.

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}'
Phản Hồi
{

  "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"

}