*Konten ini diterjemahkan menggunakan AI (Beta) dan mungkin mengandung kesalahan. Untuk melihat halaman ini dalam bahasa Inggris, klik di sini.

UserRestriction

Mewakili batasan pada pengguna.

  • JALUR RESOURCE
  • /cloud/v2/universes/{universe_id}/user-restrictions
  • /cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Atribut

pathstring

Jalur sumber daya dari batasan pengguna.

Format:

  • universes/{universe_id}/user-restrictions/{user_restriction_id}
  • universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}.
updateTimestring
Hanya Output

Stempel waktu ketika batasan pengguna terakhir diperbarui. String ini diformat sebagai Timestamp.

userstring
Hanya Output

Pengguna terpengaruh.

gameJoinRestrictionobject

Pengguna dilarang dari alam semesta atau tempat orang tua.

Base URL
https://apis.roblox.com
Resource 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
Beta

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

Daftar batasan pengguna untuk pengguna yang pernah dilarang di alam semesta atau tempat tertentu.

Cakupan
universe.user-restriction:read
PermintaanParameter Jalur
universe_idstring
Diperlukan

ID alam semesta.

Parameter Kueri
maxPageSizenumber

Jumlah batasan pengguna maksimum untuk dikembalikan.Layanan mungkin kembali kurang dari nilai ini.Jika tidak ditentukan, paling banyak 10 batasan pengguna dikembalikan.Nilai maksimum adalah 100 dan nilai yang lebih tinggi ditetapkan ke 100.

pageTokenstring

Token halaman, diterima dari panggilan sebelumnya, untuk mengambil halaman berikutnya.

Saat paginasi, semua parameter lain yang disediakan untuk panggilan berikutnya harus cocok dengan panggilan yang memberikan token halaman.

Respons

Daftar Batasan Pengguna di koleksi orangtua.

userRestrictionsarray<UserRestriction>

Keterbatasan Pengguna dari alam semesta atau tempat yang ditentukan.

nextPageTokenstring

Token yang dapat Anda kirim sebagai parameter pageToken untuk mengambil halaman berikutnya. Jika bidang ini diabaikan, tidak ada halaman berikutnya.

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}'
Respons
{

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

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

Dapatkan batasan pengguna.

Cakupan
universe.user-restriction:read
PermintaanParameter Jalur
universe_idstring
Diperlukan

ID alam semesta.

user_restriction_idstring
Diperlukan

ID batasan pengguna.

ResponsUserRestriction
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}'
Respons
{

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

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

Perbarui batasan pengguna.

Cakupan
universe.user-restriction:write
PermintaanParameter Jalur
universe_idstring
Diperlukan

ID alam semesta.

user_restriction_idstring
Diperlukan

ID batasan pengguna.

Parameter Kueri
updateMaskstring

Daftar bidang untuk update.

Bidang game_join_restriction harus diperbarui secara atomik; topeng bidang yang indeks ke game_join_restriction (seperti "game_join_restriction.active" ) tidak didukung. String ini diformat sebagai FieldMask.

idempotencyKey.keystring

Kunci unik yang harus digunakan untuk idempotensi.

idempotencyKey.firstSentstring

戳 waktu di mana permintaan pertama dikirim.

Jika ini lebih jauh ke masa lalu daripada masa hidup kunci idempotensi (yang mungkin melebihi masa hidup minimum yang ditandai), server harus mengembalikan kesalahan. String ini diformat sebagai Timestamp.

Request BodyUserRestriction
ResponsUserRestriction
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

  }

}'
Respons
{

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

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

Daftar perubahan pada sumber daya Pembatasan Pengguna dalam alam semesta tertentu. Ini termasuk batasan tingkat alam semesta dan tingkat tempat.

Untuk log batasan tingkat alam semesta, bidang place akan kosong.

Cakupan
universe.user-restriction:read
PermintaanParameter Jalur
universe_idstring
Diperlukan

ID alam semesta.

Parameter Kueri
maxPageSizenumber

Jumlah maksimum UserRestrictionLogs untuk dikembalikan.Layanan dapat kembali kurang dari nilai ini.Jika tidak ditentukan, paling banyak 10 UserRestrictionLogs dikembalikan.Nilai maksimum adalah 100 dan nilai yang lebih tinggi ditetapkan ke 100.

pageTokenstring

Token halaman, diterima dari panggilan sebelumnya, untuk mengambil halaman berikutnya.

Saat paginasi, semua parameter lain yang disediakan untuk panggilan berikutnya harus cocok dengan panggilan yang memberikan token halaman.

filterstring

Bidang ini dapat ditetapkan untuk menyaring log yang dikembalikan.

Bidang filter mendukung jumlah CEL yang sangat kecil:

  • user
  • place
  • Operator perbandingan == tersedia.
  • Operator logis && juga didukung.

Sebagai contoh, penyaringan untuk pengguna dan tempat mengambil bentuk filter="user == 'users/123'" && "place == 'places/456'".

Respons

Kembalikan daftar log perubahan yang diterapkan pada sumber daya Pembatasan Pengguna.

logsarray<object>

Log Pembatasan Pengguna dari Univers yang ditentukan.

nextPageTokenstring

Token yang dapat Anda kirim sebagai parameter pageToken untuk mengambil halaman berikutnya. Jika bidang ini diabaikan, tidak ada halaman berikutnya.

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}'
Respons
{

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

}