コンテンツ再生リストの照会

Prev Next

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

プレイヤーを通じて再生したコンテンツリスト照会します。プレイヤー設定時にメタデータを設定したデータのみ集計され、照会開始点と終了点の間隔に応じてデータ集計基準が異なります。

開始点と終了点の間隔 インターバル
1日以下 5分単位
2日以上 1日単位

リクエスト

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

メソッド URI
GET /v1/contentsSummary

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
device String Optional プレイヤー再生環境
  • PC,Mobile (デフォルト)| PC | Mobile
videoType String Optional 再生ソース区分
  • VOD,LIVE (デフォルト) | VOD | LIVE
    • VOD,LIVE: VODビデオ、LIVEストリーム
    • VOD: VODビデオ
    • LIVE: LIVEストリーム
startDate Date Optional 照会開始日時
  • 日付形式(UTC)
endDate Date Optional 照会終了日時
  • 日付形式(UTC)
pageNo Integer Optional ページ番号
  • 1~1000 (デフォルト: 1)
limit Integer Optional ページごとの項目数
  • 10~100 (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://ma-dashboard-api.vpe.naverncp.com/v1/contentsSummary?device=PC,Mobile&videoType=VOD,LIVE&pageNo=1' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project id}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
code String - レスポンスコード
message String - レスポンスメッセージ
result Object - レスポンス結果
result.totalCount Integer - レスポンス結果数
result.list Array - 再生コンテンツリスト: list

list

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

フィールド タイプ 必須の有無 説明
title String - 動画のタイトル
url String - 再生ソース (URL)
videoType String - 再生ソース区分
  • VOD,LIVE | VOD | LIVE
    • VOD,LIVE: VODビデオ、LIVEストリーム
    • VOD: VODビデオ
    • LIVE: LIVEストリーム
contentsKey String - コンテンツキー ID
  • コンテンツ分析時の識別子
playCount Integer - 再生回数
playTime Integer - 再生時間 (秒)

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

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

レスポンス例

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

{
	"code": 200,
	"message": "contents/summary",
	"result": {
		"totalCount": 3,
		"list": [
			{
				"title": "NAVERクラウドの紹介ビデオ",
				"url": "https://*********.naverncp.com/hls/*********/vod/JDPCILtJUbYObLmI/media-plus-99/DQEhtI6zHI_,AVC_SD_1Pass_30fps_1,AVC_HD_1Pass_30fps,AVC_FHD_1Pass_30fps,.mp4.smil/master.m3u8",
				"videoType": "VOD",
				"contentsKey": "4311180*********a3edc1",
				"playCount": 96,
				"playTime": 35136
			},
			{
				"title": "NAVERクラウドの紹介ビデオ",
				"url": "https://*********.naverncp.com/hls/*********/endpoint/sample/221027_NAVER_Cloud_intro_Long_ver_AVC_,FHD_2Pass_30fps,HD_2Pass_30fps,SD_2Pass_30fps,.mp4.smil/master.m3u8",
				"videoType": "VOD",
				"contentsKey": "77da5874*********e50ec5ec3",
				"playCount": 52,
				"playTime": 6748
			},
			{
				"title": "NAVERクラウドの紹介ビデオ",
				"url": "https://*********.naverncp.com/hls/*********/vod/JDPCILtJUbYObLmI/media-plus-99/DQEhtI6zHI_,AVC_SD_1Pass_30fps_1,AVC_HD_1Pass_30fps,AVC_FHD_1Pass_30fps,.mp4.smil/master.m3u8",
				"videoType": "VOD",
				"contentsKey": "6dd90907a*********d3566049",
				"playCount": 7,
				"playTime": 17568
			}
		]
	}
}