Player Management

Notice

This document is a machine-translated draft and is currently undergoing review. Some content may be inaccurate or differ from the original Korean version. For the most precise information, refer to the Korean documentation.

New feature notice

• Support scope: Player management functionality is newly added in v3 and is not supported in v1 or v2.
• Feature separation notice: The functionality for attaching/detaching a player skin to a specific channel must be performed via Attach channel to player skin and Detach channel from player skin in Channel Management.
• Common authentication: All APIs use a common authentication method via the query string parameter (?access_token=).

Go to the Player Management API v3 Reference

Get list of player skins

• v3: GET /player-skins

Response structure details

Response structure specification

{
  "data": [
    {
      "id": 1,
      "title": "skin_01",
      "value": { ... },
      "channels": [
        {
          "key": "channel_key_string",
          "name": "channel_name_string",
          "status": true
        }
      ]
    }
  ]
}

Delete a player skin

• v3: DELETE /player-skins/{player_skin_id}

Request parameter and response structure details

Request path parameters

Parameter	Data type	Required	Description
player_skin_id	Integer	Required	ID of the player skin to delete

Response structure specification

{
  "data": [],
  "status": "ok"
}

Get list of player events

• v3: GET /player-events

Terminology note

'Event' refers to an ad event. In other words, this endpoint returns a list of ad event metadata registered across all players.

Response structure details

Response structure specification

{
  "data": [
    {
      "id": 1,
      "title": "event_01",
      "value": { ... },
      "channels": [
        {
          "key": "channel_key_string",
          "name": "channel_name_string",
          "status": true
        }
      ]
    }
  ]
}

Delete a player event

• v3: DELETE /player-events/{player_event_id}

Request parameter and response structure details

Request path parameters

Parameter	Data type	Required	Description
player_event_id	Integer	Required	ID of the player event to delete

Response structure specification

{
  "data": [],
  "status": "ok"
}