すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:DescribeVodPlayerMetricData

    ドキュメントセンター

    ApsaraVideo VOD:DescribeVodPlayerMetricData

    最終更新日:Aug 10, 2025

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

    今すぐお試しください

    この 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

    必須

    クエリ対象期間の開始時刻。時間は UTC で、形式は yyyy-mm-ddThh:mm:ssZ です。

    説明

    • 過去 1 年間の再生データをクエリできます。

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

    • 時間範囲は左閉右開区間 `[StartTime, EndTime)` です。

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

    string

    必須

    クエリ対象期間の終了時刻。時間は UTC で、形式は yyyy-mm-ddThh:mm:ssZ です。

    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` パラメータに Uv（ユニーク視聴者数）、AvgPerVv（ユーザーあたりの平均視聴回数）、AvgPerPlayDuration（ユーザーあたりの平均再生時間）、または AvgPerCompletionVv（ユーザーあたりの平均完全視聴回数）の 4 つのメトリックのいずれかが含まれている場合、`Filters` パラメータは有効になりません。

    • 都道府県と国については、リージョンコードを渡します。

    • 複数の値を渡すには、`#_#` で区切ります。

    ディメンションタイプ（Field）の有効な値：

    • SdkVersion： SDK バージョン。

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

    • Codec：エンコード形式。

    • VideoType：ビデオフォーマット。

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

    • Country：国。

    • 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： 1 秒以内の再生開始率。

    • 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

    任意

    視聴回数に基づいて返す上位結果の数。このパラメータを指定しない場合は、すべてのディメンションのデータが返されます。

    5
    PageNumber

    integer

    任意

    ページ番号。デフォルト値は 1 です。

    1
    PageSize

    integer

    任意

    各ページに返すエントリの数。デフォルト値： 5000。最大値： 5000。

    5000
    Language

    string

    任意

    レスポンスの言語。有効な値：

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

    • en：英語。

    zh
    Os

    string

    任意

    プレーヤーのオペレーティングシステム。このパラメータを指定して、特定のオペレーティングシステムの再生データをクエリできます。有効な値には、Android、 iOS、 Harmony、 Windows、 macOS、 Linux などがあります。 有効な値は、端末タイプによって異なります。

    • native： 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

    1 ページあたりのエントリ数。

    5000
    TotalCnt

    integer

    データポイントの総数。

    500
    DataList

    array<object>

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

    object

    TimeStamp

    string

    返されたデータのタイムスタンプ。時間は UTC で、形式は yyyy-mm-ddThh:mm:ssZ です。

    2025-06-24T00:55:06Z

    Dimension

    string

    ディメンション。

    H265_MP4_WIFI
    Uv

    number

    ユニーク視聴者数。

    500
    Vv

    number

    視聴回数。

    800
    RealVv

    number

    実際の視聴回数。

    1000
    FirstFrame

    number

    最初のフレームまでの時間（ミリ秒）。

    100
    SecondPlayRate

    number

    1 秒以内の再生開始率。

    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

    指定された時間範囲内でデータポイントが生成された最も早い時刻。時間は UTC で、形式は yyyy-mm-ddThh:mm:ssZ です。

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

    string

    指定された時間範囲内でデータポイントが生成された最も遅い時刻。時間は UTC で、形式は yyyy-mm-ddThh:mm:ssZ です。

    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.

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

    変更履歴

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