すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:DescribeVodPlayerMetricData

    ドキュメントセンター

    ApsaraVideo VOD:DescribeVodPlayerMetricData

    最終更新日:Jul 21, 2026

    プレーヤーのメトリックデータを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    vod:DescribeVodPlayerMetricData

    none

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AppId

    string

    必須

    アプリケーション ID。

    app-1000000
    StartTime

    string

    必須

    クエリの開始時刻。フォーマット: yyyy-mm-ddthh:mm:ssz (協定世界時 (UTC))。

    説明

    • 過去 1 年間の再生データ履歴を照会できます。

    • 1 回のクエリの時間範囲は 31 日を超えることはできません。

    • 時間間隔は左閉右開 [StartTime, EndTime) です。

    2025-06-24T00:55:06Z
    EndTime

    string

    必須

    クエリの終了時刻。フォーマット: yyyy-mm-ddthh:mm:ssz (協定世界時 (UTC))。

    2025-06-05T15:59:59Z
    Interval

    string

    必須

    データを照会する時間の粒度。有効な値: 5m、1h、1d。サポートされる時間の粒度は、StartTime と EndTime の間のスパンによって異なります。

    • 3 日以内: 5m、1h、1d。

    • 4 ～ 7 日: 1h、1d。

    • 7 日超: 1d。

    1d
    TerminalType

    string

    必須

    端末タイプ。有効な値:

    • web: web。

    • mobile: モバイル。

    web。
    Filters

    string

    任意

    メトリックディメンションフィルター。ディメンションは、ディメンションタイプ (Field)、演算子 (Op)、およびディメンション値で構成されます。

    説明

    • 最大 3 つのディメンションを指定できます。

    • Metrics パラメーターに次の 4 つのメトリックが含まれている場合、Filters は効果を持ちません: Uv (再生ユーザー数)、AvgPerVv (ユーザーあたりの平均再生回数)、AvgPerPlayDuration (ユーザーあたりの平均再生持続時間)、AvgPerCompletionVv (ユーザーあたりの平均完走再生回数)。

    • 省および国の場合は、regionCode を渡します。

    • 複数の値は #_# で区切ります。

    ディメンションタイプ (Field) の有効な値:

    • SdkVersion: SDK バージョン。

    • AppVersion: アプリバージョン。

    • Codec: コーデック。

    • VideoType: 動画フォーマット。

    • Network: ネットワークタイプ。

    • Country: 国。

    • Isp: ISP。

    • VideoDefinition: 解像度。

    • Domain: ドメイン名。

    • Province: 省。

    • IsHw: ハードウェアデコードが使用されているかどうか。

    • ErrorCode: エラーコード。

    演算子 (Op) の有効な値: = (等しい)、> (より大きい)、< (より小さい)、!= (等しくない)。

    説明

    • SdkVersion および VideoDefinition は 4 つの演算子すべてをサポートしています。その他のメトリックは = (等しい) および != (等しくない) のみをサポートしています。

    DescribeVodPlayerDimensionData を呼び出してディメンション値を取得します。

    [ { "Field": "codec", "Op": "=", "Value": "h265#_#h264" }, { "Field": "os", "Op": "=", "Value": "Android#_#iOS" } ]
    Metrics

    string

    必須

    メトリックタイプ。複数のメトリックを選択できます (最大 3 つ)。

    説明

    • パーセンテージデータは 10 進数形式で返されます。

    サービス品質 (QoS) メトリック:

    • Vv: 再生回数。

    • RealVv: 実際の再生回数。

    • FirstFrame: 初回フレーム時間。

    • SecondPlayRate: 即時再生レート。

    • SlowPlayRate: スロー再生レート。

    • StuckCountRate: コマ落ち率 (回数ベース)。

    • SeekDuration: シーク持続時間。

    • StuckDuration100s: 100 秒あたりのコマ落ち持続時間。

    • StuckCount100s: 100 秒あたりのコマ落ち回数。

    • PlayFailRate: 再生失敗レート。

    • SeedFailRate: 非再生レート。

    • AvgPlayBitrate: 平均再生ビットレート。

    • AvgStartBitrate: 平均開始ビットレート。

    • ErrorCount100s: 100 秒あたりのエラー数。

    ユーザー体験品質 (QoE) メトリック:

    • Uv: 再生ユーザー数。

    • AvgPerVv: ユーザーあたりの平均再生回数。

    • AvgVideoDuration: 平均動画持続時間。

    • AvgPerPlayDuration: ユーザーあたりの平均再生持続時間。

    • AvgPerCompletionVv: ユーザーあたりの平均完走再生回数。

    • CompletionVv: 完走回数。

    • CompletionRate: 完走レート。

    • AvgPlayDuration: 平均再生持続時間。

    • JumpRate5s: 5 秒直帰ユーザー率。

    Vv,Uv,AvgPerVv。
    Top

    integer

    任意

    再生回数でランク付けされた上位 N 件のデータを返します。このパラメーターが指定されていない場合、すべてのディメンションのデータが返されます。

    5
    PageNumber

    integer

    任意

    ページ番号。デフォルト値: 1。

    1
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。デフォルト値: 5000。最大値: 5000。

    5000
    Language

    string

    任意

    応答の言語。有効な値:

    • zh (デフォルト): 簡体字中国語。

    • en: 英語。

    zh
    Os

    string

    任意

    プレーヤーのオペレーティングシステム。特定のオペレーティングシステムの再生データに対してフィルタークエリを実行するには、このパラメーターを指定します。有効な値: Android、iOS、Harmony、Windows、MacOS、Linux。 利用可能な値は端末タイプによって異なります。

    • ネイティブ: Android、iOS、Harmony。

    • web: Android、iOS、Harmony、Windows、MacOs、Linux。

    複数の値は #_# で区切ります。

    Android、iOS、Windows。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ。

    RequestId

    string

    リクエスト ID。

    25818875-5F78-4A*****F6-D7393642CA58
    PageNumber

    integer

    現在のページ番号。

    1
    PageSize

    integer

    ページサイズ。

    5000
    TotalCnt

    integer

    データポイントの総数。

    500
    DataList

    array<object>

    返されたデータのリスト。

    object

    TimeStamp

    string

    データのタイムスタンプ。フォーマット: yyyy-mm-ddthh:mm:ssz (協定世界時 (UTC))。

    2025-06-24T00:55:06Z

    Dimension

    string

    ディメンション。

    H265_MP4_WIFI。
    Uv

    number

    再生ユーザー数。

    500
    Vv

    number

    再生回数。

    800
    RealVv

    number

    実際の再生回数。

    1000
    FirstFrame

    number

    初回フレーム時間 (ミリ秒単位)。

    100
    SecondPlayRate

    number

    即時再生レート。

    0.8
    SlowPlayRate

    number

    スロー再生レート。

    0.2
    StuckCountRate

    number

    コマ落ちレート (回数ベース)。

    0.1
    SeekDuration

    number

    シーク持続時間 (ミリ秒単位)。

    100
    StuckDuration100s

    number

    100 秒あたりのコマ落ち持続時間 (ミリ秒単位)。

    200
    PlayFailRate

    number

    再生失敗レート。

    0.2
    SeedFailRate

    number

    非再生レート。

    0.01
    AvgPlayBitrate

    number

    平均再生ビットレート (bps 単位)。

    100
    AvgStartBitrate

    number

    平均開始ビットレート (bps 単位)。

    100
    ErrorCount100s

    number

    100 秒あたりのエラー数。

    1
    AvgPerVv

    number

    ユーザーあたりの平均再生回数。

    10
    AvgVideoDuration

    number

    平均動画持続時間 (ミリ秒単位)。

    100000
    AvgPerPlayDuration

    number

    ユーザーあたりの平均再生持続時間 (ミリ秒単位)。

    100000
    AvgPerCompletionVv

    number

    ユーザーあたりの平均完走再生回数。

    2
    CompletionVv

    number

    完走回数。

    500
    CompletionRate

    number

    完走レート。

    0.8
    AvgPlayDuration

    number

    平均再生持続時間 (ミリ秒単位)。

    100000

    JumpRate5s

    number

    5 秒直帰ユーザー率。

    0.1
    TotalPlayDuration

    number

    合計再生持続時間 (ミリ秒単位)。

    100000
    StuckCount100s

    string

    100 秒あたりのコマ落ち回数。

    2
    Extend

    object

    拡張情報。

    ActualStartTime

    string

    指定された時間範囲内でデータポイントが存在する最も早い時刻。フォーマット: yyyy-mm-ddthh:mm:ssz (協定世界時 (UTC))。

    2025-06-24T00:55:06Z
    ActualEndTime

    string

    指定された時間範囲内でデータポイントが存在する最も遅い時刻。フォーマット: yyyy-mm-ddthh:mm:ssz (協定世界時 (UTC))。

    2025-06-05T15:59:59Z
    IntervalSeconds

    integer

    照会されたデータの時間の粒度 (秒単位)。

    3600

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
  "PageNumber": 1,
  "PageSize": 5000,
  "TotalCnt": 500,
  "DataList": [
    {
      "TimeStamp": "2025-06-24T00:55:06Z\n",
      "Dimension": "H265_MP4_WIFI",
      "Uv": 500,
      "Vv": 800,
      "RealVv": 1000,
      "FirstFrame": 100,
      "SecondPlayRate": 0.8,
      "SlowPlayRate": 0.2,
      "StuckCountRate": 0.1,
      "SeekDuration": 100,
      "StuckDuration100s": 200,
      "PlayFailRate": 0.2,
      "SeedFailRate": 0.01,
      "AvgPlayBitrate": 100,
      "AvgStartBitrate": 100,
      "ErrorCount100s": 1,
      "AvgPerVv": 10,
      "AvgVideoDuration": 100000,
      "AvgPerPlayDuration": 100000,
      "AvgPerCompletionVv": 2,
      "CompletionVv": 500,
      "CompletionRate": 0.8,
      "AvgPlayDuration": 100000,
      "JumpRate5s": 0.1,
      "TotalPlayDuration": 100000,
      "StuckCount100s": "2"
    }
  ],
  "Extend": {
    "ActualStartTime": "2025-06-24T00:55:06Z",
    "ActualEndTime": "2025-06-05T15:59:59Z",
    "IntervalSeconds": 3600
  }
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 Meter.ParamError Param Error:%s,Please Check Again.
    500 Meter.ServerInternalError The Request Processing Has Failed Due To Some Unknown Error.
    500 Meter.DataSourceQueryError Data Source Error:%s,Please Try Again.
    403 Meter.AuthError Authentication Failed,Please Try Again.
    502 Meter.ReadyTsError Get ReadyTs Failed,Please Try Again.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。