---
title: "プレイヤー名のチェック"
slug: "vpe-api-check-name"
updated: 2026-09-17T09:58:18Z
published: 2026-09-17T09:58:18Z
canonical: "api.ncloud-docs.com/vpe-api-check-name"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# プレイヤー名のチェック

Classic/VPC環境で利用できます。

プレイヤー名の有効性と重複チェックを行います。

## リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

| メソッド | URI |
| --- | --- |
| GET | /api/v1/players/checkName |

### リクエストヘッダ

Video Player Enhancement APIで共通して使用されるヘッダの詳細は、[Video Player Enhancementのリクエストヘッダ](/docs/ja/vpe-api-overview#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

リクエストクエリパラメータの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `name` | String | Required | プレイヤー名 - 英数字、記号の「_」、「-」、「@」を組み合わせて3~30文字以内で入力 - 文字列の先頭は英字 |

### リクエスト例

リクエストのサンプルコードは次の通りです。

```
curl --location --request GET 'https://vpe.apigw.ntruss.com/api/v1/players/checkName?name=player001' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-region_code: KR'
```

## レスポンス

レスポンス形式を説明します。

### レスポンスボディ

レスポンスボディの説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `code` | String | - | レスポンスコード |
| `message` | String | - | 名前チェックの結果 - 使用可能な名前の場合: `ok` - 使用できない名前の場合: 使用できない理由 |

### レスポンスステータスコード

Video Player Enhancement APIで共通して使用されるレスポンスステータスコードの詳細は、[Video Player Enhancementのレスポンスステータスコード](/docs/ja/vpe-api-overview#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

レスポンスのサンプルコードは次の通りです。

#### チェックの結果、使用可能な名前の場合

チェックの結果、使用可能な名前の場合のレスポンスのサンプルコードは次の通りです。

```
{
    "code": "200",
    "message": "ok"
}
```

#### チェックの結果、使用できない名前の場合

チェックの結果、使用できない名前の場合のレスポンスのサンプルコードは次の通りです。

```
{
    "error": {
        "errorCode": "4802",
        "message": "This player already exists."
    }
}
```