dev.tsunagite.profile Documentation (EN)

main record

The player profile for a given game, determined by an NSID of the game publisher's handle succeeded by the game's key.

Record Key nsid

Properties

displayName string Required

The display name for the player on leaderboards.

maxLength: 500 bytesminLength: 1 bytesmaxGraphemes: 50 graphemes

game string at-uri Required

The URI of the game this profile is for.

View raw schema

{
  "key": "nsid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "game",
      "displayName"
    ],
    "properties": {
      "game": {
        "type": "string",
        "format": "at-uri",
        "description": "The URI of the game this profile is for."
      },
      "displayName": {
        "type": "string",
        "maxLength": 500,
        "minLength": 1,
        "description": "The display name for the player on leaderboards.",
        "maxGraphemes": 50
      }
    }
  },
  "description": "The player profile for a given game, determined by an NSID of the game publisher's handle succeeded by the game's key."
}