プレイヤーの照会

Prev Next

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

プレイヤーのサイトドメイン、Access Keyなどの詳細情報を照会します。

リクエスト

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

メソッド URI
GET /api/v1/players/{player_no}

リクエストヘッダ

Video Player Enhancement APIで共通して使用されるヘッダの詳細は、Video Player Enhancementのリクエストヘッダをご参照ください。

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

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

フィールド タイプ 必須の有無 説明
player_no String Required プレイヤー番号

リクエスト例

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

curl --location --request GET 'https://vpe.apigw.ntruss.com/api/v1/players/6159' \
--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 - レスポンスメッセージ
result Object - レスポンス結果
result.name String - プレイヤー名
result.no String - プレイヤー番号
result.version String - プレイヤー SDKバージョン
result.domains Object - サイトドメイン情報
result.domains.aos Array - Androidアプリパッケージ情報: ドメイン情報
result.domains.ios Array - iOSアプリパッケージ情報: ドメイン情報
result.domains.web Array - ウェブサイトドメイン情報: ドメイン情報
result.access_key String - プレイヤー Access Key
result.created_at String - プレイヤー作成日時
  • ISO 8601形式
result.updated_at String - プレイヤー更新日時
  • ISO 8601形式
result.auto_update String - 自動アップデート
  • Y | N
    • Y: 使用
    • N: 使用しない

ドメイン情報

ドメイン情報の説明は次の通りです。

フィールド タイプ 必須の有無 説明
no Integer - ドメイン識別番号(Primary Key)
type String - サイトドメインタイプ
  • web | ios | aos
    • web: ウェブサイト URL
    • ios: iOSアプリパッケージ ID
    • aos: Androidアプリパッケージ ID
domain String - ドメインまたはモバイルアプリパッケージ ID
created_at String - ドメイン登録日時
  • ISO 8601形式

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

Video Player Enhancement APIで共通して使用されるレスポンスステータスコードの詳細は、Video Player Enhancementのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
    "code": "200",
    "message": "ok",
    "result": {
        "name": "player000",
        "no": 6159,
        "version": "1.1.3",
        "domains": {
            "aos": [
                {
                    "no": 2393,
                    "type": "aos",
                    "domain": "*******",
                    "created_at": "2025-08-12T02:23:28.000+00:00"
                }
            ],
            "ios": [
                {
                    "no": 2392,
                    "type": "ios",
                    "domain": "com.t***.com",
                    "created_at": "2025-08-12T02:23:28.000+00:00"
                }
            ],
            "web": [
                {
                    "no": 2231,
                    "type": "web",
                    "domain": "https://************.***.kr",
                    "created_at": "2025-05-27T05:34:37.000+00:00"
                },
                {
                    "no": 2389,
                    "type": "web",
                    "domain": "http://main.***********.**.kr/",
                    "created_at": "2025-08-12T01:22:37.000+00:00"
                }
            ]
        },
        "access_key": "7848************************102d",
        "created_at": "2025-05-27T05:34:37.000+00:00",
        "updated_at": "2025-08-12T02:23:31.000+00:00",
        "auto_update": "N"
    }
}