Video Player Enhancementの概要

Prev Next

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

Video Player Enhancementは、ウェブまたはモバイルアプリケーションでビデオやオーディオなどのメディアコンテンツを再生できる NAVERクラウドプラットフォームのメディアプレイヤーサービスです。Video Player Enhancementサービスでは、Video Player Management、Media Analytics関連機能を RESTful API形式で提供します。

Video Player Enhancementの共通設定

Video Player Enhancement APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

  • Video Player Management
    https://vpe.apigw.ntruss.com
  • Media Anaytics
    https://ma-dashboard-api.vpe.naverncp.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix timestamp形式
  • Video Player Management APIで使用
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名
x-ncp-region_code Optional リージョンコード
x-api-key Required APIキー
  • Media Analyticsダッシュボードの 設定 > 基本設定 にて、APIキーを確認
    • [APIキーの再作成] ボタンクリックをクリックするとキーが再発行され、以前のキーは使用不可
  • Media Analytics APIで使用
x-project-id Required 会社 ID
  • Media Analyticsダッシュボードの 設定 > 基本設定 にて、会社 IDを確認
  • Media Analytics APIで使用
Content-Type Required リクエストデータの形式
  • application/json

レスポンス

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

レスポンスボディ

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

error

errorは API呼び出し失敗情報を定義します。errorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
error Object - エラーコードとメッセージ
error.errorCode String Required エラーコード
error.message String Required エラーメッセージ

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

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
200 200 ok 呼び出し成功
200 200 Unauthorized サービス利用が申し込まれていない
200 4100 No version information. プレイヤーバージョン情報なし
200 4601
  • Query string player_no is missing.
  • Query string sessionId is missing.
  • 入力したプレイヤー番号エラー
  • 入力したセッション IDエラー
200 4602 Session detail data is empty. 無効なセッションを入力
200 4610 Query string name is invalid. 入力した名前のエラー
200 4700 Body (JSON) name is missing. リクエストボディ名が欠落している
200 4702 Body (JSON) domains is missing. リクエストボディドメインが欠落している
200 4703 Some domains in Body (JSON) domains are invalid. (if type is web) リクエストボディの一部ドメインエラー(ウェブタイプの場合)
200 4705 Some types in Body (JSON) domains are invalid. リクエストボディドメインの一部タイプエラー
200 4706 Enter an option value for Body (JSON). リクエストボディにオプション値の入力が必要
200 4707 Body (JSON) pricing is missing or invalid. リクエストボディに pricingが欠落しているか、無効
200 4708 There are duplicate domains in Body (JSON) domains. リクエストボディに重複したドメインが存在
200 4709 Up to 5 domains can be added to Body (JSON) domains. リクエストボディにメインは最大5個まで追加可能
200 4711 Only 1 Body (JSON) app per OS can be added. リクエストボディに OSごとのアプリは最大1個まで追加可能
200 4712 At least 1 Body (JSON) web domain must be added. リクエストボディにウェブドメインを1個以上追加すること
200 4713 Body (JSON) name or web domains cannot be edited. リクエストボディの名前やウェブドメインは変更できない
200 4729 Body (JSON) customBtns must be array. customBtnsフィールドは配列タイプにすること
200 4730 Body (JSON) customBtns is up to 4. customBtnsフィールドは最大4個まで設定可能
200 4731 Body (JSON) customBtns position is invalid. customBtnsフィールドのポジションが無効
200 4732 Body (JSON) customBtns position is required. customBtnsフィールドのポジションが欠落している
200 4733 Body (JSON) customBtns icon is required. customBtnsフィールドのアイコンが欠落している
200 4734 Body (JSON) customBtns ui is required. customBtnsフィールドの UIが欠落している
200 4735 Body (JSON) customBtns ui is invalid. customBtnsフィールドの UIが無効
200 4736 Body (JSON) customBtns flow is invalid. customBtnsフィールドのフローが無効
200 4799 Enter an option value for Body (JSON). リクエストボディにオプション値の入力が必要
200 4800 No player has been added. プレイヤーが追加されていない
200 4801 No player information. プレイヤー情報なし
200 4802 This player already exists. 既に存在するプレイヤー
200 4803 The number of players exceeded the limit. 無料の場合は1個に制限
200 4804 The feature can't be used in the free version of player. 無料版では使用不可
200 4805 The player name already exists. 既に存在するプレイヤー名
400 100 when page_no is too large, the error msg is page_no exceeds the size limit.
when page_size is too large, the error msg is page_size exceeds the size limit.		 ページ番号が大きすぎるか、ページサイズが大きすぎる
400 4602 The query duration exceeds the maximum allowed period of {time} hours. 照会期間が最大許容期間のtime時間を超過
400 4603 The query duration exceeds the maximum allowed limit. 照会期間が最大許容値を超過
400 4604 The startDate must be earlier than the endDate. 開始日(startDate)は終了日(endDate)より以前の日付にすること
401 200 Authentication Failed 認証失敗
401 210 Permission Denied 権限なし
404 300 Not Found Exception 権限なし
429 400 Quota Exceeded Quota超過
429 410 Throttle Limited Rate超過
429 420 Rate Limited Rate超過
413 430 Request Entity Too Large リクエストエンティティサイズの超過
503 500 Endpoint Error エンドポイント接続エラー
504 510 Endpoint Timeout エンドポイント接続時間の超過
500 900 Unexpected Error 例外処理していないエラー
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "error":{
        "errorCode":"210",
        "message":"Permission Denied"
    }
}

