プレイヤーの作成

Prev Next

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

プレイヤーを作成します。

リクエスト

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

メソッド URI
POST /api/v1/players

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
auto_update String Optional プレイヤー SDK自動アップデート
  • Y | N (デフォルト)
    • Y: 使用
    • N: 使用しない
domains Array Required サイトドメインリスト: domains
name String Required プレイヤー名
  • 英数字、記号の「_」、「-」、「@」を組み合わせて3~30文字以内で入力
  • 文字列の先頭文字は英字
  • 重複と有効性チェック: プレイヤー名のチェックを参照
version String Optional プレイヤー SDKバージョン

domains

domainsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
type String Required サイトドメインタイプ
  • web | ios | aos
    • web: ウェブサイト URL
    • ios: iOSアプリパッケージ ID
    • aos: Androidアプリパッケージ ID
domain String Required ドメインまたはモバイルアプリパッケージ ID

リクエスト例

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

curl --location --request POST 'https://vpe.apigw.ntruss.com/api/v1/players' \
--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' \
--data '{
    "auto_update": "Y",
    "domains": [
        {
            "domain": "https://www.example.com",
            "type": "web"
        }
    ],
    "name": "player001"
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ

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

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

レスポンス例

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

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