*Bu içerik, yapay zekâ (beta) kullanılarak çevrildi ve hatalar içerebilir. Sayfayı İngilizce görüntülemek için buraya tıkla.

UserRestriction

Bir kullanıcı üzerinde bir kısıtlama temsil eder.

  • KAYNAK YOLLARI
  • /cloud/v2/universes/{universe_id}/user-restrictions
  • /cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Nitelikler

pathstring

Kullanıcı kısıtlamasının kaynak yolu.

Formlar:

  • universes/{universe_id}/user-restrictions/{user_restriction_id}
  • universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}.
updateTimestring
Yalnızca Çıkış

Kullanıcı kısıtlaması son olarak güncellendiğindeki zaman damgası. Bu dizi Timestamp olarak biçimlendirilmiş.

userstring
Yalnızca Çıkış

Etkilenen kullanıcı.

gameJoinRestrictionobject

Kullanıcı ebeveyn evrenden veya dünyayasaklanır.

Taban URL
https://apis.roblox.com
UserRestriction Kaynağı
{

  "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

Evren veya belirli bir dünyayasaklanmış kullanıcılar için kullanıcı kısıtlamalarını listeleyin.

Kapsamlar
universe.user-restriction:read
TalepYol Parametreleri
universe_idstring
Gerekli

Evren kimliği.

Sorgu Parametreleri
maxPageSizenumber

Geri dönüş için maksimum kullanıcı sınırı.Hizmet bu değerden daha azını iade edebilir.Belirtilmediğinde, en fazla 10 kullanıcı sınırı döndürülür.Maksimum değer 100'dür ve daha yüksek değerler 100 olarak ayarlanır.

pageTokenstring

Bir önceki çağrıdan alınan bir sayfa jetonu, sonraki bir sayfa almak için.

Sayfa numaralandırırken, sonraki çağrıya verilen tüm diğer parametler, sayfa jetonu sağlayan çağrıya eşleşmelidir.

Yanıt

Ebeveyn koleksiyonundaki Kullanıcı Sınırları listesi.

userRestrictionsarray<UserRestriction>

Belirtilen Evren veya Yerden Gelen Kullanıcı Sınırları.

nextPageTokenstring

Bir sonraki sayfayı almak için bir pageToken çözümleyici olarak gönderebileceğiniz bir jeton. Bu alan atlanırsa, sonraki sayfalar yoktur.

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}'
Yanıt
{

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

Kullanıcı kısıtlamasını alın.

Kapsamlar
universe.user-restriction:read
TalepYol Parametreleri
universe_idstring
Gerekli

Evren kimliği.

user_restriction_idstring
Gerekli

Kullanıcı kısıtımı ID'si.

YanıtUserRestriction
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}'
Yanıt
{

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

Kullanıcı kısıtlamasını güncelle.

Kapsamlar
universe.user-restriction:write
TalepYol Parametreleri
universe_idstring
Gerekli

Evren kimliği.

user_restriction_idstring
Gerekli

Kullanıcı kısıtımı ID'si.

Sorgu Parametreleri
updateMaskstring

Güncellenmesi gereken alanların güncelle.

game_join_restriction alan atomik olarak güncellenmelidir; game_join_restriction (örneğin "game_join_restriction.active") indekslenen alan maskeleri desteklenmez. Bu dizi FieldMask olarak biçimlendirilmiş.

idempotencyKey.keystring

Tek kullanımlık kimlik için kullanılacak benzersiz anahtar.

idempotencyKey.firstSentstring

İlk istek gönderildiğindeki zaman damgası.

Eğer bu, idempotans anahtarının ömüründen daha uzaksa (ki bu annotasyonlu minimum ömür sınırını aşabilir), sunucu bir hata dönmelidir. Bu dizi Timestamp olarak biçimlendirilmiş.

Talep GövdesiUserRestriction
YanıtUserRestriction
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

  }

}'
Yanıt
{

  "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

Verilen evren içindeki Kullanıcı Sınırı kaynaklarındaki değişiklikleri listeleyin. Bu, hem evren seviyesi hem de yer seviyesi sınırlarını içerir.

Evren seviyesi sınırlama günlükleri için, place alanı boş olacaktır.

Kapsamlar
universe.user-restriction:read
TalepYol Parametreleri
universe_idstring
Gerekli

Evren kimliği.

Sorgu Parametreleri
maxPageSizenumber

Geri dönmesi gereken KullanıcıKısıtımGünlüğü maksimum sayısı.Hizmet bu değerden daha azını iade edebilir.Belirtilmediğinde, en fazla 10 Kullanıcı Sınırlama Günlüğü döndürülür.Maksimum değer 100'dür ve daha yüksek değerler 100 olarak ayarlanır.

pageTokenstring

Bir önceki çağrıdan alınan bir sayfa jetonu, sonraki bir sayfa almak için.

Sayfa numaralandırırken, sonraki çağrıya verilen tüm diğer parametler, sayfa jetonu sağlayan çağrıya eşleşmelidir.

filterstring

Bu alan, döndürülen günlükleri filtrelemek için ayarlanabilir.

filter alanı çok az sayıda CEL'i destekler:

  • user
  • place
  • == karşılaştırma işleci mevcuttur.
  • && mantık operatörü de desteklenir.

Örnek olarak, bir kullanıcı ve bir yer için filtreleme şeklini alır filter="user == 'users/123'" && "place == 'places/456'".

Yanıt

Kullanıcı Kısıtlaması kaynaklarına uygulanan değişiklik günlüğü listesini döndürür.

logsarray<object>

Belirtilen Evren'den Kullanıcı Sınırlama Günlükleri.

nextPageTokenstring

Bir sonraki sayfayı almak için bir pageToken çözümleyici olarak gönderebileceğiniz bir jeton. Bu alan atlanırsa, sonraki sayfalar yoktur.

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}'
Yanıt
{

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

}