Video Player Enhancement API

Video Player Enhancementサービスが提供する APIの説明は次の通りです。

Video Player Management

Video Player Management関連 APIの説明は次の通りです。

API 説明
プレイヤーの作成 ウェブまたはモバイルアプリケーションでメディアコンテンツを再生できるプレイヤーを作成
プレイヤーの複製 既存のプレイヤーを複製して新しいプレイヤーを作成
プレイヤー SDKバージョンの照会 使用可能なプレイヤー SDKバージョンを照会
プレイヤー名のチェック プレイヤー名の有効性と重複をチェック
プレイヤーリストの照会 プレイヤー情報リストの照会
プレイヤーオプションの照会 プレイヤーオプション情報を照会
プレイヤーの照会 プレイヤーの詳細情報を照会
プレイヤーのロールバック(Develop) Develop(開発)環境にデプロイしたプレイヤーの設定をロールバック
プレイヤーのデプロイ(Develop) Develop(開発)環境にプレイヤーの設定をデプロイ
プレイヤーのデプロイ(Production) Production(本番)環境にプレイヤー設定をデプロイ
プレイヤーの更新 Production(本番)環境にプレイヤーのサイトドメイン更新をデプロイ
プレイヤーの削除 プレイヤーを削除

Media Analytics

Media Analytics関連 APIの説明は次の通りです。

API 説明
セッションの詳細照会 プレイヤーユーザーのセッションに関する詳細情報を照会
セッションの直近リストの照会 プレイヤーユーザーの最近セッションを最大100個照会
リアルタイム視聴者数の照会 リアルタイム視聴者数を1分単位で照会
ユニークユーザー数の照会 プレイヤーユーザー(IPアドレス基準)の合計を照会
総再生数の照会 プレイヤー再生回数の合計を照会
総再生時間の照会 プレイヤー再生時間の合計を照会
コンテンツ再生リストの照会 プレイヤーで再生したコンテンツリストを照会
コンテンツ再生時間の照会 プレイヤーで再生したコンテンツのうち、再生時間の上位10件を照会
コンテンツ再生回数の照会 プレイヤーで再生したコンテンツのうち、再生回数の上位10件を照会

Video Player Enhancement関連リソース

Video Player Enhancement APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。