*Ta zawartość została przetłumaczona przy użyciu narzędzi AI (w wersji beta) i może zawierać błędy. Aby wyświetlić tę stronę w języku angielskim, kliknij tutaj.

UserRestriction

Reprezentuje ograniczenie dla użytkownika.

ŚCIEŻKI DO ZASOBÓW
/cloud/v2/universes/{universe_id}/user-restrictions
/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions

Atrybuty

pathstring

Ścieżka zasobów ograniczenia użytkownika.

Formaty:

universes/{universe_id}/user-restrictions/{user_restriction_id}
universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}.

updateTimestring

Tylko dane wyjściowe

Data i czas aktualizacji ograniczenia użytkownika po raz ostatni. Ten ciąg jest sformatowany jako Timestamp.

userstring

Tylko dane wyjściowe

Zainteresowany użytkownik.

gameJoinRestrictionobject

Użytkownik jest wykluczony z wszechświata lub miejscerodzica.

Podstawowy adres URL

https://apis.roblox.com

Zasób 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

Lista ograniczeń użytkowników dla użytkowników, którzy kiedykolwiek zostali zakazani w wszechświecie lub w konkretnym miejsce.

Zakresy

universe.user-restriction:read

ŻądanieParametry ścieżki

universe_idstring

Wymagane

ID wszechświata.

Parametry zapytania

maxPageSizenumber

Maksymalna liczba ograniczeń użytkownika do zwrotu.Usługa może zwrócić mniej niż tę wartość.Jeśli nie określono, zwracane są maksymalnie 10 ograniczeń użytkownika.Maksymalna wartość wynosi 100, a wyższe wartości są ustawione na 100.

pageTokenstring

Żeton strony, otrzymany z poprzedniego wezwania, aby odzyskać następną stronę.

Podczas paginowania wszystkie pozostałe parametry dostarczone do następnego wezwania muszą pasować do wezwania, które dostarczyło token strony.

Odpowiedź:

Lista ograniczeń użytkownika w kolekcjarodziczej.

userRestrictionsarray<UserRestriction>

Ograniczenia użytkownika z określonego wszechświata lub miejsca.

nextPageTokenstring

Token, który możesz wysłać jako parametr pageToken w celu odzyskania następnej strony. Jeśli to pole zostanie pominięte, nie ma następnych stron.

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

Odpowiedź:

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

Zdobądź ograniczenie użytkownika.

Zakresy

universe.user-restriction:read

ŻądanieParametry ścieżki

universe_idstring

Wymagane

ID wszechświata.

user_restriction_idstring

Wymagane

ID ograniczenia użytkownika.

Odpowiedź: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}'

Odpowiedź:

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

Zaktualizuj ograniczenie użytkownika.

Zakresy

universe.user-restriction:write

ŻądanieParametry ścieżki

universe_idstring

Wymagane

ID wszechświata.

user_restriction_idstring

Wymagane

ID ograniczenia użytkownika.

Parametry zapytania

updateMaskstring

Lista pól do aktualizacja.

Pole game_join_restriction musi być aktualizowane atomowo; maski pól, które indeksują się w game_join_restriction (takie jak "game_join_restriction.active" ), nie są wspierane. Ten ciąg jest sformatowany jako FieldMask.

idempotencyKey.keystring

Unikalny klucz do użycia dla bezpieczeństwa.

idempotencyKey.firstSentstring

Data i czas przesłania pierwszego żądaniazd.

Jeśli jest to dalej w przeszłości niż czas trwania klucza bezpieczeństwa (który może przekroczyć minimalny czas życia oznaczony), serwer musi zwrócić błąd. Ten ciąg jest sformatowany jako Timestamp.

Treść żądaniaUserRestriction

Odpowiedź: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
  }
}'

Odpowiedź:

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

Lista zmian w zasobach ograniczenia użytkownika w danym wszechświecie. Obejmuje zarówno ograniczenia na poziomie wszechświata, jak i poziomie miejsca.

Dla dzienników ograniczeń na poziomie wszechświata pole place będzie puste.

Zakresy

universe.user-restriction:read

ŻądanieParametry ścieżki

universe_idstring

Wymagane

ID wszechświata.

Parametry zapytania

maxPageSizenumber

Maksymalna liczba UserRestrictionLogs do zwrotu.Usługa może zwrócić mniej niż tę wartość.Jeśli nie określono, zwracanych jest maksymalnie 10 dzienników ograniczeń użytkownika.Maksymalna wartość wynosi 100, a wyższe wartości są ustawione na 100.

pageTokenstring

Żeton strony, otrzymany z poprzedniego wezwania, aby odzyskać następną stronę.

Podczas paginowania wszystkie pozostałe parametry dostarczone do następnego wezwania muszą pasować do wezwania, które dostarczyło token strony.

filterstring

To pole może być ustawione do filtrowania logów zwrotnych.

Pole filter wspiera bardzo małą liczbę CEL:

user
place
Dostępny jest operator porównania ==.
Logiczny operator && również jest wspierany.

Jako przykład filtrowanie dla użytkownika i miejsca przybiera formę filter="user == 'users/123'" && "place == 'places/456'".

Odpowiedź:

Zwraca listę dzienników zmian zastosowanych do zasobów ograniczenia użytkownika.

logsarray<object>

Logi ograniczeń użytkownika z określonego wszechświata.

nextPageTokenstring

Token, który możesz wysłać jako parametr pageToken w celu odzyskania następnej strony. Jeśli to pole zostanie pominięte, nie ma następnych stron.

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

Odpowiedź:

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

Atrybuty

UserRestriction

List User RestrictionsBeta

UserRestriction

Get User RestrictionBeta

UserRestriction

Update User RestrictionBeta

UserRestriction

List User Restriction LogsBeta

List User Restrictions
Beta

Get User Restriction
Beta

Update User Restriction
Beta

List User Restriction Logs
Beta