*このコンテンツは、ベータ版の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。.

レスポンスUserRestriction

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") にインデックス付けされるフィールドマスクはサポートされません。. この文字列は Timestamp としてフォーマットされています。

idempotencyKey.keystring

非同期性を使用する唯一のキー。.

idempotencyKey.firstSentstring

最初のリクエストが送信されたタイムスタンプ。

これが idempotency キーの寿命よりも古い場合 (which は注釈された最小寿命を超える可能性があります)、サーバーは エラーを返す必要があります。. この文字列は Timestamp としてフォーマットされています。

リクエスト本文UserRestriction

レスポンス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>

指定された宇宙からのユーザー制限ログ。.

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

UserRestriction

属性

UserRestriction

List User Restrictionsベータ版

UserRestriction

Get User Restrictionベータ版

UserRestriction

Update User Restrictionベータ版

UserRestriction

List User Restriction Logsベータ版

List User Restrictions
ベータ版

Get User Restriction
ベータ版

Update User Restriction
ベータ版

List User Restriction Logs
ベータ版