*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

User

Représente tout utilisateur enregistré de Roblox.

Attributs

pathstring

Le chemin de ressource de l'utilisateur.

Format : users/{user_id}.

createTimestring
Sortie seule

La date et l'heure à laquelle l'utilisateur a été créé. Ce string est formatée en tant que Timestamp.

idstring
Sortie seule

ID unique qui identifie un utilisateur dans Roblox.

namestring

Nom d'utilisateur unique pour un utilisateur dans Roblox.

displayNamestring

Nom d'affichage pour l'utilisateur.

aboutstring

Informations définies par l'utilisateur à propos de lui-même.

localestring

Local actuel sélectionné par l'utilisateur. Renvoie le code de langue IETF.

premiumboolean
Sortie seule

Si l'utilisateur est un utilisateur premium.

idVerifiedboolean
Sortie seule

Spécifie si l'utilisateur est vérifié en tant qu'identité. La vérification inclut, mais ne se limite pas aux numéros de téléphone non VoIP ou aux identifications gouvernementales.

Pour accéder à ces données, vous avez besoin d'une clé API/jeton OAuth avec le champ suivant : user.advanced:read.

socialNetworkProfilesobject

Profils de réseau social de l'utilisateur et visibilité.

URL de base
https://apis.roblox.com
La ressource User
{

  "path": "users/123",

  "createTime": "2023-07-05T12:34:56Z",

  "id": "123456",

  "name": "exampleUser",

  "displayName": "userDefinedName",

  "about": "Example User's bio",

  "locale": "en-US",

  "premium": true,

  "idVerified": true,

  "socialNetworkProfiles": {

    "facebook": "string",

    "twitter": "string",

    "youtube": "string",

    "twitch": "string",

    "guilded": "string",

    "visibility": "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED"

  }

}

User

Obtenir l'utilisateur
Bêta

GET /cloud/v2/users/{user_id}

Obtient les informations de base et avancées d'un utilisateur.

Pour accéder à l'information publique d'un utilisateur, aucune autre portée n'est requise.

Pour accéder au statut de vérification d'un utilisateur, vous avez besoin des scopes suivants :

  • user.advanced : lire

Pour accéder à l'information sur le compte social d'un utilisateur, vous avez besoin des scopes suivants :

  • user.social : lecture
RequêteParamètres du chemin
user_idstring
Requis

L'ID utilisateur.

RéponseUser
GET /cloud/v2/users/{user_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user_id}' \

  -H 'x-api-key: {your-api-key}'
Réponse
{

  "path": "users/123",

  "createTime": "2023-07-05T12:34:56Z",

  "id": "123456",

  "name": "exampleUser",

  "displayName": "userDefinedName",

  "about": "Example User's bio",

  "locale": "en-US",

  "premium": true,

  "idVerified": true,

  "socialNetworkProfiles": {

    "facebook": "string",

    "twitter": "string",

    "youtube": "string",

    "twitch": "string",

    "guilded": "string",

    "visibility": "SOCIAL_NETWORK_VISIBILITY_UNSPECIFIED"

  }

}

User

Générer une miniature d'utilisateur
Bêta

GET /cloud/v2/users/{user_id}:generateThumbnail

Génère et renvoie l'URL de la vignette d'avatar de l'utilisateur.

RequêteParamètres du chemin
user_idstring
Requis

L'ID utilisateur.

Paramètres de requête
sizenumber

Taille de la vignette générée. La vignette générée aura une dimension size * size.

Valeurs actuellement prises en charge : 48, 50, 60, 75, 100, 110, 150, 180, 352, 420, 720 La valeur par défaut est 420.

formatEnum<string>

Spécifiez le format de la vignette générée. La valeur par défaut est PNG .

Valeurs possibles :

| Valeur | Description | | --- | --- | | FORMAT_UNSPECIFIED | Format d'image utilisateur par défaut -- défini sur png | | PNG | Générer une image en format .png | | JPEG | Générer une image en format .jpg |. Valeurs possibles :

shapeEnum<string>

Spécifiez la forme de la vignette. La valeur par défaut est ROUND (circulaire).

Valeurs possibles :

| Valeur | Description | | --- | --- | | SHAPE_UNSPECIFIED | Forme utilisateur par défaut -- définie sur rond | | ROUND | Générer une miniature en forme de cercle.| | SQUARE | Générer une miniature en tant que rectangle. |. Valeurs possibles :

Réponse

Cette méthode est asynchrone et retourne une Operation, qui représente l'état courant de l'opération. Il contient un chemin de terminaison que vous pouvez interroger pour obtenir la vraie réponse et les métadonnées applicables. Voir la documentation sur les opérations à long terme pour plus d’informations.

Les sections suivantes décrivent la réponse et les objets de métadonnées qui sont fournis lorsqu'une opération se termine.

Réponse

Renvoie l'URL de la vignette d'avatar de l'utilisateur.

imageUristring

URI pour la miniature générée.

Métadonnées

Aucun

GET /cloud/v2/users/{user_id}:generateThumbnail
curl -L -X GET 'https://apis.roblox.com/cloud/v2/users/{user_id}:generateThumbnail?size={integer}&format={string}&shape={string}' \

  -H 'x-api-key: {your-api-key}'