*Questo contenuto è tradotto usando AI (Beta) e potrebbe contenere errori. Per visualizzare questa pagina in inglese, clicca qui.

UserRestriction

Rappresenta una restrizione su un utente.

  • PERCORSI RISORSE
  • /cloud/v2/universes/{universe_id}/user-restrictions
  • /cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Attributi

pathstring

Il percorso delle risorse della restrizione dell'utente.

Formati:

  • universes/{universe_id}/user-restrictions/{user_restriction_id}
  • universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}.
updateTimestring
Solo output

L'timestamp quando l'esclusione dell'utente è stata aggiornata per l'ultima volta. Questa stringa è formattata come Timestamp.

userstring
Solo output

L'utente interessato.

gameJoinRestrictionobject

L'utente è bannato dall'universo o dal Postopadre.

URL di base
https://apis.roblox.com
Risorsa 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

Elenca le restrizioni dell'utente per gli utenti che sono stati mai bannati in un universo o in un Postospecifico.

Campi
universe.user-restriction:read
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

Parametri query
maxPageSizenumber

Il numero massimo di restrizioni utente da Riportare.Il servizio potrebbe restituire meno di questo valore.Se non specificato, vengono restituite al massimo 10 restrizioni utente.Il valore massimo è 100 e i valori più alti sono impostati su 100.

pageTokenstring

Un token di pagina, ricevuto da una chiamata precedente, per recuperare una pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti alla chiamata successiva devono corrispondere alla chiamata che ha fornito il token della pagina.

Risposta

Un elenco di restrizioni utente nella Collezionipadre.

userRestrictionsarray<UserRestriction>

Le restrizioni utente dall'universo o dal luogo specificato.

nextPageTokenstring

Un token che puoi inviare come parametro pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono pagine successive.

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

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

Ottieni la restrizione dell'utente.

Campi
universe.user-restriction:read
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

user_restriction_idstring
Necessario

L'ID di restrizione utente.

RispostaUserRestriction
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}'
Risposta
{

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

Aggiorna la restrizione dell'utente.

Campi
universe.user-restriction:write
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

user_restriction_idstring
Necessario

L'ID di restrizione utente.

Parametri query
updateMaskstring

L'elenco dei campi da Aggiornarmento.

Il campo game_join_restriction deve essere aggiornato atomically; le maschere di campo che indizzano in game_join_restriction (come "game_join_restriction.active" ) non sono supportate. Questa stringa è formattata come Timestamp.

idempotencyKey.keystring

La chiave unica da utilizzare per l'idempotenza.

idempotencyKey.firstSentstring

L'timestamp in cui è stata inviata la prima richiesta.

Se questo è più nel passato della durata della chiave di idempotenza (che può superare la durata minima annotata,) il server deve restituire un errore. Questa stringa è formattata come Timestamp.

Corpo della richiestaUserRestriction
RispostaUserRestriction
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

  }

}'
Risposta
{

  "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

Elenca i cambiamenti alle risorse di Restrizione utente all'interno di un universo dato. Ciò include sia restrizioni a livello di universo che a livello di luogo.

Per i registri delle restrizioni a livello di universo, il campo place sarà vuoto.

Campi
universe.user-restriction:read
RichiestaParametri percorso
universe_idstring
Necessario

L'ID dell'universo.

Parametri query
maxPageSizenumber

Il numero massimo di UserRestrictionLogs da Riportare.Il servizio può restituire meno di questo valore.Se non specificato, a massimo 10 UserRestrictionLogs vengono restituiti.Il valore massimo è 100 e i valori più alti sono impostati su 100.

pageTokenstring

Un token di pagina, ricevuto da una chiamata precedente, per recuperare una pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti alla chiamata successiva devono corrispondere alla chiamata che ha fornito il token della pagina.

filterstring

Questo campo può essere impostato per filtrare i log restituiti.

Il campo filter supporta un numero molto piccolo di CEL:

  • user
  • place
  • L'operatore di confronto == è disponibile.
  • L'operatore logico && è anche supportato.

Come esempio, il filtraggio per un utente e un luogo prende la forma filter="user == 'users/123'" && "place == 'places/456'".

Risposta

Restituisce una lista di registri di modifica applicati alle risorse di UserRestriction.

logsarray<object>

I registri delle restrizioni dell'utente dall'universo specificato.

nextPageTokenstring

Un token che puoi inviare come parametro pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non ci sono pagine successive.

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

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

}