メインコンテンツまでスキップ

プレイヤー管理

新機能案内
  • サポート範囲: プレイヤー管理機能は v3 で新規追加された機能で、v1 および v2 ではサポートされません。
  • 機能分離のご案内: プレイヤースキンを特定のチャンネルに連結/解除する機能は、チャンネル管理の チャンネル–プレイヤースキン連携 および チャンネル–プレイヤースキン連携解除 を通じて行う必要があります。
  • 共通認証: すべての API は、クエリ文字列パラメーター(?access_token=)を利用した共通認証方式を使用します。
プレイヤー管理 API v3 リファレンスへ移動

プレイヤースキン一覧取得​

  • v3: GET /player-skins
レスポンス構造の詳細

レスポンス構造仕様​

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

プレイヤースキン削除​

  • v3: DELETE /player-skins/{player_skin_id}
リクエストパラメーターとレスポンス構造の詳細

リクエストパスパラメーター​

パラメーターデータ型必須有無説明
player_skin_idInteger必須削除対象のプレイヤースキンID

レスポンス構造仕様​

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

プレイヤーイベント一覧取得​

  • v3: GET /player-events
用語案内

"イベント(Event)"は広告イベントを意味します。つまり、このエンドポイントは全プレイヤーに登録された広告イベントメタデータの一覧を返します。

レスポンス構造の詳細

レスポンス構造仕様​

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

プレイヤーイベント削除​

  • v3: DELETE /player-events/{player_event_id}
リクエストパラメーターとレスポンス構造の詳細

リクエストパスパラメーター​

パラメーターデータ型必須有無説明
player_event_idInteger必須削除対象のプレイヤーイベントID

レスポンス構造仕様​

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