すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:DescribeVodPlayerCollectData

    ドキュメントセンター

    ApsaraVideo VOD:DescribeVodPlayerCollectData

    最終更新日: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:DescribeVodPlayerCollectData

    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。
    Os

    string

    任意

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

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

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

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

    Android、iOS、Windows。
    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。
    Period

    string

    任意

    前年同期比較分析の時間範囲 (日単位 (d))。

    たとえば、このパラメーターを 1d (1 日) に設定すると、前年同期比較データは StartTime-1d から EndTime-1d の時間範囲から取得されます。

    1d

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答スキーマ。

    RequestId

    string

    リクエスト ID。

    25818875-5F78-4AF6-D7393642CA58****
    DataList

    array<object>

    返されるデータリスト。

    object

    Metric

    string

    返されるデータメトリクス。

    Vv
    Value

    number

    返されるデータメトリクスの値。

    100.0
    ValueRefer

    number

    返されるデータメトリクスの前年同期比較の値。

    200.0
    ValueRatio

    number

    前年同期比較のパーセンテージ。

    0.5

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "DataList": [
    {
      "Metric": "Vv",
      "Value": 100,
      "ValueRefer": 200,
      "ValueRatio": 0.5
    }
  ]
}

    エラーコード

    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.

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

    変更履歴

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